options

Documentation

Overview

Package options contains flags and options for initializing an apiserver

Index

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

Constants

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

Types

type Options

type Options struct {
	HealthOptions *genericoptions.HealthOptions `json:"health" mapstructure:"health"`
	KafkaOptions  *genericoptions.KafkaOptions  `json:"kafka" mapstructure:"kafka"`
	MongoOptions  *genericoptions.MongoOptions  `json:"mongo" mapstructure:"mongo"`
	FeatureGates  map[string]bool               `json:"feature-gates"`
}

Options contains state for master/api server.

func NewOptions

func NewOptions() *Options

NewOptions returns initialized Options.

func (*Options) ApplyTo

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

ApplyTo fills up onex-pump config with options.

func (*Options) Complete

func (o *Options) Complete() error

Complete completes all the required options.

func (*Options) Config

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

Config return an onex-pump 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.