admin_server

Documentation

Index

• type AdminServerApisConfig
  • func DefaultAdminServerApisConfig() *AdminServerApisConfig
  • func (a *AdminServerApisConfig) Sanitize()
  • func (a *AdminServerApisConfig) Validate() error
• type AdminServerConfig
  • func DefaultAdminServerConfig() *AdminServerConfig
  • func (i *AdminServerConfig) Sanitize()
  • func (i *AdminServerConfig) Validate() error
• type DataplaneTokenApiConfig
  • func DefaultDataplaneTokenWsConfig() *DataplaneTokenApiConfig
  • func (d *DataplaneTokenApiConfig) Sanitize()
  • func (d *DataplaneTokenApiConfig) Validate() error
• type LocalAdminServerConfig
  • func DefaultLocalAdminServerConfig() *LocalAdminServerConfig
  • func (l *LocalAdminServerConfig) Sanitize()
  • func (l *LocalAdminServerConfig) Validate() error
• type PublicAdminServerConfig
  • func DefaultPublicAdminServerConfig() *PublicAdminServerConfig
  • func (p *PublicAdminServerConfig) Sanitize()
  • func (p *PublicAdminServerConfig) Validate() error

Types

type AdminServerApisConfig

type AdminServerApisConfig struct {
	// Dataplane Token API configuration
	DataplaneToken *DataplaneTokenApiConfig `yaml:"dataplaneToken"`
}

Admin Server APIs configuration

func DefaultAdminServerApisConfig

func DefaultAdminServerApisConfig() *AdminServerApisConfig

func (*AdminServerApisConfig) Sanitize

func (a *AdminServerApisConfig) Sanitize()

func (*AdminServerApisConfig) Validate

func (a *AdminServerApisConfig) Validate() error

type AdminServerConfig

type AdminServerConfig struct {
	// Admin Server APIs configuration
	Apis *AdminServerApisConfig `yaml:"apis"`
	// Local configuration of server that is available only on localhost
	Local *LocalAdminServerConfig `yaml:"local"`
	// Public configuration of server that is available on public interface
	Public *PublicAdminServerConfig `yaml:"public"`
}

Admin Server configuration

func DefaultAdminServerConfig

func DefaultAdminServerConfig() *AdminServerConfig

func (*AdminServerConfig) Sanitize

func (i *AdminServerConfig) Sanitize()

func (*AdminServerConfig) Validate

func (i *AdminServerConfig) Validate() error

type DataplaneTokenApiConfig

type DataplaneTokenApiConfig struct {
	// If true then Dataplane Token WS and token verification is enabled
	Enabled bool `yaml:"enabled" envconfig:"kuma_admin_server_apis_dataplane_token_enabled"`
}

Dataplane Token API configuration

func DefaultDataplaneTokenWsConfig

func DefaultDataplaneTokenWsConfig() *DataplaneTokenApiConfig

func (*DataplaneTokenApiConfig) Sanitize

func (d *DataplaneTokenApiConfig) Sanitize()

func (*DataplaneTokenApiConfig) Validate

func (d *DataplaneTokenApiConfig) Validate() error

type LocalAdminServerConfig

type LocalAdminServerConfig struct {
	// Port on which the server will be exposed
	Port uint32 `yaml:"port" envconfig:"kuma_admin_server_local_port"`
}

Admin Server configuration of server that is available only on localhost

func DefaultLocalAdminServerConfig

func DefaultLocalAdminServerConfig() *LocalAdminServerConfig

func (*LocalAdminServerConfig) Sanitize

func (l *LocalAdminServerConfig) Sanitize()

func (*LocalAdminServerConfig) Validate

func (l *LocalAdminServerConfig) Validate() error

type PublicAdminServerConfig

type PublicAdminServerConfig struct {
	// If true then Admin Server is exposed on public interface
	Enabled bool `yaml:"enabled" envconfig:"kuma_admin_server_public_enabled"`
	// Interface on which the server will be exposed
	Interface string `yaml:"interface" envconfig:"kuma_admin_server_public_interface"`
	// Port on which the server will be exposed. If not specified (0) then port from local configuration will be used
	Port uint32 `yaml:"port" envconfig:"kuma_admin_server_public_port"`
	// Path to TLS certificate file
	TlsCertFile string `yaml:"tlsCertFile" envconfig:"kuma_admin_server_public_tls_cert_file"`
	// Path to TLS key file
	TlsKeyFile string `yaml:"tlsKeyFile" envconfig:"kuma_admin_server_public_tls_key_file"`
	// Directory of authorized client certificates
	ClientCertsDir string `yaml:"clientCertsDir" envconfig:"kuma_admin_server_public_client_certs_dir"`
}

Admin Server configuration of server that is available on public interface

func DefaultPublicAdminServerConfig

func DefaultPublicAdminServerConfig() *PublicAdminServerConfig

func (*PublicAdminServerConfig) Sanitize

func (p *PublicAdminServerConfig) Sanitize()

func (*PublicAdminServerConfig) Validate

func (p *PublicAdminServerConfig) Validate() error