Kubernetes Env

The kubernetesenv adapter extracts information from a Kubernetes environment and produces attribtes that can be used in downstream adapters.

This adapter supports the kubernetesenv template.

Params

Configuration parameters for the kubernetes adapter. These params control the manner in which the kubernetes adapter discovers and generates values related to pod information.

The adapter works by looking up pod information by UIDs (of the form: “kubernetes://pod.namespace”). It expects that the UIDs will be supplied in an input map for three distinct traffic classes (source, destination, and origin).

For all valid UIDs supplied, this adapter generates output values containing information about the related pods.

FieldTypeDescription
kubeconfigPathstring

File path to discover kubeconfig. For in-cluster configuration, this should be left unset. For local configuration, this should be set to the path of a kubeconfig file that can be used to reach a kubernetes API server.

NOTE: The kubernetes adapter will use the value of the env var KUBECONFIG in the case where it is set (overriding any value configured through this proto).

Default: “” (unset)

cacheRefreshDurationgoogle.protobuf.Duration

Controls the resync period of the kubernetes cluster info cache. The cache will watch for events and every so often completely resync. This controls how frequently the complete resync occurs.

Default: 5 minutes

clusterDomainNamestring

Configures the cluster domain name to use for service name normalization.

Default: svc.cluster.local

podLabelForServicestring

In order to extract the service associated with a source, destination, or origin, this adapter relies on pod labels. In particular, it looks for the value of a specific label, as specified by this parameter.

Default: app

podLabelForIstioComponentServicestring

In order to extract the service associated with a source, destination, or origin, this adapter relies on pod labels. In particular, it looks for the value of a specific label for istio component services, as specified by this parameter.

Default: istio

lookupIngressSourceAndOriginValuesbool

Default: false

fullyQualifiedIstioIngressServiceNamestring

Istio ingress service string. This is used to identify the ingress service in requests.

Default: “ingress.istio-system.svc.cluster.local”