options

Documentation

Overview

Package options provides the flags used for the miner controller.

Index

• Constants
• func LoadConfigFromFile(file string) (*config.MinerControllerConfiguration, error)
• func LogOrWriteConfig(fileName string, cfg *config.MinerControllerConfiguration) error
• type Options
  • func NewOptions() (*Options, error)
  • func (o *Options) ApplyDeprecated()
  • func (o *Options) ApplyTo(c *controllerconfig.Config) error
  • func (o *Options) Complete() error
  • func (o *Options) Config() (*controllerconfig.Config, error)
  • func (o *Options) Flags() (fss cliflag.NamedFlagSets)
  • func (o *Options) Validate() error

Constants

const (
	// ControllerUserAgent is the userAgent name when starting onex-miner controller.
	ControllerUserAgent = "onex-miner-controller"
)

Functions

func LoadConfigFromFile

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

func LogOrWriteConfig

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

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

Types

type Options

type Options struct {
	// 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

	Logs *logs.Options
	// contains filtered or unexported fields
}

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

func NewOptions

func NewOptions() (*Options, error)

NewOptions creates a new Options with a default config.

func (*Options) ApplyDeprecated

func (o *Options) ApplyDeprecated()

func (*Options) ApplyTo

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

ApplyTo fills up miner controller config with options.

func (*Options) Complete

func (o *Options) Complete() error

Complete completes all the required options.

func (*Options) Config

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

Config return a miner controller config objective.

func (*Options) Flags

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

Flags returns flags for a specific APIServer by section name.

func (*Options) Validate

func (o *Options) Validate() error

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