If you are using the official Datadog Helm Chart:
- Use chart version above 2.4.5 and before 2.10.0. Starting from chart version 2.10.0 onwards, see the latest configuration instructions instead.
Note: Ensure the Agent and Cluster Agent versions are hardcoded with the minimum versions required or above in your Helm chart values.yaml file.
- Set
datadog.orchestratorExplorer.enabled
to true
in values.yaml. - Deploy a new release.
In some setups, the Process Agent and Cluster Agent cannot automatically detect a Kubernetes cluster name. If this happens, the feature does not start, and the following warning displays in the Cluster Agent log: Orchestrator explorer enabled but no cluster name set: disabling
. In this case, set datadog.clusterName
to your cluster name in values.yaml.
The Cluster Agent must be running, and the Agent must be able to communicate with it. See the Cluster Agent Setup for configuration.
Set the Cluster Agent container with the following environment variable:
- name: DD_ORCHESTRATOR_EXPLORER_ENABLED
value: "true"
Set the Cluster Agent ClusterRole with the following RBAC permissions.
Note: For the apps
apiGroups, Live Containers need permissions
to collect common Kubernetes resources (for example, pods
, services
, and nodes
),
which are already in the RBAC if you followed Cluster Agent Setup. If they are missing, ensure they are added (after deployments
, replicasets
):
ClusterRole:
- apiGroups: # To create the datadog-cluster-id ConfigMap
- ""
resources:
- configmaps
verbs:
- create
- get
- update
...
- apiGroups: # Required to get the kube-system namespace UID and generate a cluster ID
- ""
resources:
- namespaces
verbs:
- get
...
- apiGroups: # To collect new resource types
- "apps"
resources:
- deployments
- replicasets
- daemonsets
- statefulsets
verbs:
- list
- get
- watch
- apiGroups:
- networking.k8s.io
resources:
- ingresses
verbs:
- list
- watch
These permissions are needed to create a datadog-cluster-id
ConfigMap in the same Namespace as the Agent DaemonSet and the Cluster Agent Deployment, as well as to collect Deployments and ReplicaSets.
If the cluster-id
ConfigMap doesn’t get created by the Cluster Agent, the Agent pod does not start, and falls into CreateContainerConfigError
status. If the Agent pod is stuck because the ConfigMap doesn’t exist, update the Cluster Agent permissions and restart its pods. This creates the ConfigMap and the Agent pod recovers automatically.
The Process Agent, which runs in the Agent DaemonSet, must be enabled and running (it doesn’t need to run the process collection), and configured with the following options:
- name: DD_ORCHESTRATOR_EXPLORER_ENABLED
value: "true"
- name: DD_ORCHESTRATOR_CLUSTER_ID
valueFrom:
configMapKeyRef:
name: datadog-cluster-id
key: id
In some setups, the Process Agent and Cluster Agent are unable to automatically detect a Kubernetes cluster name. If this happens the feature does not start, and the following warning displays in the Cluster Agent log: Orchestrator explorer enabled but no cluster name set: disabling
. In this case you must add the following options in the env
section of both the Cluster Agent and the Process Agent:
- name: DD_CLUSTER_NAME
value: "<YOUR_CLUSTER_NAME>"