DynaKube parameters for Dynatrace Operator on Kubernetes/OpenShift

After creating the DynaKube custom resource, Dynatrace Operator deploys various components based on the configuration you chose. Review the available parameters and adapt the DynaKube custom resource according to your requirements. For some working examples, see the Dynakube samples from Github.

You can't enable more than one module (classicFullStack, cloudNativeFullStack, hostMonitoring, or applicationMonitoring).

If you want to revert an argument, you need to set it to empty instead of removing it from the custom resource.

Example:

yaml
args:
  - "--set-host-group="

Global parameters

The following parameters apply to all configuration options.

Parameter	Description	Default value	Data type
`apiUrl`	required Dynatrace apiUrl, including the `/api` path at the end. - For SaaS, set `YOUR_ENVIRONMENT_ID` to your environment ID. - For Managed, change the `apiUrl` address. For instructions on how to determine the environment ID and how to configure the apiUrl address, see Environment ID.	N/A	string
`tokens`	optional Name of the secret holding the tokens.	Name of custom resource (`.metadata.name`) if unset	string
`skipCertCheck`	optional Disable certificate check for the connection between Dynatrace Operator and the Dynatrace Cluster. Set to `true` if you want to skip certification validation checks.	`false`	boolean
`proxy`	optional Set custom proxy settings either directly or from a secret with the field `proxy`. Note: Applies to Dynatrace Operator, ActiveGate, and OneAgents.	N/A	string
`trustedCAs`	optional Adds custom RootCAs from a configmap. Put the certificate under `certs` within your configmap. Note: Applies only to Dynatrace Operator, not to ActiveGate.	N/A	string
`networkZone`	optional Sets a network zone for the OneAgent and ActiveGate pods.	N/A	string
`customPullSecret`	optional Defines a custom pull secret in case you use a private registry when pulling images from the Dynatrace environment. To define a custom pull secret and learn about the expected behavior, see Configure `customPullSecret`.	N/A	string
`enableIstio`	optional When enabled, and if Istio is installed on the Kubernetes environment, Dynatrace Operator will create the corresponding VirtualService and ServiceEntry objects to allow access to the Dynatrace Cluster from the OneAgent or ActiveGate. Disabled by default.	`false`	boolean
`namespaceSelector`	optional Applicable only for `applicationMonitoring` or `cloudNativeFullStack` configuration types. The namespaces where you want Dynatrace Operator to inject. For more information, see Configure monitoring for namespaces and pods.	N/A	LabelSelector

`classicFullStack` deployment

recommended

Has a single OneAgent per node via DaemonSet.
Injection is performed via the same OneAgent DaemonSet.

Parameter	Description	Default value	Data type
`version`	optional The OneAgent version to be used.	The latest version is used by default.	string
`image`	optional Use a custom OneAgent Docker image. Defaults to the image from the Dynatrace cluster.	Name of the image.	string
`tolerations`	optional Tolerations to include with the OneAgent DaemonSet. For details, see Taints and Tolerations.	N/A	[]Toleration
`autoUpdate`	optional Disables automatic restarts of OneAgent pods in case a new version is available. Enabled by default.	`true`	boolean
`dnsPolicy`	optional Set the DNS Policy for OneAgent pods. For details, see Pods DNS Policy.	`ClusterFirstWithHostNet`	string
`annotations`	optional Add custom OneAgent annotations.	N/A	map[string]string
`labels`	optional Your defined labels for OneAgent pods in order to structure workloads as desired.	N/A	map[string]string
`env`	optional Set additional environment variables for the OneAgent pods.	N/A	[]EnvVar
`args`	optional Set additional arguments to the OneAgent installer. For available options, see Linux custom installation. For the list of limitations, see Limitations.	N/A	[]string
`nodeSelector`	optional Specify the node selector that controls on which nodes OneAgent will be deployed.	N/A	map[string]string
`priorityClassName`	optional Assign a priority class to the OneAgent pods. By default, no class is set. For details, see Pod Priority and Preemption.	N/A	string
`oneAgentResources`	optional Resource settings for OneAgent container. Consumption of the OneAgent heavily depends on the workload to monitor. You can use the default settings in the CR. Note: `resource.requests` shows the values needed to run; `resource.limits` shows the maximum limits for the pod.	N/A	ResourceRequirements

`cloudNativeFullStack` deployment

Has a single OneAgent per node via DaemonSet.
dynatrace-webhook injects into application pods based on labeled namespaces.
Has a CSI driver per node via DaemonSet to provide binaries to pods.

