kumadp

Documentation

Index

• type ApiServer
  • func (d *ApiServer) Sanitize()
  • func (d *ApiServer) Validate() (errs error)
• type Config
  • func DefaultConfig() Config
  • func (c *Config) Sanitize()
  • func (c *Config) Validate() (errs error)
• type ControlPlane
  • func (c *ControlPlane) Sanitize()
  • func (c *ControlPlane) Validate() (errs error)
• type Dataplane
  • func (d *Dataplane) Sanitize()
  • func (d *Dataplane) Validate() (errs error)
• type DataplaneRuntime
  • func (d *DataplaneRuntime) Sanitize()
  • func (d *DataplaneRuntime) Validate() (errs error)

Types

type ApiServer

type ApiServer struct {
	// Address defines the address of Control Plane API server.
	URL string `yaml:"url,omitempty" envconfig:"kuma_control_plane_api_server_url"`
}

func (*ApiServer) Sanitize

func (d *ApiServer) Sanitize()

func (*ApiServer) Validate

func (d *ApiServer) Validate() (errs error)

type Config

type Config struct {
	// ControlPlane defines coordinates of the Kuma Control Plane.
	ControlPlane ControlPlane `yaml:"controlPlane,omitempty"`
	// Dataplane defines bootstrap configuration of the dataplane (Envoy).
	Dataplane Dataplane `yaml:"dataplane,omitempty"`
	// DataplaneRuntime defines the context in which dataplane (Envoy) runs.
	DataplaneRuntime DataplaneRuntime `yaml:"dataplaneRuntime,omitempty"`
}

Config defines configuration of the Kuma Dataplane Manager.

func DefaultConfig

func DefaultConfig() Config

func (*Config) Sanitize

func (c *Config) Sanitize()

func (*Config) Validate

func (c *Config) Validate() (errs error)

type ControlPlane

type ControlPlane struct {
	// ApiServer defines coordinates of the Control Plane API Server
	ApiServer ApiServer `yaml:"apiServer,omitempty"`
}

ControlPlane defines coordinates of the Control Plane.

func (*ControlPlane) Sanitize

func (c *ControlPlane) Sanitize()

func (*ControlPlane) Validate

func (c *ControlPlane) Validate() (errs error)

type Dataplane

type Dataplane struct {
	// Mesh name.
	Mesh string `yaml:"mesh,omitempty" envconfig:"kuma_dataplane_mesh"`
	// Dataplane name.
	Name string `yaml:"name,omitempty" envconfig:"kuma_dataplane_name"`
	// Port (or range of ports to choose from) for Envoy Admin API to listen on.
	// Empty value indicates that Envoy Admin API should not be exposed over TCP.
	// Format: "9901 | 9901-9999 | 9901- | -9901".
	AdminPort config_types.PortRange `yaml:"adminPort,omitempty" envconfig:"kuma_dataplane_admin_port"`
	// Drain time for listeners.
	DrainTime time.Duration `yaml:"drainTime,omitempty" envconfig:"kuma_dataplane_drain_time"`
}

Dataplane defines bootstrap configuration of the dataplane (Envoy).

func (*Dataplane) Sanitize

func (d *Dataplane) Sanitize()

func (*Dataplane) Validate

func (d *Dataplane) Validate() (errs error)

type DataplaneRuntime

type DataplaneRuntime struct {
	// Path to Envoy binary.
	BinaryPath string `yaml:"binaryPath,omitempty" envconfig:"kuma_dataplane_runtime_binary_path"`
	// Dir to store auto-generated Envoy bootstrap config in.
	ConfigDir string `yaml:"configDir,omitempty" envconfig:"kuma_dataplane_runtime_config_dir"`
	// Path to a file with dataplane token (use 'kumactl generate dataplane-token' to get one)
	TokenPath string `yaml:"dataplaneTokenPath,omitempty" envconfig:"kuma_dataplane_runtime_token_path"`
}

DataplaneRuntime defines the context in which dataplane (Envoy) runs.

func (*DataplaneRuntime) Sanitize

func (d *DataplaneRuntime) Sanitize()

func (*DataplaneRuntime) Validate

func (d *DataplaneRuntime) Validate() (errs error)