Skip to content

Commit 751c25f

Browse files
cswattneko-dd
andauthored
DOCS-9797: Updates to further configuration page for kubernetes (#27298)
* initial commit * Update content/en/containers/kubernetes/configuration.md Co-authored-by: Sandra (neko) <[email protected]> --------- Co-authored-by: Sandra (neko) <[email protected]>
1 parent 1933005 commit 751c25f

File tree

1 file changed

+89
-1
lines changed

1 file changed

+89
-1
lines changed

content/en/containers/kubernetes/configuration.md

Lines changed: 89 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ After you have installed the Datadog Agent in your Kubernetes environment, you m
3333
- [Kubernetes API server timeout](#kubernetes-api-server-timeout)
3434
- [Proxy settings](#proxy-settings)
3535
- [Autodiscovery](#autodiscovery)
36+
- [Set cluster name](#set-cluster-name)
3637
- [Miscellaneous](#miscellaneous)
3738

3839
## Enable APM and tracing
@@ -453,6 +454,23 @@ spec:
453454
liveContainerCollection:
454455
enabled: true
455456
```
457+
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`:
458+
459+
```yaml
460+
apiVersion: datadoghq.com/v2alpha1
461+
kind: DatadogAgent
462+
metadata:
463+
name: datadog
464+
spec:
465+
global:
466+
clusterName: <YOUR_CLUSTER_NAME>
467+
credentials:
468+
apiKey: <DATADOG_API_KEY>
469+
appKey: <DATADOG_APP_KEY>
470+
features:
471+
orchestratorExplorer:
472+
enabled: true
473+
```
456474

457475
{{% /tab %}}
458476
{{% tab "Helm" %}}
@@ -468,7 +486,7 @@ datadog:
468486
enabled: true
469487
```
470488

471-
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`.
489+
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`.
472490

473491
```yaml
474492
datadog:
@@ -484,6 +502,8 @@ datadog:
484502
{{% /tab %}}
485503
{{< /tabs >}}
486504

505+
For restrictions on valid cluster names, see [Set cluster name](#set-cluster-name).
506+
487507
See the [Containers view][15] documentation for additional information.
488508

489509
## Orchestrator Explorer
@@ -512,6 +532,25 @@ spec:
512532
enabled: true
513533
```
514534

535+
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`:
536+
537+
```yaml
538+
apiVersion: datadoghq.com/v2alpha1
539+
kind: DatadogAgent
540+
metadata:
541+
name: datadog
542+
spec:
543+
global:
544+
clusterName: <YOUR_CLUSTER_NAME>
545+
credentials:
546+
apiKey: <DATADOG_API_KEY>
547+
appKey: <DATADOG_APP_KEY>
548+
features:
549+
orchestratorExplorer:
550+
enabled: true
551+
```
552+
553+
515554
{{% /tab %}}
516555
{{% tab "Helm" %}}
517556

@@ -528,9 +567,24 @@ datadog:
528567
enabled: true
529568
```
530569

570+
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`.
571+
572+
```yaml
573+
datadog:
574+
#(...)
575+
clusterName: <YOUR_CLUSTER_NAME>
576+
#(...)
577+
processAgent:
578+
enabled: true
579+
orchestratorExplorer:
580+
enabled: true
581+
```
582+
531583
{{% /tab %}}
532584
{{< /tabs >}}
533585

586+
For restrictions on valid cluster names, see [Set cluster name](#set-cluster-name).
587+
534588
See the [Orchestrator Explorer documentation][21] for additional information.
535589

536590
## Basic configuration
@@ -823,6 +877,40 @@ Starting with Agent v6.4.0 (and v6.5.0 for the Trace Agent), you can override th
823877
| `DD_PROXY_NO_PROXY` | A space-separated list of URLs for which no proxy should be used. |
824878
| `DD_SKIP_SSL_VALIDATION` | An option to test if the Agent is having issues connecting to Datadog. |
825879

880+
## Set cluster name
881+
882+
Some capabilities require that you set a Kubernetes cluster name. A valid cluster name must be unique and dot-separated, with the following restrictions:
883+
884+
- Can contain only lowercase letters, numbers, and hyphens
885+
- Must start with a letter
886+
- Overall length is less than or equal to 80 characters
887+
888+
{{< tabs >}}
889+
{{% tab "Datadog Operator" %}}
890+
Set `spec.global.clusterName` to your cluster name in `datadog-agent.yaml`:
891+
892+
```yaml
893+
apiVersion: datadoghq.com/v2alpha1
894+
kind: DatadogAgent
895+
metadata:
896+
name: datadog
897+
spec:
898+
global:
899+
clusterName: <YOUR_CLUSTER_NAME>
900+
```
901+
{{% /tab %}}
902+
903+
{{% tab "Helm" %}}
904+
Set `datadog.clusterName` to your cluster name in `datadog-values.yaml`.
905+
906+
```yaml
907+
datadog:
908+
#(...)
909+
clusterName: <YOUR_CLUSTER_NAME>
910+
```
911+
{{% /tab %}}
912+
{{< /tabs >}}
913+
826914
## Autodiscovery
827915

828916
| Env Variable | Description |

0 commit comments

Comments
 (0)