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 *usercenter.Config) error
  • func (o *Options) Complete() error
  • func (o *Options) Config() (*usercenter.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-usercenter"
)

Types

type Options

type Options struct {
	// GenericOptions *genericoptions.Options       `json:"server"   mapstructure:"server"`
	// gRPC options for configuring gRPC related options.
	GRPCOptions *genericoptions.GRPCOptions `json:"grpc" mapstructure:"grpc"`
	// HTTP options for configuring HTTP related options.
	HTTPOptions *genericoptions.HTTPOptions `json:"http" mapstructure:"http"`
	// TLS options for configuring TLS related options.
	TLSOptions *genericoptions.TLSOptions `json:"tls" mapstructure:"tls"`
	// MySQL options for configuring MySQL database related options.
	MySQLOptions *genericoptions.MySQLOptions `json:"mysql" mapstructure:"mysql"`
	// Redis options for configuring Redis related options.
	RedisOptions *genericoptions.RedisOptions `json:"redis" mapstructure:"redis"`
	// Etcd options for configuring Etcd related options.
	EtcdOptions *genericoptions.EtcdOptions `json:"etcd" mapstructure:"etcd"`
	// Kafka options for configuring Kafka related options.
	KafkaOptions *genericoptions.KafkaOptions `json:"kafka" mapstructure:"kafka"`
	// Jaeger options for configuring Jaeger related options.
	JaegerOptions *genericoptions.JaegerOptions `json:"jaeger" mapstructure:"jaeger"`
	// Consul options for configuring Consul related options.
	ConsulOptions *genericoptions.ConsulOptions `json:"consul" mapstructure:"consul"`
	// JWT options for configuring JWT related options.
	JWTOptions *genericoptions.JWTOptions `json:"jwt" mapstructure:"jwt"`
	// Metrics options for configuring metric related options.
	Metrics *genericoptions.MetricsOptions `json:"metrics" mapstructure:"metrics"`
	// TODO: add `mapstructure` tag for FeatureGates
	// A map of string to boolean values representing feature gates for enabling or disabling specific features.
	FeatureGates map[string]bool `json:"feature-gates"`
	// Log options for configuring log related options.
	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 *usercenter.Config) error

ApplyTo fills up onex-usercenter config with options.

func (*Options) Complete

func (o *Options) Complete() error

Complete completes all the required options.

func (*Options) Config

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

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