overview

Documentation

Index

• type Options
• type Overview
  • func New(ctx context.Context, options Options) (*Overview, error)
  • func (co *Overview) ActionPaths() map[string]action.DispatcherFunc
  • func (co *Overview) ClientRequestHandlers() []octant.ClientRequestHandler
  • func (co *Overview) Content(ctx context.Context, contentPath string, opts module.ContentOptions) (component.ContentResponse, error)
  • func (co *Overview) ContentPath() string
  • func (co *Overview) Generators() []octant.Generator
  • func (co *Overview) Name() string
  • func (co *Overview) Navigation(ctx context.Context, namespace, root string) ([]navigation.Navigation, error)
  • func (co *Overview) SetContext(ctx context.Context, contextName string) error
  • func (co *Overview) SetNamespace(namespace string) error
  • func (co *Overview) Start() error
  • func (co *Overview) Stop()

Types

type Options

type Options struct {
	Namespace  string
	DashConfig config.Dash
}

type Overview

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

Overview is an API for generating a cluster overview.

func New

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

New creates an instance of Overview.

func (*Overview) ActionPaths

func (co *Overview) ActionPaths() map[string]action.DispatcherFunc

ActionPaths contain the actions this module is responsible for.

func (*Overview) ClientRequestHandlers

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

func (*Overview) Content

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

Content serves content for overview.

func (*Overview) ContentPath

func (co *Overview) ContentPath() string

ContentPath returns the content path for overview.

func (*Overview) Generators

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

Generators allow modules to send events to the frontend.

func (*Overview) Name

func (co *Overview) Name() string

Name returns the name for this module.

func (*Overview) Navigation

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

Navigation returns navigation entries for overview.

func (*Overview) SetContext

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

func (*Overview) SetNamespace

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

SetNamespace sets the current namespace.

func (*Overview) Start

func (co *Overview) Start() error

Start starts overview.

func (*Overview) Stop

func (co *Overview) Stop()

Stop stops overview.