octant

Sep 9, 2021

Changes in this version

+ const ActionGetManifest

+ type Manifest struct

+ func NewManifest(logger log.Logger) *Manifest

+ func (m *Manifest) ActionName() string

+ func (m *Manifest) Handle(ctx context.Context, _ action.Alerter, payload action.Payload) error

Jun 16, 2021

Changes in this version

type Generator

+ Events func(ctx context.Context) ([]event.Event, error)

Jan 12, 2021

Changes in this version

+ type CustomResourceDefinitionTool struct

+ func NewCustomResourceDefinitionTool(object *unstructured.Unstructured) (*CustomResourceDefinitionTool, error)

+ func (crd *CustomResourceDefinitionTool) GroupKind() (schema.GroupKind, error)

+ func (crd *CustomResourceDefinitionTool) Version(version string) (CustomResourceDefinitionVersion, error)

+ func (crd *CustomResourceDefinitionTool) Versions() ([]string, error)

type ObjectPath

+ func (op *ObjectPath) GvkFromPath(contentPath, namespace string) (schema.GroupVersionKind, error)

type ObjectPathConfig

+ ReversePathLookupFunc ReversePathLookupFunc

+ type ReversePathLookupFunc func(path, namespace string) (schema.GroupVersionKind, error)

Sep 24, 2020

Changes in this version

type State

+ GetClientID func() string

Aug 12, 2020

Changes in this version

+ type DashboardClientFactory interface

+ Create func(ctx context.Context, vm *goja.Runtime) goja.Value

+ type DashboardClientFunction interface

+ Call func(ctx context.Context, vm *goja.Runtime) func(c goja.FunctionCall) goja.Value

+ Name func() string

+ type LinkGenerator interface

+ ObjectPath func(namespace, apiVersion, kind, name string) (string, error)

+ type Storage interface

+ ObjectStore func() store.Store

Jul 16, 2020

Changes in this version

+ const ActionApplyYaml

+ const ActionOverviewResumeCronjob

+ const ActionOverviewSuspendCronjob

+ const EventTypeLoading

+ const EventTypeRefresh

+ type ApplyYaml struct

+ func NewApplyYaml(logger log.Logger, objectStore store.Store, ...) *ApplyYaml

+ func (p *ApplyYaml) ActionName() string

+ func (p *ApplyYaml) Handle(ctx context.Context, alerter action.Alerter, payload action.Payload) error

+ type CronJobResume struct

+ func NewCronJobResume(objectStore store.Store, clusterClient cluster.ClientInterface) *CronJobResume

+ func (c *CronJobResume) ActionName() string

+ func (c *CronJobResume) Handle(ctx context.Context, alerter action.Alerter, payload action.Payload) error

+ type CronJobSuspend struct

+ func NewCronJobSuspend(objectStore store.Store, clusterClient cluster.ClientInterface) *CronJobSuspend

+ func (c *CronJobSuspend) ActionName() string

+ func (c *CronJobSuspend) Handle(ctx context.Context, alerter action.Alerter, payload action.Payload) error

Jun 1, 2020

Changes in this version

+ const ActionUpdateObject

+ const EventTypeBuildInfo

+ func DeleteObjectConfirmation(object runtime.Object) (*component.Confirmation, error)

+ func DeleteObjectConfirmationButton(object runtime.Object) (component.ButtonOption, error)

+ func ObjectUpdateFromPayload(payload action.Payload) (*unstructured.Unstructured, error)

+ type ObjectUpdaterDispatcher struct

+ func NewObjectUpdaterDispatcher(objectStore store.Store, options ...ObjectUpdaterDispatcherOption) *ObjectUpdaterDispatcher

+ func (o ObjectUpdaterDispatcher) ActionName() string

+ func (o ObjectUpdaterDispatcher) Handle(ctx context.Context, alerter action.Alerter, payload action.Payload) error

+ type ObjectUpdaterDispatcherOption func(dispatcher *ObjectUpdaterDispatcher)

Apr 22, 2020

