options

Documentation

Overview

Package options provides the flags used for the controller manager.

Index

• Constants
• func LoadConfigFromFile(file string) (*config.OneXControllerManagerConfiguration, error)
• func LogOrWriteConfig(fileName string, cfg *config.OneXControllerManagerConfiguration) error
• type ChainControllerOptions
  • func NewChainControllerOptions(cfg *chainconfig.ChainControllerConfiguration) *ChainControllerOptions
  • func (o *ChainControllerOptions) AddFlags(fs *pflag.FlagSet)
  • func (o *ChainControllerOptions) ApplyTo(cfg *chainconfig.ChainControllerConfiguration) error
  • func (o *ChainControllerOptions) Validate() []error
• type GarbageCollectorControllerOptions
  • func NewGarbageCollectorControllerOptions(cfg *garbagecollectorconfig.GarbageCollectorControllerConfiguration) *GarbageCollectorControllerOptions
  • func (o *GarbageCollectorControllerOptions) AddFlags(fs *pflag.FlagSet)
  • func (o *GarbageCollectorControllerOptions) ApplyTo(cfg *garbagecollectorconfig.GarbageCollectorControllerConfiguration) error
  • func (o *GarbageCollectorControllerOptions) Validate() []error
• type GenericControllerManagerConfigurationOptions
  • func NewGenericControllerManagerConfigurationOptions(cfg *cmconfig.GenericControllerManagerConfiguration) *GenericControllerManagerConfigurationOptions
  • func (o *GenericControllerManagerConfigurationOptions) AddFlags(fss *cliflag.NamedFlagSets, allControllers []string, ...)
  • func (o *GenericControllerManagerConfigurationOptions) ApplyTo(cfg *cmconfig.GenericControllerManagerConfiguration, allControllers []string, ...) error
  • func (o *GenericControllerManagerConfigurationOptions) Validate(allControllers []string, disabledControllers []string, ...) []error
• type Options
  • func NewOptions() (*Options, error)
  • func (o *Options) ApplyTo(c *controllermanagerconfig.Config, allControllers []string, ...) error
  • func (o *Options) Complete() error
  • func (o Options) Config(allControllers []string, disabledControllers []string, ...) (*controllermanagerconfig.Config, error)
  • func (o *Options) Flags(allControllers []string, disabledControllers []string, ...) cliflag.NamedFlagSets
  • func (o *Options) Validate(allControllers []string, disabledControllers []string, ...) error

Constants

const (
	// ControllerManagerUserAgent is the userAgent name when starting onex-controller managers.
	ControllerManagerUserAgent = "onex-controller-manager"
)

Functions

func LoadConfigFromFile

func LoadConfigFromFile(file string) (*config.OneXControllerManagerConfiguration, error)

func LogOrWriteConfig

func LogOrWriteConfig(fileName string, cfg *config.OneXControllerManagerConfiguration) error

LogOrWriteConfig logs the completed component config and writes it into the given file name as YAML, if either is enabled.

Types

type ChainControllerOptions

type ChainControllerOptions struct {
	*chainconfig.ChainControllerConfiguration
}

ChainControllerOptions holds the ChainController options.

func NewChainControllerOptions

func NewChainControllerOptions(cfg *chainconfig.ChainControllerConfiguration) *ChainControllerOptions

func (*ChainControllerOptions) AddFlags

