/

Kubernetes ConfigMaps

Including details about Kubernetes ConfigMaps in collected output


The configMap collector can be used to include metadata about ConfigMaps (and optionally the value) in the collected data. This collector can be included multiple times, referencing different ConfigMaps.

Parameters

In addition to the shared collector properties, the configMap collector accepts the following parameters:

name (Required if no selector)

The name of the ConfigMap.

selector (Required if no name)

The selector to use to locate the ConfigMaps.

namespace (Required)

The namespace where the ConfigMap exists.

key (Optional)

A key within the ConfigMap. Required if includeValue is true.

includeValue (Optional)

Whether to include the key value. Defaults to false.

includeAllData (Optional)

Whether to include all of the key-value pairs from the ConfigMap data. Defaults to false.

Example Collector Definition

apiVersion: troubleshoot.sh/v1beta2
kind: SupportBundle
metadata:
  name: sample
spec:
  collectors:
    - configMap:
        namespace: default
        name: my-configmap
        includeValue: true
        key: password
        includeAllData: true

Example ConfigMap

apiVersion: v1
kind: ConfigMap
metadata:
  name: my-configmap
  namespace: default
data:
  other-key: other-value
  password: mypass

Included resources

When this collector is executed, it will include the following file in a support bundle:

/configmaps/[namespace]/[name]/[key].json

{
  "namespace": "default",
  "name": "my-configmap",
  "key": "password",
  "configMapExists": true,
  "keyExists": true,
  "value": "mypass",
  "data:": {
    "other-key": "other-value",
    "password": "mypass"
  }
}

If key is not set in the collector spec, the file will be created at:

/configmaps/[namespace]/[name].json

If there is an error encountered, it will include the following file:

/configmaps-errors/[namespace]/[name].json

[
  "configmaps \"my-configmap\" not found"
]
Edit on GitHub