options

Documentation

Overview

Package options contains flags and options for initializing an nightwatch.

Index

• Constants
• type Options
  • func NewOptions() *Options
  • func (o *Options) ApplyTo(c *nightwatch.Config) error
  • func (o *Options) Complete() error
  • func (o *Options) Config() (*nightwatch.Config, error)
  • func (o *Options) Flags() (fss cliflag.NamedFlagSets)
  • func (o *Options) Validate() error

Constants

const (
	// UserAgent is the userAgent name when starting onex-nightwatch server.
	UserAgent = "onex-nightwatch"
)

Types

type Options

type Options struct {
	HealthOptions         *genericoptions.HealthOptions  `json:"health" mapstructure:"health"`
	MySQLOptions          *genericoptions.MySQLOptions   `json:"mysql" mapstructure:"mysql"`
	RedisOptions          *genericoptions.RedisOptions   `json:"redis" mapstructure:"redis"`
	UserWatcherMaxWorkers int64                          `json:"user-watcher-max-workers" mapstructure:"user-watcher-max-workers"`
	DisableWatchers       []string                       `json:"disable-watchers" mapstructure:"disable-watchers"`
	Metrics               *genericoptions.MetricsOptions `json:"metrics" mapstructure:"metrics"`
	// Path to kubeconfig file with authorization and master location information.
	Kubeconfig   string          `json:"kubeconfig" mapstructure:"kubeconfig"`
	FeatureGates map[string]bool `json:"feature-gates"`
	Log          *log.Options    `json:"log" mapstructure:"log"`
}

Options contains everything necessary to create and run a nightwatch server.

func NewOptions

func NewOptions() *Options

NewOptions returns initialized Options.

func (*Options) ApplyTo

func (o *Options) ApplyTo(c *nightwatch.Config) error

ApplyTo fills up onex-nightwatch config with options.

func (*Options) Complete

func (o *Options) Complete() error

Complete completes all the required options.

func (*Options) Config

func (o *Options) Config() (*nightwatch.Config, error)

Config return an onex-nightwatch config object.

func (*Options) Flags

func (o *Options) Flags() (fss cliflag.NamedFlagSets)

Flags returns flags for a specific server by section name.

func (*Options) Validate

func (o *Options) Validate() error

Validate validates all the required options.