Note: Using an environment ActiveGate as an apiUrl target in the DynaKube custom resource isn't yet supported. Support starts with ActiveGate version 1.237.

Parameter	Description	Default value	Data type
`image`	optional Use a custom OneAgent Docker image.	The image from the Dynatrace cluster.	string
`codeModulesImage`	optional The OneAgent image that is used to inject into Pods	N/A	string
`version`	optional The OneAgent version to be used.	The latest version is used by default.	string
`tolerations`	optional Tolerations to include with the OneAgent DaemonSet. For details, see Taints and Tolerations.	N/A	[]Toleration
`nodeSelector`	optional Specify the node selector that controls on which nodes OneAgent will be deployed.	N/A	map[string]string
`priorityClassName`	optional Assign a priority class to the OneAgent pods. By default, no class is set. For details, see Pod Priority and Preemption.	N/A	string
`oneAgentResources`	optional Resource settings for OneAgent container. Consumption of the OneAgent heavily depends on the workload to monitor. You can use the default settings in the CR. Note: `resource.requests` shows the values needed to run; `resource.limits` shows the maximum limits for the pod.	N/A	ResourceRequirements
`autoUpdate`	optional Disables automatic restarts of OneAgent pods in case a new version is available. Enabled by default.	`true`	boolean
`dnsPolicy`	optional Set the DNS Policy for OneAgent pods. For details, see Pods DNS Policy.	`ClusterFirstWithHostNet`	string
`annotations`	optional Add custom OneAgent annotations.	N/A	map[string]string
`labels`	optional Your defined labels for OneAgent pods in order to structure workloads as desired.	N/A	map[string]string
`env`	optional Set additional environment variables for the OneAgent pods.	N/A	[]EnvVar
`args`	optional Set additional arguments to the OneAgent installer. For available options, see Linux custom installation. For the list of limitations, see Limitations.	N/A	[]string
`initResources`	optional Define resources requests and limits for the initContainer. For details, see Managing resources for containers.	N/A	ResourceRequirements

`applicationMonitoring` deployment

dynatrace-webhook injects into application pods based on labeled namespaces.
Has an optional CSI driver per node via DaemonSet to provide binaries to pods.

Parameter	Description	Default value	Data type
`codeModulesImage`	optional The OneAgent image that is used to inject into Pods	N/A	string
`version`	optional The OneAgent version to be used.	The latest version is used by default.	string
`useCSIDriver`	optional Set if you want to use the CSIDriver. Don't enable it if you do not have access to Kubernetes nodes or if you lack privileges.	`false`	boolean
`initResources`	optional Define resources requests and limits for the initContainer. For details, see Managing resources for containers.	N/A	ResourceRequirements

`hostMonitoring` deployment

Has a single OneAgent per node via DaemonSet.
Doesn't inject into application pods.

Parameter	Description	Default value	Data type
`version`	optional The OneAgent version to be used.	The latest version is used by default.	string
`image`	optional Use a custom OneAgent Docker image.	The image from the Dynatrace cluster.	string
`nodeSelector`	optional Specify the node selector that controls on which nodes OneAgent will be deployed.	N/A	map[string]string
`priorityClassName`	optional Assign a priority class to the OneAgent pods. By default, no class is set. For details, see Pod Priority and Preemption.	N/A	string
`tolerations`	optional Tolerations to include with the OneAgent DaemonSet. For details, see Taints and Tolerations.	N/A	[]Toleration
`oneAgentResources`	optional Resource settings for OneAgent container. Consumption of the OneAgent heavily depends on the workload to monitor. You can use the default settings in the CR. Note: `resource.requests` shows the values needed to run; `resource.limits` shows the maximum limits for the pod.	N/A	ResourceRequirements
`autoupdate`	optional Disables automatic restarts of OneAgent pods in case a new version is available. Enabled by default.	`true`	boolean
`dnsPolicy`	optional Set the DNS Policy for OneAgent pods. For details, see Pods DNS Policy.	`ClusterFirstWithHostNet`	string
`annotations`	optional Add custom OneAgent annotations.	N/A	map[string]string
`labels`	optional Your defined labels for OneAgent pods in order to structure workloads as desired.	N/A	map[string]string
`env`	optional Set additional environment variables for the OneAgent pods.	N/A	[]EnvVar
`args`	optional Set additional arguments to the OneAgent installer. For available options, see Linux custom installation. For the list of limitations, see Limitations.	N/A	[]string

ActiveGate deployment

Offers a single pod able to perform many capabilities at once.
Can be broken into separate concerns with additional Dynakube configurations.

