clusteroverview

Documentation

Index

• type ClusterOverview
  • func New(ctx context.Context, options Options) (*ClusterOverview, error)
  • func (co *ClusterOverview) ClientRequestHandlers() []octant.ClientRequestHandler
  • func (co *ClusterOverview) Content(ctx context.Context, contentPath string, opts module.ContentOptions) (component.ContentResponse, error)
  • func (co *ClusterOverview) ContentPath() string
  • func (co *ClusterOverview) Generators() []octant.Generator
  • func (co *ClusterOverview) Name() string
  • func (co *ClusterOverview) Navigation(ctx context.Context, namespace string, root string) ([]navigation.Navigation, error)
  • func (co *ClusterOverview) SetContext(ctx context.Context, contextName string) error
  • func (co *ClusterOverview) SetNamespace(namespace string) error
  • func (co *ClusterOverview) Start() error
  • func (co *ClusterOverview) Stop()
• type Options
• type PortForwardListDescriber
  • func NewPortForwardListDescriber() *PortForwardListDescriber
  • func (d *PortForwardListDescriber) Describe(ctx context.Context, namespace string, options describer.Options) (component.ContentResponse, error)
  • func (d *PortForwardListDescriber) PathFilters() []describer.PathFilter
  • func (d *PortForwardListDescriber) Reset(ctx context.Context) error

Types

type ClusterOverview

type ClusterOverview struct {
	*octant.ObjectPath
	Options
	// contains filtered or unexported fields
}

ClusterOverview is a module for the cluster overview.

func New

func New(ctx context.Context, options Options) (*ClusterOverview, error)

func (*ClusterOverview) ClientRequestHandlers

func (co *ClusterOverview) ClientRequestHandlers() []octant.ClientRequestHandler

func (*ClusterOverview) Content

func (co *ClusterOverview) Content(ctx context.Context, contentPath string, opts module.ContentOptions) (component.ContentResponse, error)

func (*ClusterOverview) ContentPath

func (co *ClusterOverview) ContentPath() string

func (*ClusterOverview) Generators

func (co *ClusterOverview) Generators() []octant.Generator

Generators allow modules to send events to the frontend.

func (*ClusterOverview) Name

func (co *ClusterOverview) Name() string

func (*ClusterOverview) Navigation

func (co *ClusterOverview) Navigation(ctx context.Context, namespace string, root string) ([]navigation.Navigation, error)

func (*ClusterOverview) SetContext

func (co *ClusterOverview) SetContext(ctx context.Context, contextName string) error

func (*ClusterOverview) SetNamespace

func (co *ClusterOverview) SetNamespace(namespace string) error

func (*ClusterOverview) Start

func (co *ClusterOverview) Start() error

func (*ClusterOverview) Stop

func (co *ClusterOverview) Stop()

type Options

type Options struct {
	DashConfig config.Dash
}

Options are options for ClusterOverview.

type PortForwardListDescriber

type PortForwardListDescriber struct {
}

PortForwardListDescriber describes a list of port-forwards

func NewPortForwardListDescriber

func NewPortForwardListDescriber() *PortForwardListDescriber

func (*PortForwardListDescriber) Describe

func (d *PortForwardListDescriber) Describe(ctx context.Context, namespace string, options describer.Options) (component.ContentResponse, error)

Describe describes a list of port forwards as content

func (*PortForwardListDescriber) PathFilters

func (d *PortForwardListDescriber) PathFilters() []describer.PathFilter

func (*PortForwardListDescriber) Reset

func (d *PortForwardListDescriber) Reset(ctx context.Context) error