dash

Documentation

Index

• func Run(ctx context.Context, logger log.Logger, shutdownCh chan bool, options Options) error
• type ConfigWatcher
  • func NewConfigWatcher(wc WatcherConfig, options ...ConfigWatcherOption) (*ConfigWatcher, error)
  • func (cw *ConfigWatcher) Add(ctx context.Context, names ...string) error
  • func (cw *ConfigWatcher) Watch(ctx context.Context)
• type ConfigWatcherOption
  • func ConfigWatcherFileWatcher(fw FileWatcher) ConfigWatcherOption
• type DefaultFileWatcher
  • func NewDefaultFileWatcher() (*DefaultFileWatcher, error)
  • func (d *DefaultFileWatcher) Add(name string) error
  • func (d DefaultFileWatcher) Errors() chan error
  • func (d *DefaultFileWatcher) Events() chan fsnotify.Event
• type FileWatcher
• type Options
• type WatcherConfig

Functions

func Run

func Run(ctx context.Context, logger log.Logger, shutdownCh chan bool, options Options) error

Run runs the dashboard.

Types

type ConfigWatcher

type ConfigWatcher struct {
	FileWatcher FileWatcher
	// contains filtered or unexported fields
}

ConfigWatcher watches kubernetes configurations.

func NewConfigWatcher

func NewConfigWatcher(wc WatcherConfig, options ...ConfigWatcherOption) (*ConfigWatcher, error)

NewConfigWatcher creates an instance of ConfigWatcher.

func (*ConfigWatcher) Add

func (cw *ConfigWatcher) Add(ctx context.Context, names ...string) error

Add adds file names to be watched.

func (*ConfigWatcher) Watch

func (cw *ConfigWatcher) Watch(ctx context.Context)

Watch runs the config watcher loop

type ConfigWatcherOption

type ConfigWatcherOption func(cw *ConfigWatcher)

ConfigWatcherOption is an option for configuration ConfigWatcher.

func ConfigWatcherFileWatcher

func ConfigWatcherFileWatcher(fw FileWatcher) ConfigWatcherOption

ConfigWatcherFileWatcher sets the file watcher for ConfigWatcher.

type DefaultFileWatcher

type DefaultFileWatcher struct {
	// contains filtered or unexported fields
}

DefaultFileWatcher wraps fsnotify.Watcher so it can adhere to the FileWatcher API.

func NewDefaultFileWatcher

func NewDefaultFileWatcher() (*DefaultFileWatcher, error)

NewDefaultFileWatcher creates an instance of DefaultFileWatcher.

func (*DefaultFileWatcher) Add

func (d *DefaultFileWatcher) Add(name string) error

Add adds a file name to be watched.

func (DefaultFileWatcher) Errors

func (d DefaultFileWatcher) Errors() chan error

Errors returns a channel of errors.

func (*DefaultFileWatcher) Events

func (d *DefaultFileWatcher) Events() chan fsnotify.Event

Events returns a channel of fsnotify events.

type FileWatcher

type FileWatcher interface {
	// Add adds a file to watch.
	Add(name string) error
	// Events returns a channel with fsnotify events.
	Events() chan fsnotify.Event
	// Errors returns errors.
	Errors() chan error
}

FileWatcher watches files.

type Options

type Options struct {
	EnableOpenCensus       bool
	DisableClusterOverview bool
	KubeConfig             string
	Namespace              string
	FrontendURL            string
	Context                string
	ClientQPS              float32
	ClientBurst            int
	UserAgent              string
}

type WatcherConfig

type WatcherConfig interface {
	ContextName() string
	UseContext(ctx context.Context, name string) error
}

WatcherConfig is an interface with configuration for ConfigWatcher.