---
title: Kubernetes Env
description: Adapter that extracts information from a Kubernetes environment.
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/kubernetesenv.html
layout: protoc-gen-docs
generator: protoc-gen-docs
supported_templates: kubernetes
aliases:
- /docs/reference/config/adapters/kubernetesenv.html
number_of_entries: 1
---
The kubernetesenv
adapter extracts information from a Kubernetes environment
and produces attribtes that can be used in downstream adapters.
This adapter supports the kubernetes 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.
Field |
Type |
Description |
kubeconfigPath |
string |
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)
|
cacheRefreshDuration |
google.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
|
clusterRegistriesNamespace |
string |
Namespace for secret created for multi-cluster support.
Details on multi-cluster and the kubernetes secret required to
access the remote cluster’s credentials can be found here:
https://istio.io/docs/setup/kubernetes/multicluster-install
NOTE: If clusterregistriesnamespace is not set then the environmental
variable PODNAMESPACE will be checked/used. If PODNAMESPACE is not
set then clusterregistriesnamespace will default to “istio-system”.
Default: “istio-system”
|