Parameter	Description	Default value	Data type
`capabilities`	Defines the ActiveGate pod capabilities: what functionality should be enabled. Possible values: - `routing` enables OneAgent routing. - `kubernetes-monitoring` enables Kubernetes API monitoring. - `metrics-ingest`¹ opens the metrics ingest endpoint on the DynaKube ActiveGate and redirects all pods to it. - `dynatrace-api`¹ enables calling the Dynatrace API via ActiveGate.	N/A	string
`image`	optional Use a custom ActiveGate image. Defaults to the latest ActiveGate image from the Dynatrace cluster.	N/A	string
`replicas`	optional Amount of replicas of ActiveGate pods.	N/A	int
`tolerations`	optional Set tolerations for the ActiveGate pods. For details, see Taints and Tolerations.	N/A	[]Toleration
`nodeSelector`	optional Specify the node selector that controls on which nodes ActiveGate will be deployed.	N/A	map[string]string
`resources`	optional Resource settings for ActiveGate container. Consumption of the ActiveGate heavily depends on the workload to monitor; adjust values accordingly.	N/A	ResourceRequirements
`labels`	optional Your defined labels for ActiveGate pods in order to structure workloads as desired.	N/A	map[string]string
`env`	optional Set additional environment variables for the ActiveGate pods.	N/A	[]EnvVar
`group`	optional Set activation group for ActiveGate. See Customize ActiveGate properties for details.	N/A	string
`customProperties`	optional Add a custom properties file by providing it as a value or by referencing it from a secret. Note: When referencing a custom properties file from a secret, make sure that the key is named `customProperties`. See How to add a custom properties file for details.	N/A	string
`tlsSecretName`	optional Name of a secret containing ActiveGate TLS certificate, key, and password. If not set, a self-signed certificate is used. For details, see How to add a custom certificate for ActiveGate.	N/A	string
`dnsPolicy`	optional Set the DNS policy for ActiveGate pods.	`ClusterFirstWithHostNet`	string
`priorityClassName`	optional Assign a priority class to the ActiveGate pods. By default, no class is set. For details, see Pod Priority and Preemption.	N/A	string
`annotations`	optional Add custom ActiveGate annotations.	N/A	map[string]string
`topologySpreadConstraints`	optional Adds topology spread constraints to the ActiveGate pods.	N/A	[]corev1.TopologySpreadConstraint
¹ A custom certificate is required for this capability. See the `tlsSecretName` parameter for details.

`multipleDynakubes` deployment

You can choose to which Dynatrace environment you want to send metrics from different namespaces.

Additional parameters required for Anthos, SUSE CaaS, GKE, IKS, and TKGI

classicFullStack

For Anthos, SUSE CaaS, Google Kubernetes Engine, and VMware Tanzu Kubernetes Grid Integrated Edition (formerly PKE), you must add the following additional parameters to the env section in the DynaKube custom resource file.

Note: When a read-only host file system is used with cloudNativeFullStack or hostMonitoring deployments, these additional parameters aren't needed. They are needed only if the feature is explicitly disabled. For details, see Read-only file systems.

Anthos and GKE

yaml
classicFullStack: # change to `cloudNativeFullStack` or `hostMonitoring` if needed
 env:
  - name: ONEAGENT_ENABLE_VOLUME_STORAGE
    value: "true"

TKGI

yaml
classicFullStack: # change to `cloudNativeFullStack` or `hostMonitoring` if needed
 env:
  - name: ONEAGENT_ENABLE_VOLUME_STORAGE
    value: "true"
  - name: ONEAGENT_CONTAINER_STORAGE_PATH
    value: /var/vcap/store

IKS

yaml
classicFullStack: # change to `cloudNativeFullStack` or `hostMonitoring` if needed
 env:
  - name: ONEAGENT_ENABLE_VOLUME_STORAGE
    value: "true"
  - name: ONEAGENT_CONTAINER_STORAGE_PATH
    value: /opt

SUSE CaaS

yaml
classicFullStack: # change to `cloudNativeFullStack` or `hostMonitoring` if needed
 env:
  - name: ONEAGENT_ENABLE_VOLUME_STORAGE
    value: "true"

DynaKube parameters for Dynatrace Operator on Kubernetes/OpenShift

Global parameters

classicFullStack deployment

cloudNativeFullStack deployment

applicationMonitoring deployment

hostMonitoring deployment

ActiveGate deployment

multipleDynakubes deployment

Additional parameters required for Anthos, SUSE CaaS, GKE, IKS, and TKGI

`classicFullStack` deployment

`cloudNativeFullStack` deployment

`applicationMonitoring` deployment

`hostMonitoring` deployment

`multipleDynakubes` deployment