options

Documentation

Index

• type Options
  • func NewOptions() *Options
  • func (o *Options) AddFlags(flags *pflag.FlagSet)
  • func (o *Options) ApplyTo(cfg *serverconfig.Config) error
  • func (o *Options) Complete() error
  • func (o *Options) Validate() []error
• type ServerOptions
  • func NewServerOptions() *ServerOptions
  • func (o *ServerOptions) AddFlags(fs *pflag.FlagSet)
  • func (o *ServerOptions) ApplyTo(cfg *serverconfig.Config) error
  • func (o *ServerOptions) Complete() error
  • func (o *ServerOptions) Validate() []error

Types

type Options

type Options struct {
	// ApiQps for rest client
	ApiQps int
	// ApiBurst for rest  client
	ApiBurst int
	// LeaderElection hold the configurations for manager leader election.
	LeaderElection componentbaseconfig.LeaderElectionConfiguration
	// MetricsAddr is The address the metric endpoint binds to.
	MetricsAddr string
	// BindAddr is The address the probe endpoint binds to.
	BindAddr string

	PredictionUpdateFrequency time.Duration
	// DataSource is the datasource of the predictor, such as prometheus, nodelocal, etc.
	DataSource []string
	// DataSourcePromConfig is the prometheus datasource config
	DataSourcePromConfig providers.PromConfig
	// DataSourceMockConfig is the mock data provider
	DataSourceMockConfig providers.MockConfig
	// DataSourceGrpcConfig is the config for grpc provider
	DataSourceGrpcConfig providers.GrpcConfig

	// AlgorithmModelConfig
	AlgorithmModelConfig config.AlgorithmModelConfig

	// WebhookConfig
	WebhookConfig webhooks.WebhookConfig

	// RecommendationConfigFile is the configuration file for resource/HPA recommendations.
	// If unspecified, a default is provided.
	RecommendationConfigFile string

	// QOSConfigFile is the configuration file for QOS.
	QOSConfigFile string

	// ServerOptions hold the craned web server options
	ServerOptions *ServerOptions

	// EhpaControllerConfig is the configuration for Ehpa controller
	EhpaControllerConfig ehpa.EhpaControllerConfig

	// RecommendationConfiguration is configuration file for recommendation framework.
	// If unspecified, a default is provided.
	RecommendationConfiguration string

	// OOMRecordMaxNumber is the max number for oom record
	OOMRecordMaxNumber int

	// TimeSeriesPredictionMaxConcurrentReconciles is the max concurrent reconciles for TimeSeriesPrediction controller
	TimeSeriesPredictionMaxConcurrentReconciles int

	// CacheUnstructured indicates whether to cache Unstructured objects. When enabled, it will speed up reading Unstructured objects, but will increase memory usage.
	CacheUnstructured bool
}

Options hold the command-line options about craned

func NewOptions

func NewOptions() *Options

NewOptions builds an empty options.

func (*Options) AddFlags

func (o *Options) AddFlags(flags *pflag.FlagSet)

AddFlags adds flags to the specified FlagSet.

func (*Options) ApplyTo

func (o *Options) ApplyTo(cfg *serverconfig.Config) error

func (*Options) Complete

func (o *Options) Complete() error

Complete completes all the required options.

func (*Options) Validate

func (o *Options) Validate() []error

Validate all required options.

type ServerOptions

type ServerOptions struct {
	BindAddress string
	BindPort    int

	EnableProfiling bool
	EnableMetrics   bool
	Mode            string

	EnableGrafana     bool
	GrafanaConfigFile string
	dashboard.GrafanaConfig

	StoreType string
}

ServerOptions used for craned web server

func NewServerOptions

func NewServerOptions() *ServerOptions

func (*ServerOptions) AddFlags

func (o *ServerOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to features for a specific server option to the specified FlagSet.

func (*ServerOptions) ApplyTo

func (o *ServerOptions) ApplyTo(cfg *serverconfig.Config) error

func (*ServerOptions) Complete

func (o *ServerOptions) Complete() error

func (*ServerOptions) Validate

func (o *ServerOptions) Validate() []error