Changes in this version

+ const ActionDeploymentConfiguration

+ const ActionOverviewContainerEditor

+ const ActionOverviewCordon

+ const ActionOverviewCronjob

+ const ActionOverviewServiceEditor

+ const ActionOverviewUncordon

+ const EventTypeLoggingFormat

+ const EventTypeTerminalFormat

type EventType

+ func NewLoggingEventType(namespace, pod string) EventType

+ func NewTerminalEventType(namespace, pod, container, terminalID string) EventType

type NavigationEntries

+ IconMap map[string]string

Mar 20, 2020

Changes in this version

+ type Cordon struct

+ func NewCordon(objectStore store.Store, clusterClient cluster.ClientInterface) *Cordon

+ func (c *Cordon) ActionName() string

+ func (c *Cordon) Cordon(node *corev1.Node) error

+ func (c *Cordon) Handle(ctx context.Context, alerter action.Alerter, payload action.Payload) error

+ type CronJobTrigger struct

+ func NewCronJobTrigger(objectStore store.Store, clusterClient cluster.ClientInterface) *CronJobTrigger

+ func (c *CronJobTrigger) ActionName() string

+ func (c *CronJobTrigger) Handle(ctx context.Context, alerter action.Alerter, payload action.Payload) error

+ func (c *CronJobTrigger) Trigger(name string, cronJob *batchv1beta1.CronJob) error

+ type Uncordon struct

+ func NewUncordon(objectStore store.Store, clusterClient cluster.ClientInterface) *Uncordon

+ func (u *Uncordon) ActionName() string

+ func (u *Uncordon) Handle(ctx context.Context, alerter action.Alerter, payload action.Payload) error

+ func (u *Uncordon) Uncordon(node *corev1.Node) error

Jan 24, 2020

Changes in this version

+ const WorkloadStatusColorError

+ const WorkloadStatusColorOK

+ const WorkloadStatusColorWarning

+ var PodMetricsResource = schema.GroupVersionResource

+ func CombineResourceRequirements(a, b corev1.ResourceRequirements) corev1.ResourceRequirements

+ func CreateCard(workload *Workload, namespace string) (*component.Card, bool, error)

+ func IsPodMetricsNotSupported(err error) bool

+ func NewTerminalDelete(logger log.Logger, objectStore store.Store, terminalManager terminal.Manager) action.Dispatcher

+ func PodCPUStat(workload *Workload) (*component.SingleStat, error)

+ func PodMemoryStat(workload *Workload) (*component.SingleStat, error)

+ type ClusterPodMetricsLoader struct

+ PodMetricsCRUD PodMetricsCRUD

+ func NewClusterPodMetricsLoader(clusterClient cluster.ClientInterface, ...) (*ClusterPodMetricsLoader, error)

+ func (ml *ClusterPodMetricsLoader) Load(namespace, name string) (*unstructured.Unstructured, error)

+ func (ml *ClusterPodMetricsLoader) SupportsMetrics() (bool, error)

+ type ClusterPodMetricsLoaderOption func(loader *ClusterPodMetricsLoader)

+ type ClusterWorkloadLoader struct

+ ObjectStatuser func(context.Context, runtime.Object, store.Store) (objectstatus.ObjectStatus, error)

+ ObjectStore store.Store

+ PodMetricsLoader PodMetricsLoader

+ func NewClusterWorkloadLoader(objectStore store.Store, pml PodMetricsLoader, ...) (*ClusterWorkloadLoader, error)

+ func (wl *ClusterWorkloadLoader) Load(ctx context.Context, namespace string) ([]Workload, error)

+ type ClusterWorkloadLoaderOption func(wl *ClusterWorkloadLoader)

+ type CustomResourceDefinition struct

+ func NewCustomResourceDefinition(object *unstructured.Unstructured) (*CustomResourceDefinition, error)

+ func (crd *CustomResourceDefinition) Version(version string) (CustomResourceDefinitionVersion, error)

+ func (crd *CustomResourceDefinition) Versions() ([]string, error)

