Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS-9797: Updates to further configuration page for kubernetes #27298

Merged
merged 2 commits into from
Jan 27, 2025
Merged

DOCS-9797: Updates to further configuration page for kubernetes #27298

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b45b04a
initial commit
cswatt Jan 24, 2025
9a58139
Update content/en/containers/kubernetes/configuration.md
cswatt Jan 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 89 additions & 1 deletion content/en/containers/kubernetes/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
- [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
Expand Down Expand Up @@ -453,6 +454,23 @@
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" %}}
Expand All @@ -468,7 +486,7 @@
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`.

Check notice on line 489 in content/en/containers/kubernetes/configuration.md

View workflow job for this annotation

GitHub Actions / vale

Datadog.sentencelength 

Suggestion: Try to keep your sentence length to 25 words or fewer.

```yaml
datadog:
Expand All @@ -484,6 +502,8 @@
{{% /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
Expand Down Expand Up @@ -512,6 +532,25 @@
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" %}}

Expand All @@ -528,9 +567,24 @@
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`.

Check notice on line 570 in content/en/containers/kubernetes/configuration.md

View workflow job for this annotation

GitHub Actions / vale

Datadog.sentencelength 

Suggestion: Try to keep your sentence length to 25 words or fewer.

```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
Expand Down Expand Up @@ -823,6 +877,40 @@
| `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 |
Expand Down
Loading