kuma_cp

Documentation

Index

• type Config
  • func DefaultConfig() Config
  • func (c *Config) Sanitize()
  • func (c *Config) Validate() error
• type DataplaneMetrics
  • func (d *DataplaneMetrics) Sanitize()
  • func (d *DataplaneMetrics) Validate() error
• type Defaults
  • func (d *Defaults) MeshProto() v1alpha1.Mesh
  • func (d *Defaults) Sanitize()
  • func (d *Defaults) Validate() error
• type GeneralConfig
  • func DefaultGeneralConfig() *GeneralConfig
  • func (g *GeneralConfig) Sanitize()
  • func (g *GeneralConfig) Validate() error
• type Metrics
  • func (m *Metrics) Sanitize()
  • func (m *Metrics) Validate() error
• type Reports

Types

type Config

type Config struct {
	// General configuration
	General *GeneralConfig `yaml:"general"`
	// Environment Type, can be either "kubernetes" or "universal"
	Environment core.EnvironmentType `yaml:"environment" envconfig:"kuma_environment"`
	// Resource Store configuration
	Store *store.StoreConfig `yaml:"store"`
	// Configuration of Bootstrap Server, which provides bootstrap config to Dataplanes
	BootstrapServer *bootstrap.BootstrapServerConfig `yaml:"bootstrapServer"`
	// Envoy XDS server configuration
	XdsServer *xds.XdsServerConfig `yaml:"xdsServer"`
	// Envoy SDS server configuration
	SdsServer *sds.SdsServerConfig `yaml:"sdsServer"`
	// Dataplane Token server configuration (DEPRECATED: use adminServer)
	DataplaneTokenServer *token_server.DataplaneTokenServerConfig `yaml:"dataplaneTokenServer"`
	// Monitoring Assignment Discovery Service (MADS) server configuration
	MonitoringAssignmentServer *mads.MonitoringAssignmentServerConfig `yaml:"monitoringAssignmentServer"`
	// Admin server configuration
	AdminServer *admin_server.AdminServerConfig `yaml:"adminServer"`
	// API Server configuration
	ApiServer *api_server.ApiServerConfig `yaml:"apiServer"`
	// Environment-specific configuration
	Runtime *runtime.RuntimeConfig
	// Default Kuma entities configuration
	Defaults *Defaults `yaml:"defaults"`
	// Metrics configuration
	Metrics *Metrics `yaml:"metrics"`
	// Reports configuration
	Reports *Reports `yaml:"reports"`
	// GUI Server Config
	GuiServer *gui_server.GuiServerConfig `yaml:"guiServer"`
	// Kuma Cp Mode
	Mode core.CpMode `yaml:"mode"`
}

func DefaultConfig

func DefaultConfig() Config

func (*Config) Sanitize

func (c *Config) Sanitize()

func (*Config) Validate

func (c *Config) Validate() error

type DataplaneMetrics

type DataplaneMetrics struct {
	Enabled           bool `yaml:"enabled" envconfig:"kuma_metrics_dataplane_enabled"`
	SubscriptionLimit int  `yaml:"subscriptionLimit" envconfig:"kuma_metrics_dataplane_subscription_limit"`
}

func (*DataplaneMetrics) Sanitize

func (d *DataplaneMetrics) Sanitize()

func (*DataplaneMetrics) Validate

func (d *DataplaneMetrics) Validate() error

type Defaults

type Defaults struct {
	// Default Mesh configuration in YAML that will be applied on first usage of Kuma CP
	Mesh string `yaml:"mesh"`
}

func (*Defaults) MeshProto

func (d *Defaults) MeshProto() v1alpha1.Mesh

func (*Defaults) Sanitize

func (d *Defaults) Sanitize()

func (*Defaults) Validate

func (d *Defaults) Validate() error

type GeneralConfig

type GeneralConfig struct {
	// Hostname that other components should use in order to connect to the Control Plane.
	// Control Plane will use this value in configuration generated for dataplanes, in responses to `kumactl`, etc.
	AdvertisedHostname string `yaml:"advertisedHostname" envconfig:"kuma_general_advertised_hostname"`
}

func DefaultGeneralConfig

func DefaultGeneralConfig() *GeneralConfig

func (*GeneralConfig) Sanitize

func (g *GeneralConfig) Sanitize()

func (*GeneralConfig) Validate

func (g *GeneralConfig) Validate() error

type Metrics

type Metrics struct {
	Dataplane *DataplaneMetrics `yaml:"dataplane"`
}

func (*Metrics) Sanitize

func (m *Metrics) Sanitize()

func (*Metrics) Validate

func (m *Metrics) Validate() error

type Reports

type Reports struct {
	// If true then usage stats will be reported
	Enabled bool `yaml:"enabled" envconfig:"kuma_reports_enabled"`
}