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

Constants

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

Types

type Options

type Options struct {
	// GenericOptions *genericoptions.Options       `json:"server"   mapstructure:"server"`
	GRPCOptions       *genericoptions.GRPCOptions    `json:"grpc" mapstructure:"grpc"`
	HTTPOptions       *genericoptions.HTTPOptions    `json:"http" mapstructure:"http"`
	TLSOptions        *genericoptions.TLSOptions     `json:"tls" mapstructure:"tls"`
	MySQLOptions      *genericoptions.MySQLOptions   `json:"mysql" mapstructure:"mysql"`
	RedisOptions      *genericoptions.RedisOptions   `json:"redis" mapstructure:"redis"`
	EtcdOptions       *genericoptions.EtcdOptions    `json:"etcd" mapstructure:"etcd"`
	JaegerOptions     *genericoptions.JaegerOptions  `json:"jaeger" mapstructure:"jaeger"`
	ConsulOptions     *genericoptions.ConsulOptions  `json:"consul" mapstructure:"consul"`
	UserCenterOptions *usercenter.UserCenterOptions  `json:"usercenter" mapstructure:"usercenter"`
	Metrics           *genericoptions.MetricsOptions `json:"metrics" mapstructure:"metrics"`
	EnableTLS         bool                           `json:"enable-tls" mapstructure:"enable-tls"`
	// 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 state for master/api server.

func NewOptions

func NewOptions() *Options

NewOptions returns initialized Options.

func (*Options) ApplyTo

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

ApplyTo fills up onex-gateway config with options.

func (*Options) Complete

func (o *Options) Complete() error

Complete completes all the required options.

func (*Options) Config

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

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