6.2 KiB
| title | overview | order | layout | type |
|---|---|---|---|---|
| kubernetes Config | Generated documentation for Mixer's kubernetes Adapter Configuration Schema | 30 | docs | markdown |
Index
- Params (message)
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, target, and origin).
For all valid UIDs supplied, this adapter generates a map of output values containing information about the related pods. The generated map is keyed by value names generated by concatenating a pod identifier prefix with a value name. For example, for the pod corresponding to a sourceUID and the output value of pod ip, this adapter will output a map that includes a key of "sourcePodIP" (assuming parameter defaults). next field id: 19
| 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. Default: "" (unset) |
cacheRefreshDuration |
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 |
sourceUidInputName |
string | Configures how the UID for the source pod for traffic is identified in the input map. Default: sourceUID |
targetUidInputName |
string | Configures how the UID for the target pod for traffic is identified in the input map. Default: targetUID |
originUidInputName |
string | Configures how the UID for the origin pod for traffic is identified in the input map. Default: originUID |
targetServiceInputName |
string | Configures how the identifier for the target service is populated in the input map (if at all). When supplied, this value will be used (after successful normalization) in place of the value derived from the pod cache for the target pod in the generated map of output values. Default: targetService |
clusterDomainName |
string | Configures the cluster domain name to use for service name normalization. Default: svc.cluster.local |
podLabelForService |
string | In order to extract the service associated with a source, target, 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 |
sourcePrefix |
string | The prefix used for source pod output value names. Default: source |
targetPrefix |
string | The prefix used for target pod output value names. Default: target |
originPrefix |
string | The prefix used for origin pod output value names. Default: origin |
labelsValueName |
string | The value name for the pod labels output value. Default: Labels |
podNameValueName |
string | The value name for the pod name output value. Default: PodName |
podIpValueName |
string | The value name for the pod ip address output value. Default: PodIP |
hostIpValueName |
string | The value name for the pod host ip address output value. Default: HostIP |
namespaceValueName |
string | The value name for the pod namespace output value. Default: Namespace |
serviceAccountValueName |
string | The value name for the pod service account name output value. Default: ServiceAccountName |
serviceValueName |
string | The value name for the service output value. Default: Service |