func (o *ChainControllerOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to ChainController for controller manager to the specified FlagSet.

func (*ChainControllerOptions) ApplyTo

func (o *ChainControllerOptions) ApplyTo(cfg *chainconfig.ChainControllerConfiguration) error

ApplyTo fills up ChainControllerOptions config with options.

func (*ChainControllerOptions) Validate

func (o *ChainControllerOptions) Validate() []error

Validate checks validation of GarbageCollectorController.

type GarbageCollectorControllerOptions

type GarbageCollectorControllerOptions struct {
	*garbagecollectorconfig.GarbageCollectorControllerConfiguration
}

GarbageCollectorControllerOptions holds the GarbageCollectorController options.

func NewGarbageCollectorControllerOptions

func NewGarbageCollectorControllerOptions(cfg *garbagecollectorconfig.GarbageCollectorControllerConfiguration) *GarbageCollectorControllerOptions

func (*GarbageCollectorControllerOptions) AddFlags

func (o *GarbageCollectorControllerOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to GarbageCollectorController for controller manager to the specified FlagSet.

func (*GarbageCollectorControllerOptions) ApplyTo

func (o *GarbageCollectorControllerOptions) ApplyTo(cfg *garbagecollectorconfig.GarbageCollectorControllerConfiguration) error

ApplyTo fills up GarbageCollectorController config with options.

func (*GarbageCollectorControllerOptions) Validate

func (o *GarbageCollectorControllerOptions) Validate() []error

Validate checks validation of GarbageCollectorController.

type GenericControllerManagerConfigurationOptions

type GenericControllerManagerConfigurationOptions struct {
	*cmconfig.GenericControllerManagerConfiguration
}

GenericControllerManagerConfigurationOptions holds the options which are generic.

func NewGenericControllerManagerConfigurationOptions

func NewGenericControllerManagerConfigurationOptions(cfg *cmconfig.GenericControllerManagerConfiguration) *GenericControllerManagerConfigurationOptions

func (*GenericControllerManagerConfigurationOptions) AddFlags

func (o *GenericControllerManagerConfigurationOptions) AddFlags(
	fss *cliflag.NamedFlagSets,
	allControllers []string,
	disabledControllers []string,
	controllerAliasesmap map[string]string,
)

AddFlags adds flags related to ChainController for controller manager to the specified FlagSet.

func (*GenericControllerManagerConfigurationOptions) ApplyTo

func (o *GenericControllerManagerConfigurationOptions) ApplyTo(
	cfg *cmconfig.GenericControllerManagerConfiguration,
	allControllers []string,
	disabledControllers []string,
	controllerAliases map[string]string,
) error

func (*GenericControllerManagerConfigurationOptions) Validate

func (o *GenericControllerManagerConfigurationOptions) Validate(allControllers []string, disabledControllers []string, controllerAliases map[string]string) []error

Validate checks validation of GenericControllerManagerConfigurationOptions.

type Options

type Options struct {
	Generic                    *GenericControllerManagerConfigurationOptions
	GarbageCollectorController *GarbageCollectorControllerOptions
	ChainController            *ChainControllerOptions

	// ConfigFile is the location of the miner controller server's configuration file.
	ConfigFile string

	// WriteConfigTo is the path where the default configuration will be written.
	WriteConfigTo string

	// The address of the Kubernetes API server (overrides any value in kubeconfig).
	Master string
	// Path to kubeconfig file with authorization and master location information.
	Kubeconfig string
	Metrics    *metrics.Options
	Logs       *logs.Options
}

Options is the main context object for the onex-controller manager.

func NewOptions

func NewOptions() (*Options, error)

NewOptions creates a new Options with a default config.

func (*Options) ApplyTo

func (o *Options) ApplyTo(c *controllermanagerconfig.Config, allControllers []string, disabledControllers []string, controllerAliases map[string]string) error

ApplyTo fills up onex controller manager config with options.

func (*Options) Complete

func (o *Options) Complete() error

func (Options) Config

func (o Options) Config(allControllers []string, disabledControllers []string, controllerAliases map[string]string) (*controllermanagerconfig.Config, error)

Config return a controller manager config objective.

func (*Options) Flags

func (o *Options) Flags(allControllers []string, disabledControllers []string, controllerAliases map[string]string) cliflag.NamedFlagSets

Flags returns flags for a specific APIServer by section name.

func (*Options) Validate

func (o *Options) Validate(allControllers []string, disabledControllers []string, controllerAliases map[string]string) error

Validate is used to validate the options and config before launching the controller.