dataplane

Documentation

Index

• type ConsulConfig
• type CredentialsConfig
• type EnvoyConfig
• type GetDataplaneConfigJSONInput
  • func (i *GetDataplaneConfigJSONInput) GetDataplaneConfigJSON() ([]byte, error)
• type LoggingConfig
• type ProxyConfig
• type StaticCredentialConfig
• type TLSConfig
• type XDSServerConfig

Types

type ConsulConfig

type ConsulConfig struct {
	Addresses       string             `json:"addresses"`
	GRPCPort        int                `json:"grpcPort"`
	SkipServerWatch bool               `json:"serverWatchDisabled"`
	TLS             *TLSConfig         `json:"tls,omitempty"`
	Credentials     *CredentialsConfig `json:"credentials,omitempty"`
}

type CredentialsConfig

type CredentialsConfig struct {
	CredentialType string                 `json:"type"`
	Static         StaticCredentialConfig `json:"static"`
}

type EnvoyConfig

type EnvoyConfig struct {
	ReadyBindAddr string `json:"readyBindAddress"`
	ReadyBindPort int    `json:"readyBindPort"`
}

type GetDataplaneConfigJSONInput

type GetDataplaneConfigJSONInput struct {
	// Registration details about the proxy service
	ProxyRegistration *api.CatalogRegistration

	// User provided information about the Consul servers
	ConsulServerConfig config.ConsulServers

	// ACL token returned by the server after a successful login.
	// If empty, credential details are not populated in the resulting
	// dataplane config JSON.
	ConsulToken string

	// Path of the CA cert file for Consul server's RPC interface
	CACertFile string

	// The HTTP health check port that indicates envoy's readiness
	ProxyHealthCheckPort int

	// The logLevel that will be used to configure dataplane's logger.
	LogLevel string
}

GetDataplaneConfigJSONInputs are the inputs needed to generate a dataplane configuration JSON

func (*GetDataplaneConfigJSONInput) GetDataplaneConfigJSON

func (i *GetDataplaneConfigJSONInput) GetDataplaneConfigJSON() ([]byte, error)

GetDataplaneConfigJSON returns back a configuration JSON which (after writing it to a shared volume) can be used to start consul-dataplane

type LoggingConfig

type LoggingConfig struct {
	LogLevel string `json:"logLevel"`
}

type ProxyConfig

type ProxyConfig struct {
	NodeName  string `json:"nodeName"`
	ID        string `json:"id"`
	Namespace string `json:"namespace"`
	Partition string `json:"partition"`
}

type StaticCredentialConfig

type StaticCredentialConfig struct {
	Token string `json:"token"`
}

type TLSConfig

type TLSConfig struct {
	Disabled       bool   `json:"disabled"`
	GRPCCACertPath string `json:"caCertsPath,omitempty"`
	TLSServerName  string `json:"tlsServerName,omitempty"`
}

type XDSServerConfig

type XDSServerConfig struct {
	Address string `json:"bindAddress"`
}