Merge branch 'master' into davit.b/MLOB-2083-update-documentation-for…

…-azure-openai
DataDog · Jan 27, 2025 · 69d2504 · 69d2504
2 parents 4df7a10 + 751c25f
commit 69d2504
Showing 1 changed file with 89 additions and 1 deletion.
diff --git a/content/en/containers/kubernetes/configuration.md b/content/en/containers/kubernetes/configuration.md
@@ -33,6 +33,7 @@ After you have installed the Datadog Agent in your Kubernetes environment, you m
 - [Kubernetes API server timeout](#kubernetes-api-server-timeout)
 - [Proxy settings](#proxy-settings)
 - [Autodiscovery](#autodiscovery)
+- [Set cluster name](#set-cluster-name)
 - [Miscellaneous](#miscellaneous)
 
 ## Enable APM and tracing
@@ -453,6 +454,23 @@ spec:
     liveContainerCollection:
       enabled: true
 ```
+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, you must set `spec.global.clusterName` to your cluster name in `datadog-agent.yaml`:
+
+```yaml
+apiVersion: datadoghq.com/v2alpha1
+kind: DatadogAgent
+metadata:
+  name: datadog
+spec:
+  global:
+    clusterName: <YOUR_CLUSTER_NAME>
+    credentials:
+      apiKey: <DATADOG_API_KEY>
+      appKey: <DATADOG_APP_KEY>
+  features:
+    orchestratorExplorer:
+      enabled: true
+```
 
 {{% /tab %}}
 {{% tab "Helm" %}}
@@ -468,7 +486,7 @@ datadog:
     enabled: true
 ```
 
-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, you must set `datadog.clusterName` to your cluster name in `values.yaml`.
+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, you must set `datadog.clusterName` to your cluster name in `datadog-values.yaml`.
 
 ```yaml
 datadog:
@@ -484,6 +502,8 @@ datadog:
 {{% /tab %}}
 {{< /tabs >}}
 
+For restrictions on valid cluster names, see [Set cluster name](#set-cluster-name).
+
 See the [Containers view][15] documentation for additional information.
 
 ## Orchestrator Explorer
@@ -512,6 +532,25 @@ spec:
       enabled: true
 ```
 
+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, you must set `spec.global.clusterName` to your cluster name in `datadog-agent.yaml`:
+
+```yaml
+apiVersion: datadoghq.com/v2alpha1
+kind: DatadogAgent
+metadata:
+  name: datadog
+spec:
+  global:
+    clusterName: <YOUR_CLUSTER_NAME>
+    credentials:
+      apiKey: <DATADOG_API_KEY>
+      appKey: <DATADOG_APP_KEY>
+  features:
+    orchestratorExplorer:
+      enabled: true
+```
+
+
 {{% /tab %}}
 {{% tab "Helm" %}}
 
@@ -528,9 +567,24 @@ datadog:
     enabled: true
 ```
 
+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, you must set `datadog.clusterName` to your cluster name in `values.yaml`.
+
+```yaml
+datadog:
+  #(...)
+  clusterName: <YOUR_CLUSTER_NAME>
+  #(...)
+  processAgent:
+    enabled: true
+  orchestratorExplorer:
+    enabled: true
+```
+
 {{% /tab %}}
 {{< /tabs >}}
 
+For restrictions on valid cluster names, see [Set cluster name](#set-cluster-name).
+
 See the [Orchestrator Explorer documentation][21] for additional information.
 
 ## Basic configuration
@@ -823,6 +877,40 @@ Starting with Agent v6.4.0 (and v6.5.0 for the Trace Agent), you can override th
 | `DD_PROXY_NO_PROXY`      | A space-separated list of URLs for which no proxy should be used.      |
 | `DD_SKIP_SSL_VALIDATION` | An option to test if the Agent is having issues connecting to Datadog. |
 
+## Set cluster name
+
+Some capabilities require that you set a Kubernetes cluster name. A valid cluster name must be unique and dot-separated, with the following restrictions:
+
+- Can contain only lowercase letters, numbers, and hyphens
+- Must start with a letter
+- Overall length is less than or equal to 80 characters
+
+{{< tabs >}}
+{{% tab "Datadog Operator" %}}
+Set `spec.global.clusterName` to your cluster name in `datadog-agent.yaml`:
+
+```yaml
+apiVersion: datadoghq.com/v2alpha1
+kind: DatadogAgent
+metadata:
+  name: datadog
+spec:
+  global:
+    clusterName: <YOUR_CLUSTER_NAME>
+```
+{{% /tab %}}
+
+{{% tab "Helm" %}}
+Set `datadog.clusterName` to your cluster name in `datadog-values.yaml`.
+
+```yaml
+datadog:
+  #(...)
+  clusterName: <YOUR_CLUSTER_NAME>
+```
+{{% /tab %}}
+{{< /tabs >}}
+
 ## Autodiscovery
 
 | Env Variable                 | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |