package
0.25.1
Repository: https://github.com/vmware-tanzu/octant.git
Documentation: pkg.go.dev

# Packages

Package fake is a generated GoMock package.

# Functions

No description provided by the author
CreateContentEvent creates a content event.
CreateNamespacesEvent creates a namespaces event.
Create first part of breadcrumb from module navigation entries.
CreateNavigationEvent creates a navigation event.
FilterFromPayload creates a filter from a payload.
FiltersFromQueryParams converts query params to filters.
FiltersToLabelSet converts a slice of filters to a label set.
Generate breadcrumb for specified path.
No description provided by the author
Listener returns the default listener if OCTANT_LISTENER_ADDR is not set.
NamespacesGenerator generates a list of namespaces.
Returns all navigation elements for specified path.
NavigationGenerator generates a navigation tree given a set of modules and a namespace.
New creates an instance of API.
NewActionRequestManager creates an instance of ActionRequestManager.
NewContentManager creates an instance of ContentManager.
NewContextManager creates an instances of ContextManager.
NewFilterManager creates an instance of FilterManager.
NewHelperStateManager creates an instance of HelperStateManager.
NewInterruptiblePoller creates an instance of InterruptiblePoller.
NewLoadingAPI creates an instance of LoadingAPI.
No description provided by the author
NewNamespacesManager creates an instance of NamespacesManager.
NewNavigationManager creates an instance of NavigationManager.
NewNotFoundError creates an instance of NotFoundError.
NewPodLogsStateManager returns a terminal state manager.
NewSingleRunPoller creates an instance of SingleRunPoller.
NewTerminalStateManager returns a terminal state manager.
ParseFilterQueryParam parsers a single filter from a query param in the format `key:value`.
RespondWithError responds with an error message.
shouldAllowHost returns true if the incoming request.Host should be allowed to access the API otherwise false.
WithContentGenerator configures the content generate function.
WithContentGeneratorPoller configures the poller.
WithContextGenerator sets the context generator.
WithContextGeneratorPoll generates the poller.
WithHelperGenerator sets the helper generator.
WithHelperGeneratorPoll generates the poller.
WithNamespacesGenerator configures the namespaces generator function.
WithNamespacesGeneratorPoller configures the poller.
WithNavigationGenerator configures the navigation generator function.
WithNavigationGeneratorPoller configures the poller.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
ListenerAddrKey is the environment variable for the Octant listener address.
PathPrefix is a string for the api path prefix.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

ActionRequestManager manages action requests.
API is the API for the dashboard client.
Content is a content to be sent to clients.
ContentManager manages content for websockets.
ContextManager manages context.
FilterManager manages filters.
HelperStateManager manages buildInfo.
InterruptiblePoller is a poller than runs an action and allows for interrupts.
No description provided by the author
LoadingAPI is an API for startup modules to run.
No description provided by the author
NamespacesManager manages namespaces.
NavigationManager manages the navigation tree.
NotFoundError is a not found error.
SingleRunPoller is a a poller runs the supplied action once.

# Interfaces

NamespaceManagerConfig is configuration for NamespacesManager.
NavigationManagerConfig is configuration of NavigationManager.
Poller is a poller.
Service is an API service.

# Type aliases

ContentGenerateFunc is a function that generates content.
ContentManagerOption is an option for configuring ContentManager.
ContextGenerateFunc is a function which generates a context event.
ContextManagerOption is an option for configuring ContextManager.
HelperGenerateFunc is a function which generates a helper event.
HelperStateManagerOption is an option for configuration HelperManager.
NamespacesGenerateFunc is a function that generates a list of namespaces.
NamespacesManagerOption is an option for configuring NamespacesManager.
NavigationGeneratorFunc is a function that generates a navigation tree.
NavigationManagerConfig is an option for configuration NavigationManager.
PollerFunc is a function run by the poller.
No description provided by the author