metadata

Documentation

Index

• Constants
• type Annotations
  • func (a Annotations) GetBool(key string) (bool, bool, error)
  • func (a Annotations) GetEnabled(key string) (bool, bool, error)
  • func (a Annotations) GetMap(key string) (map[string]string, error)
  • func (a Annotations) GetString(key string) (string, bool)
  • func (a Annotations) GetUint32(key string) (uint32, bool, error)

Constants

const (
	// KumaMeshAnnotation defines a Pod annotation that
	// associates a given Pod with a particular Mesh.
	// Annotation value must be the name of a Mesh resource.
	KumaMeshAnnotation = "kuma.io/mesh"

	// KumaSidecarInjectionAnnotation defines a Pod/Namespace annotation that
	// gives users an ability to enable or disable sidecar-injection
	KumaSidecarInjectionAnnotation = "kuma.io/sidecar-injection"

	// KumaGatewayAnnotation allows to mark Gateway pod,
	// inbound listeners won't be generated in that case
	KumaGatewayAnnotation = "kuma.io/gateway"

	// KumaIngressAnnotation allows to mark pod with Kuma Ingress
	// which is crucial for Multizone communication
	KumaIngressAnnotation = "kuma.io/ingress"

	// KumaIngressPublicAddressAnnotation allows to pick public address for Ingress
	// If not defined, Kuma will try to pick this address from the Ingress Service
	KumaIngressPublicAddressAnnotation = "kuma.io/ingress-public-address"

	// KumaIngressPublicPortAnnotation allows to pick public port for Ingress
	// If not defined, Kuma will try to pick this address from the Ingress Service
	KumaIngressPublicPortAnnotation = "kuma.io/ingress-public-port"

	// KumaDirectAccess defines a comma-separated list of Services that will be accessed directly
	KumaDirectAccess = "kuma.io/direct-access-services"

	// KumaVirtualProbesAnnotation enables automatic converting HttpGet probes to virtual. Virtual probe
	// serves on sub-path of insecure port defined in 'KumaVirtualProbesPortAnnotation',
	// i.e :8080/health/readiness -> :9000/8080/health/readiness where 9000 is a value of'KumaVirtualProbesPortAnnotation'
	KumaVirtualProbesAnnotation = "kuma.io/virtual-probes"

	// KumaVirtualProbesPortAnnotation is an insecure port for listening virtual probes
	KumaVirtualProbesPortAnnotation = "kuma.io/virtual-probes-port"

	// KumaSidecarEnvVarsAnnotation is a ; separated list of env vars that will be applied on Kuma Sidecar
	// Example value: TEST1=1;TEST2=2
	KumaSidecarEnvVarsAnnotation = "kuma.io/sidecar-env-vars"

	// KumaMetricsPrometheusPort allows to override `Mesh`-wide default port
	KumaMetricsPrometheusPort = "prometheus.metrics.kuma.io/port"

	// KumaMetricsPrometheusPath to override `Mesh`-wide default path
	KumaMetricsPrometheusPath = "prometheus.metrics.kuma.io/path"

	// KumaBuiltinDNS the sidecar will use its builtin DNS
	KumaBuiltinDNS     = "kuma.io/builtindns"
	KumaBuiltinDNSPort = "kuma.io/builtindnsport"

	KumaTrafficExcludeInboundPorts  = "traffic.kuma.io/exclude-inbound-ports"
	KumaTrafficExcludeOutboundPorts = "traffic.kuma.io/exclude-outbound-ports"
)

Annotations that can be used by the end users.

const (
	KumaSidecarInjectedAnnotation                  = "kuma.io/sidecar-injected"
	KumaSidecarUID                                 = "kuma.io/sidecar-uid"
	KumaTransparentProxyingAnnotation              = "kuma.io/transparent-proxying"
	KumaTransparentProxyingInboundPortAnnotation   = "kuma.io/transparent-proxying-inbound-port"
	KumaTransparentProxyingInboundPortAnnotationV6 = "kuma.io/transparent-proxying-inbound-v6-port"
	KumaTransparentProxyingOutboundPortAnnotation  = "kuma.io/transparent-proxying-outbound-port"
	CNCFNetworkAnnotation                          = "k8s.v1.cni.cncf.io/networks"
	KumaCNI                                        = "kuma-cni"
)

Annotations that are being automatically set by the Kuma Sidecar Injector.

const (
	AnnotationEnabled  = "enabled"
	AnnotationDisabled = "disabled"
	AnnotationTrue     = "true"
	AnnotationFalse    = "false"
)

const (
	IngressServiceUpstream = "ingress.kubernetes.io/service-upstream"
)

Annotations related to the gateway

Types

type Annotations

type Annotations map[string]string

func (Annotations) GetBool

func (a Annotations) GetBool(key string) (bool, bool, error)

func (Annotations) GetEnabled

func (a Annotations) GetEnabled(key string) (bool, bool, error)

func (Annotations) GetMap

func (a Annotations) GetMap(key string) (map[string]string, error)

GetMap returns map from annotation. Example: "kuma.io/sidecar-env-vars: TEST1=1;TEST2=2"

func (Annotations) GetString

func (a Annotations) GetString(key string) (string, bool)

func (Annotations) GetUint32

func (a Annotations) GetUint32(key string) (uint32, bool, error)