dataplane

Documentation

Index

• Variables
• func ConfigureKongPluginRelatedEnvVars(kongPluginNames []string) []corev1.EnvVar
• func FillDataPlaneProxyContainerEnvs(existing []corev1.EnvVar, podTemplateSpec *corev1.PodTemplateSpec, ...)
• func KongInKonnectDefaults(params KongInKonnectParams) map[string]string
• type KongInKonnectParams

Variables

var KongDefaults = map[string]string{
	"KONG_ADMIN_ACCESS_LOG":       "/dev/stdout",
	"KONG_ADMIN_ERROR_LOG":        "/dev/stderr",
	"KONG_ADMIN_GUI_ACCESS_LOG":   "/dev/stdout",
	"KONG_ADMIN_GUI_ERROR_LOG":    "/dev/stderr",
	"KONG_CLUSTER_LISTEN":         "off",
	"KONG_DATABASE":               "off",
	"KONG_NGINX_WORKER_PROCESSES": "2",

	"KONG_PORTAL_API_ACCESS_LOG": "/dev/stdout",
	"KONG_PORTAL_API_ERROR_LOG":  "/dev/stderr",
	"KONG_PORT_MAPS":             "80:8000, 443:8443",
	"KONG_PROXY_ACCESS_LOG":      "/dev/stdout",
	"KONG_PROXY_ERROR_LOG":       "/dev/stderr",
	"KONG_PROXY_LISTEN":          fmt.Sprintf("0.0.0.0:%d reuseport backlog=16384, 0.0.0.0:%d http2 ssl reuseport backlog=16384", consts.DataPlaneProxyPort, consts.DataPlaneProxySSLPort),
	"KONG_STATUS_LISTEN":         fmt.Sprintf("0.0.0.0:%d", consts.DataPlaneStatusPort),

	"KONG_ADMIN_LISTEN": fmt.Sprintf("0.0.0.0:%d ssl reuseport backlog=16384", consts.DataPlaneAdminAPIPort),

	"KONG_ADMIN_SSL_CERT":                     "/var/cluster-certificate/tls.crt",
	"KONG_ADMIN_SSL_CERT_KEY":                 "/var/cluster-certificate/tls.key",
	"KONG_NGINX_ADMIN_SSL_CLIENT_CERTIFICATE": "/var/cluster-certificate/ca.crt",
	"KONG_NGINX_ADMIN_SSL_VERIFY_CLIENT":      "on",
	"KONG_NGINX_ADMIN_SSL_VERIFY_DEPTH":       "3",
	// contains filtered or unexported fields
}

KongDefaults are the baseline Kong proxy configuration options needed for the proxy to function.

Functions

func ConfigureKongPluginRelatedEnvVars

func ConfigureKongPluginRelatedEnvVars(kongPluginNames []string) []corev1.EnvVar

ConfigureKongPluginRelatedEnvVars returns the environment variables needed for configuring the Kong Gateway with the provided Kong Plugin names. If kongPluginNames is nil or empty, nil is returned. Kong will use bundled plugins by default if we do not override `KONG_PLUGINS`.

func FillDataPlaneProxyContainerEnvs

func FillDataPlaneProxyContainerEnvs(existing []corev1.EnvVar, podTemplateSpec *corev1.PodTemplateSpec, envSet map[string]string)

FillDataPlaneProxyContainerEnvs sets any unset default configuration options on the DataPlane. It allows overriding the defaults via the provided PodTemplateSpec. The default configuration is passed as the last argument. EnvVars are sorted lexographically as a side effect. It also returns the updated EnvVar slice.

func KongInKonnectDefaults

func KongInKonnectDefaults(params KongInKonnectParams) map[string]string

KongInKonnectDefaults returnes the map of Konnect-related env vars properly configured.

Types

type KongInKonnectParams

type KongInKonnectParams struct {
	ControlPlane string
	Region       string
	Server       string
}

KongInKonnectParams is a struct that holds the parameters needed to customize the KongInKonnectDefaultsTemplate map.