options

package

v0.1.0 Latest Latest Go to latest Published: Feb 7, 2024 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/superproj/onex

Links

Open Source Insights

Documentation ¶

Overview ¶

Package options contains flags and options for initializing an apiserver

Constants ¶

View Source

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

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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-nightwatch 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 a onex-nightwatch 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.

Source Files ¶

View all Source files

options.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL