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.

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

[remoteconfig][beta] add doc #1236

Merged
merged 4 commits into from
Jun 18, 2024
Merged
Changes from all commits
Commits
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
40 changes: 40 additions & 0 deletions docs/remote_config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Remote Configuration (beta)

This feature was introduced in Datadog Operator v1.7.0 and is currently in beta.

## Overview

Remote Configuration in the Datadog Operator allows you to enable features in a Kubernetes cluster from Datadog.

You can create a policy on the Fleet Automation page to enable a feature for an eligible scope. The Datadog Operator then updates the Agents with the necessary configuration.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we reference some public doc here? It wouldn't be obvious what policy or scope means for people new to RC.
E.g. one of these or both
https://docs.datadoghq.com/agent/remote_config/
https://www.datadoghq.com/blog/remote-configuration-for-datadog/

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We decided not to intentionally during this beta


## Prerequisites

* Datadog Operator v1.7.0+

## Enabling Remote Configuration

Remote Configuration is disabled by default. To enable it using the latest [datadog-operator Helm chart](https://github.com/DataDog/helm-charts/tree/main/charts/datadog-operator), create a Kubernetes Secret that contains your API and application keys:

celenechang marked this conversation as resolved.
Show resolved Hide resolved
```shell
export DD_API_KEY=<YOUR_API_KEY>
export DD_APP_KEY=<YOUR_APP_KEY>

kubectl create secret generic datadog-operator-secret --from-literal api-key=$DD_API_KEY --from-literal app-key=$DD_APP_KEY
```

Then modify your `values.yaml` file with the following:

```yaml
clusterName: example-cluster-name
remoteConfiguration:
enabled: true
apiKeyExistingSecret: datadog-operator-secret
appKeyExistingSecret: datadog-operator-secret
```

Then install the Datadog Operator:

```shell
helm install my-datadog-operator datadog/datadog-operator -f values.yaml
```
Loading