Skip to content

Simplify public operator configuration options #2706

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

Merged
tbavelier merged 1 commit into from
Mar 6, 2026
Merged

Simplify public operator configuration options #2706

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions api/datadoghq/v2alpha1/datadogagent_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -850,6 +850,7 @@ type KubeStateMetricsCoreFeatureConfig struct {

// Conf overrides the configuration for the default Kubernetes State Metrics Core check.
// This must point to a ConfigMap containing a valid cluster check configuration.
// +doc-gen:truncate
// +optional
Conf *CustomConfig `json:"conf,omitempty"`

Expand Down Expand Up @@ -1015,6 +1016,7 @@ type OtelCollectorFeatureConfig struct {
// Conf overrides the configuration for the default Kubernetes State Metrics Core check.
// This must point to a ConfigMap containing a valid cluster check configuration.
// When passing a configmap, file name *must* be otel-config.yaml.
// +doc-gen:truncate
// +optional
Conf *CustomConfig `json:"conf,omitempty"`

Expand Down Expand Up @@ -1043,6 +1045,7 @@ type OtelAgentGatewayFeatureConfig struct {
// Conf overrides the configuration for the default OTel Agent Gateway.
// This must point to a ConfigMap containing a valid OTel collector configuration.
// When passing a configmap, file name *must* be otel-gateway-config.yaml.
// +doc-gen:truncate
// +optional
Conf *CustomConfig `json:"conf,omitempty"`

Expand Down Expand Up @@ -1419,6 +1422,7 @@ type MultiCustomConfig struct {
// +kubebuilder:object:generate=true
type KubeletConfig struct {
// Host overrides the host used to contact kubelet API (default to status.hostIP).
// +doc-gen:truncate
// +optional
Host *corev1.EnvVarSource `json:"host,omitempty"`

Expand Down Expand Up @@ -1733,6 +1737,7 @@ type GlobalConfig struct {

// Set DisableNonResourceRules to exclude NonResourceURLs from default ClusterRoles.
// Required 'true' for Google Cloud Marketplace.
// +doc-gen:exclude
// +optional
DisableNonResourceRules *bool `json:"disableNonResourceRules,omitempty"`

Expand Down Expand Up @@ -1890,6 +1895,7 @@ type SeccompConfig struct {
// CustomProfile specifies a ConfigMap containing a custom Seccomp Profile.
// ConfigMap data must either have the key `system-probe-seccomp.json` or CustomProfile.Items
// must include a corev1.KeytoPath that maps the key to the path `system-probe-seccomp.json`.
// +doc-gen:truncate
// +optional
CustomProfile *CustomConfig `json:"customProfile,omitempty"`
}
Expand Down Expand Up @@ -2004,16 +2010,19 @@ type DatadogAgentComponentOverride struct {
// CustomConfiguration allows to specify custom configuration files for `datadog.yaml`, `datadog-cluster.yaml`, `security-agent.yaml`, and `system-probe.yaml`.
// The content is merged with configuration generated by the Datadog Operator, with priority given to custom configuration.
// WARNING: It is possible to override values set in the `DatadogAgent`.
// +doc-gen:truncate
// +optional
CustomConfigurations map[AgentConfigFileName]CustomConfig `json:"customConfigurations,omitempty"`

// Confd configuration allowing to specify config files for custom checks placed under /etc/datadog-agent/conf.d/.
// See https://docs.datadoghq.com/agent/guide/agent-configuration-files/?tab=agentv6 for more details.
// +doc-gen:truncate
// +optional
ExtraConfd *MultiCustomConfig `json:"extraConfd,omitempty"`

// Checksd configuration allowing to specify custom checks placed under /etc/datadog-agent/checks.d/
// See https://docs.datadoghq.com/agent/guide/agent-configuration-files/?tab=agentv6 for more details.
// +doc-gen:truncate
// +optional
ExtraChecksd *MultiCustomConfig `json:"extraChecksd,omitempty"`

Expand Down
77 changes: 10 additions & 67 deletions docs/configuration_public.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,14 +234,8 @@ spec:
`features.kubeStateMetricsCore.collectCrMetrics`
: `CollectCrMetrics` defines custom resources for the kube-state-metrics core check to collect. The datadog agent uses the same logic as upstream `kube-state-metrics`. So is its configuration. The exact structure and existing fields of each item in this list can be found in: https://github.com/kubernetes/kube-state-metrics/blob/main/docs/metrics/extend/customresourcestate-metrics.md

`features.kubeStateMetricsCore.conf.configData`
: ConfigData corresponds to the configuration file content.

`features.kubeStateMetricsCore.conf.configMap.items`
: Maps a ConfigMap data `key` to a file `path` mount.

`features.kubeStateMetricsCore.conf.configMap.name`
: Is the name of the ConfigMap.
`features.kubeStateMetricsCore.conf`
: Overrides the configuration for the default Kubernetes State Metrics Core check. This must point to a ConfigMap containing a valid cluster check configuration.

`features.kubeStateMetricsCore.enabled`
: Enables Kube State Metrics Core. Default: true
Expand Down Expand Up @@ -324,14 +318,8 @@ spec:
`features.orchestratorExplorer.scrubContainers`
: ScrubContainers enables scrubbing of sensitive container data (passwords, tokens, etc. ). Default: true

`features.otelAgentGateway.conf.configData`
: ConfigData corresponds to the configuration file content.

`features.otelAgentGateway.conf.configMap.items`
: Maps a ConfigMap data `key` to a file `path` mount.

`features.otelAgentGateway.conf.configMap.name`
: Is the name of the ConfigMap.
`features.otelAgentGateway.conf`
: Overrides the configuration for the default OTel Agent Gateway. This must point to a ConfigMap containing a valid OTel collector configuration. When passing a configmap, file name *must* be otel-gateway-config.yaml.

`features.otelAgentGateway.enabled`
: Enables the OTel Agent Gateway. Default: false
Expand Down Expand Up @@ -441,9 +429,6 @@ spec:
`global.csi.enabled`
: Enables the usage of CSI driver in Datadog Agent. Requires installation of Datadog CSI Driver https://github.com/DataDog/helm-charts/tree/main/charts/datadog-csi-driver Default: false

`global.disableNonResourceRules`
: Set DisableNonResourceRules to exclude NonResourceURLs from default ClusterRoles. Required 'true' for Google Cloud Marketplace.

`global.dockerSocketPath`
: Path to the docker runtime socket.

Expand Down Expand Up @@ -477,38 +462,8 @@ spec:
`global.kubelet.agentCAPath`
: AgentCAPath is the container path where the kubelet CA certificate is stored. Default: '/var/run/host-kubelet-ca.crt' if hostCAPath is set, else '/var/run/secrets/kubernetes.io/serviceaccount/ca.crt'

`global.kubelet.host.configMapKeyRef.key`
: The key to select.

`global.kubelet.host.configMapKeyRef.name`
: Of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

`global.kubelet.host.configMapKeyRef.optional`
: Specify whether the ConfigMap or its key must be defined

`global.kubelet.host.fieldRef.apiVersion`
: Version of the schema the FieldPath is written in terms of, defaults to "v1".

`global.kubelet.host.fieldRef.fieldPath`
: Path of the field to select in the specified API version.

`global.kubelet.host.resourceFieldRef.containerName`
: Container name: required for volumes, optional for env vars

`global.kubelet.host.resourceFieldRef.divisor`
: Specifies the output format of the exposed resources, defaults to "1"

`global.kubelet.host.resourceFieldRef.resource`
: Required: resource to select

`global.kubelet.host.secretKeyRef.key`
: The key of the secret to select from. Must be a valid secret key.

`global.kubelet.host.secretKeyRef.name`
: Of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

`global.kubelet.host.secretKeyRef.optional`
: Specify whether the Secret or its key must be defined
`global.kubelet.host`
: Overrides the host used to contact kubelet API (default to status.hostIP).

`global.kubelet.hostCAPath`
: HostCAPath is the host path where the kubelet CA certificate is stored.
Expand Down Expand Up @@ -732,23 +687,11 @@ In the table, `spec.override.nodeAgent.image.name` and `spec.override.nodeAgent.
: _type_: `[]object`
<br /> EnvFrom specifies the ConfigMaps and Secrets to expose as environment variables. Priority is env > envFrom.

`[component].extraChecksd.configDataMap`
: ConfigDataMap corresponds to the content of the configuration files. The key should be the filename the contents get mounted to; for instance check.py or check.yaml.

`[component].extraChecksd.configMap.items`
: Items maps a ConfigMap data `key` to a file `path` mount.

`[component].extraChecksd.configMap.name`
: Name is the name of the ConfigMap.

`[component].extraConfd.configDataMap`
: ConfigDataMap corresponds to the content of the configuration files. The key should be the filename the contents get mounted to; for instance check.py or check.yaml.
`[component].extraChecksd`
: Checksd configuration allowing to specify custom checks placed under /etc/datadog-agent/checks.d/ See https://docs.datadoghq.com/agent/guide/agent-configuration-files/?tab=agentv6 for more details.

`[component].extraConfd.configMap.items`
: Items maps a ConfigMap data `key` to a file `path` mount.

`[component].extraConfd.configMap.name`
: Name is the name of the ConfigMap.
`[component].extraConfd`
: Confd configuration allowing to specify config files for custom checks placed under /etc/datadog-agent/conf.d/. See https://docs.datadoghq.com/agent/guide/agent-configuration-files/?tab=agentv6 for more details.

`[component].hostNetwork`
: Host networking requested for this pod. Use the host's network namespace.
Expand Down
Loading