+ type CustomResourceDefinitionPrinterColumn struct

+ Description string

+ JSONPath string

+ Name string

+ Type string

+ type CustomResourceDefinitionVersion struct

+ PrinterColumns []CustomResourceDefinitionPrinterColumn

+ Version string

+ type NoPodMetricsErr struct

+ func (e *NoPodMetricsErr) Error() string

+ func (e *NoPodMetricsErr) NoPodMetricsSupport() bool

+ type PodMetricsCRUD interface

+ Get func(namespace, name string) (*unstructured.Unstructured, error)

+ type PodMetricsLoader interface

+ Load func(namespace, name string) (*unstructured.Unstructured, error)

+ SupportsMetrics func() (bool, error)

+ type PodWithMetric struct

+ Pod *unstructured.Unstructured

+ ResourceList corev1.ResourceList

+ type PortForward struct

+ func NewPortForward(logger log.Logger, objectStore store.Store, ...) *PortForward

+ func (p *PortForward) ActionName() string

+ func (p *PortForward) Handle(ctx context.Context, alerter action.Alerter, payload action.Payload) error

+ type PortForwardDelete struct

+ func NewPortForwardDelete(logger log.Logger, objectStore store.Store, ...) *PortForwardDelete

+ func (p *PortForwardDelete) ActionName() string

+ func (p *PortForwardDelete) Handle(ctx context.Context, alerter action.Alerter, payload action.Payload) error

+ type TerminalCommandExec struct

+ func NewTerminalCommandExec(logger log.Logger, objectStore store.Store, terminalManager terminal.Manager) *TerminalCommandExec

+ func (t *TerminalCommandExec) ActionName() string

+ func (t *TerminalCommandExec) Handle(ctx context.Context, alerter action.Alerter, payload action.Payload) error

+ type Workload struct

+ IconName string

+ Name string

+ Owner *unstructured.Unstructured

+ SegmentCounter map[component.NodeStatus][]PodWithMetric

+ func NewWorkload(name, iconName string) *Workload

+ func (w *Workload) AddPodStatus(status component.NodeStatus, object *unstructured.Unstructured, ...)

+ func (w *Workload) DonutChart(size component.DonutChartSize) (*component.DonutChart, error)

+ func (w *Workload) PodMetricsEnabled() bool

+ func (w *Workload) Pods() *unstructured.UnstructuredList

+ func (w *Workload) PodsWithMetrics() []PodWithMetric

+ func (w *Workload) SetPodMetricsDisabled()

+ type WorkloadCardCollector struct

+ WorkloadLoader WorkloadLoaderInterface

+ func NewWorkloadCardCollector(loader WorkloadLoaderInterface) (*WorkloadCardCollector, error)

+ func (wc *WorkloadCardCollector) Collect(ctx context.Context, namespace string) ([]*component.Card, bool, error)

+ type WorkloadLoaderInterface interface

+ Load func(ctx context.Context, namespace string) ([]Workload, error)

+ type WorkloadSummary struct

+ CPU component.Component

+ Memory component.Component

+ MetricsEnabled bool

+ Summary component.Component

+ func CreateWorkloadSummary(workload *Workload, summarySize component.DonutChartSize) (WorkloadSummary, error)

Oct 30, 2019

Changes in this version

+ const ActionDeleteObject

+ func CRDAPIVersions(crd *unstructured.Unstructured) ([]schema.GroupVersion, error)

+ type CRDPathGenFunc func(namespace, crdName, name string) (string, error)

+ type ClientRequestHandler struct

+ Handler func(state State, payload action.Payload) error

+ RequestType string

+ type ContainerEditor struct

+ func NewContainerEditor(objectStore store.Store) *ContainerEditor

+ func (e *ContainerEditor) ActionName() string

+ func (e *ContainerEditor) Handle(ctx context.Context, alerter action.Alerter, payload action.Payload) error

+ type ContentPathUpdateFunc func(contentPath string)

