config

Documentation

Index

• type BuildInfo
• type CRDWatchConfig
  • func (c *CRDWatchConfig) CanPerform(u *unstructured.Unstructured) bool
• type CRDWatcher
• type Context
• type Dash
• type ObjectHandler

Types

type BuildInfo

type BuildInfo struct {
	Version string
	Commit  string
	Time    string
}

type CRDWatchConfig

type CRDWatchConfig struct {
	Add          ObjectHandler
	Delete       ObjectHandler
	IsNamespaced bool
}

CRDWatchConfig is configuration for CRDWatcher.

func (*CRDWatchConfig) CanPerform

func (c *CRDWatchConfig) CanPerform(u *unstructured.Unstructured) bool

CanPerform returns true if config can perform actions on an object.

type CRDWatcher

type CRDWatcher interface {
	Watch(ctx context.Context) error
	AddConfig(config *CRDWatchConfig) error
}

CRDWatcher watches for CRDs.

type Context

type Context struct {
	Name             string
	DefaultNamespace string
}

type Dash

type Dash interface {
	octant.LinkGenerator
	octant.Storage

	ClusterClient() cluster.ClientInterface

	CRDWatcher() CRDWatcher

	ErrorStore() errors.ErrorStore

	Logger() log.Logger

	PluginManager() plugin.ManagerInterface

	PortForwarder() portforward.PortForwarder

	SetContextChosenInUI(contextChosen bool)

	UseFSContext(ctx context.Context) error

	UseContext(ctx context.Context, contextName string) error

	CurrentContext() string

	Contexts() []kubeconfig.Context

	DefaultNamespace() string

	Validate() error

	ModuleManager() module.ManagerInterface

	BuildInfo() (string, string, string)

	KubeConfigPath() string
}

Config is configuration for dash. It has knowledge of the all the major sections of dash.

type ObjectHandler

type ObjectHandler func(ctx context.Context, object *unstructured.Unstructured)

ObjectHandler is a function that is run when a new object is available.