Skip to content

Commit 99b5401

Browse files
committed
Update dashboard doc
1 parent 0fd99dd commit 99b5401

File tree

1 file changed

+2
-10
lines changed

1 file changed

+2
-10
lines changed

docs/datadog_dashboard.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,6 @@ The `DatadogDashboard` Custom Resource Definition (CRD) allows users to create [
1010
- [Helm][2], to deploy the Datadog Operator
1111
- The [kubectl CLI][3], to install a `DatadogDashboard`
1212

13-
## Configuration
14-
15-
### Environment Variables
16-
17-
The DatadogDashboard controller supports the following environment variable:
18-
19-
- `DD_DASHBOARD_FORCE_SYNC_PERIOD`: Configures the frequency at which the controller performs a force sync with the Datadog API to ensure dashboard parity. Defaults to 60 minutes if not set. Example: `DD_DASHBOARD_FORCE_SYNC_PERIOD=30m`
20-
2113
## Adding a DatadogDashboard
2214

2315
To deploy a `DatadogDashboard` with the Datadog Operator, use the [`datadog-operator` Helm chart][4].
@@ -121,8 +113,8 @@ To deploy a `DatadogDashboard` with the Datadog Operator, use the [`datadog-oper
121113
```
122114

123115
This automatically creates a new dashboard in Datadog. You can find it on the [Dashboards][8] page of your Datadog account.
124-
Datadog Operator occasionally reconciles and keeps dashboards in line with the given configuration. There is also a force
125-
sync every hour (configurable via `DD_DASHBOARD_FORCE_SYNC_PERIOD`), so if a user deletes a dashboard in the Datadog UI, Datadog Operator restores it in under an hour.
116+
117+
By default, the Operator ensures that the API dashboard definition stays in sync with the DatadogDashboard resource every **60** minutes (per dashboard). This interval can be adjusted using the environment variable `DD_DASHBOARD_FORCE_SYNC_PERIOD`, which specifies the number of minutes. For example, setting this variable to `"30"` changes the interval to 30 minutes.
126118

127119

128120
## Cleanup

0 commit comments

Comments
 (0)