+ type DeploymentConfigurationEditor struct

+ func NewDeploymentConfigurationEditor(logger log.Logger, objectStore store.Store) *DeploymentConfigurationEditor

+ func (e *DeploymentConfigurationEditor) ActionName() string

+ func (e *DeploymentConfigurationEditor) Handle(ctx context.Context, alerter action.Alerter, payload action.Payload) error

+ type EntriesFunc func(ctx context.Context, prefix, namespace string, objectStore store.Store, ...) ([]navigation.Navigation, bool, error)

+ type Event struct

+ Data interface{}

+ Err error

+ Type EventType

+ type EventType string

+ const EventTypeAlert

+ const EventTypeContent

+ const EventTypeContentPath

+ const EventTypeContext

+ const EventTypeCurrentNamespace

+ const EventTypeFilters

+ const EventTypeKubeConfig

+ const EventTypeNamespace

+ const EventTypeNamespaces

+ const EventTypeNavigation

+ const EventTypeObjectNotFound

+ const EventTypeUnknown

+ type Filter struct

+ Key string

+ Value string

+ func (f *Filter) IsEqual(other Filter) bool

+ func (f *Filter) String() string

+ func (f *Filter) ToQueryParam() string

+ type Generator interface

+ Event func(ctx context.Context) (Event, error)

+ Name func() string

+ ScheduleDelay func() time.Duration

+ type NamespaceUpdateFunc func(namespace string)

+ type NavigationEntries struct

+ EntriesFuncs map[string]EntriesFunc

+ Lookup map[string]string

+ Order []string

+ type NavigationFactory struct

+ func NewNavigationFactory(namespace string, root string, objectStore store.Store, ...) *NavigationFactory

+ func (nf *NavigationFactory) Generate(ctx context.Context, title string, iconName, iconSource string, ...) (*navigation.Navigation, error)

+ func (nf *NavigationFactory) Root() string

+ type ObjectPath struct

+ func NewObjectPath(config ObjectPathConfig) (*ObjectPath, error)

+ func (op *ObjectPath) AddCRD(ctx context.Context, crd *unstructured.Unstructured) error

+ func (op *ObjectPath) GroupVersionKindPath(namespace, apiVersion, kind, name string) (string, error)

+ func (op *ObjectPath) RemoveCRD(ctx context.Context, crd *unstructured.Unstructured) error

+ func (op *ObjectPath) ResetCRDs(ctx context.Context) error

+ func (op *ObjectPath) SupportedGroupVersionKind() []schema.GroupVersionKind

+ type ObjectPathConfig struct

+ CRDPathGenFunc CRDPathGenFunc

+ ModuleName string

+ PathLookupFunc PathLookupFunc

+ SupportedGVKs []schema.GroupVersionKind

+ func (opc *ObjectPathConfig) Validate() error

+ type PathLookupFunc func(namespace, apiVersion, kind, name string) (string, error)

+ type ServiceConfigurationEditor struct

+ func NewServiceConfigurationEditor(objectStore store.Store) *ServiceConfigurationEditor

+ func (s *ServiceConfigurationEditor) ActionName() string

+ func (s *ServiceConfigurationEditor) Handle(ctx context.Context, alerter action.Alerter, payload action.Payload) error

+ type State interface

+ AddFilter func(filter Filter)

+ Dispatch func(ctx context.Context, actionName string, payload action.Payload) error

+ GetContentPath func() string

+ GetFilters func() []Filter

+ GetNamespace func() string

+ GetQueryParams func() map[string][]string

+ OnContentPathUpdate func(fn ContentPathUpdateFunc) UpdateCancelFunc

+ OnNamespaceUpdate func(fun NamespaceUpdateFunc) UpdateCancelFunc

+ RemoveFilter func(filter Filter)

+ SendAlert func(alert action.Alert)

+ SetContentPath func(string)

+ SetContext func(requestedContext string)

+ SetFilters func(filters []Filter)

+ SetNamespace func(namespace string)

+ type UpdateCancelFunc func()