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 *cacheserver.Config) error
  • func (o *Options) Complete() error
  • func (o *Options) Config() (*cacheserver.Config, error)
  • func (o *Options) Flags() (fss cliflag.NamedFlagSets)
  • func (o *Options) Validate() error

Constants

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

Types

type Options

type Options struct {
	DisableCache  bool                           `json:"disable-cache" mapstructure:"disable-cache"`
	GRPCOptions   *genericoptions.GRPCOptions    `json:"grpc" mapstructure:"grpc"`
	TLSOptions    *genericoptions.TLSOptions     `json:"tls" mapstructure:"tls"`
	RedisOptions  *genericoptions.RedisOptions   `json:"redis" mapstructure:"redis"`
	MySQLOptions  *genericoptions.MySQLOptions   `json:"mysql" mapstructure:"mysql"`
	JaegerOptions *genericoptions.JaegerOptions  `json:"jaeger" mapstructure:"jaeger"`
	Metrics       *genericoptions.MetricsOptions `json:"metrics" mapstructure:"metrics"`
	Log           *log.Options                   `json:"log" mapstructure:"log"`
}

Options contains state for master/api server.

func NewOptions

func NewOptions() *Options

NewOptions returns initialized Options.

func (*Options) ApplyTo

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

ApplyTo fills up onex-cacheserver config with options.

func (*Options) Complete

func (o *Options) Complete() error

Complete completes all the required options.

func (*Options) Config

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

Config return a onex-cacheserver 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.