This page will help you to understand and configure the Kubernetes Custom Resource "DynaKube", enabling you to optimize your Dynatrace Operator setup according to your specific requirements.
The following table lists the minimum required Dynatrace Operator versions for each DynaKube API version.
DynaKube API version
Minimum Dynatrace Operator version
v1beta2
1.2.0+
v1beta1
All versions
.spec
apiUrl parameter is required.
All other parameters are optional.
Parameter
Description
Default value
Data type
apiUrl
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.
string
tokens
Name of the secret holding the tokens.
Name of custom resource (.metadata.name) if unset
string
skipCertCheck
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
Set custom proxy settings either directly or from a secret with the field proxy. Applies to Dynatrace Operator, ActiveGate, and OneAgents.
string
trustedCAs
Adds custom RootCAs from a configmap. Put the certificate under certs within your configmap. This applies to Dynatrace Operator, OneAgent, and ActiveGate.
string
networkZone
Sets a network zone for the OneAgent and ActiveGate pods.
string
customPullSecret
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.
string
enableIstio
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
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.
LabelSelector
.spec.oneAgent
Parameter
Description
Default value
Data type
hostGroup
Specify the name of the group to which you want to assign the host. This method is preferred over the now obsolete --set-host-group argument. If both settings are used, this field takes precedence over the --set-host-group argument.
string
.spec.oneAgent.cloudNativeFullStack
All parameters are optional.
recommended
Parameter
Description
Default value
Data type
image
Use a custom OneAgent Docker image.
The image from the Dynatrace cluster.
string
codeModulesImage
The OneAgent image that is used to inject into Pods
string
version
The OneAgent version to be used for host monitoring OneAgents running in the dedicated pod. This setting doesn't affect the OneAgent version used for application monitoring.
The latest version is used by default.
string
tolerations
Tolerations to include with the OneAgent DaemonSet. For details, see Taints and Tolerations.
[]Toleration
nodeSelector
Specify the node selector that controls on which nodes OneAgent will be deployed.
map[string]string
priorityClassName
Assign a priority class to the OneAgent pods. By default, no class is set. For details, see Pod Priority and Preemption.
string
oneAgentResources
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. resource.requests shows the values needed to run; resource.limits shows the maximum limits for the pod.
ResourceRequirements
autoUpdate
Configures automatic updates of OneAgent pods. If enabled, the Dynatrace Operator will periodically check for a new version of OneAgent via Dynatrace API. If a new version is available, the Dynatrace Operator will roll it out automatically. Note: This only works if no image or version parameter is set!
true
boolean
dnsPolicy
Set the DNS Policy for OneAgent pods. For details, see Pods DNS Policy.
ClusterFirstWithHostNet
string
annotations
Add custom OneAgent annotations.
map[string]string
labels
Your defined labels for OneAgent pods in order to structure workloads as desired.
map[string]string
env
Set additional environment variables for the OneAgent pods.
[]EnvVar
args
Set additional arguments to the OneAgent installer. For available options, see Linux custom installation. For the list of limitations, see Limitations.
Use a custom OneAgent Docker image. Defaults to the image from the Dynatrace cluster.
Name of the image.
string
tolerations
Tolerations to include with the OneAgent DaemonSet. For details, see Taints and Tolerations.
[]Toleration
autoUpdate
Configures automatic updates of OneAgent pods. If enabled, the Dynatrace Operator will periodically check for a new version of OneAgent via Dynatrace API. If a new version is available, the Dynatrace Operator will roll it out automatically. Note: This only works if no image or version parameter is set!
true
boolean
dnsPolicy
Set the DNS Policy for OneAgent pods. For details, see Pods DNS Policy.
ClusterFirstWithHostNet
string
annotations
Add custom OneAgent annotations.
map[string]string
labels
Your defined labels for OneAgent pods in order to structure workloads as desired.
map[string]string
env
Set additional environment variables for the OneAgent pods.
[]EnvVar
args
Set additional arguments to the OneAgent installer. For available options, see Linux custom installation. For the list of limitations, see Limitations.
[]string
nodeSelector
Specify the node selector that controls on which nodes OneAgent will be deployed.
map[string]string
priorityClassName
Assign a priority class to the OneAgent pods. By default, no class is set. For details, see Pod Priority and Preemption.
string
oneAgentResources
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. resource.requests shows the values needed to run; resource.limits shows the maximum limits for the pod.
ResourceRequirements
.spec.oneAgent.applicationMonitoring
All parameters are optional.
Parameter
Description
Default value
Data type
codeModulesImage
The OneAgent image that is used to inject into Pods
string
version
The OneAgent version to be used.
The latest version is used by default.
string
useCSIDriver
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.
Specify the name of the group to which you want to assign the host. This method is preferred over the now obsolete --set-host-group argument. If both settings are used, this field takes precedence over the --set-host-group argument.
Specify the node selector that controls on which nodes OneAgent will be deployed.
map[string]string
priorityClassName
Assign a priority class to the OneAgent pods. By default, no class is set. For details, see Pod Priority and Preemption.
string
tolerations
Tolerations to include with the OneAgent DaemonSet. For details, see Taints and Tolerations.
[]Toleration
oneAgentResources
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. resource.requests shows the values needed to run; resource.limits shows the maximum limits for the pod.
ResourceRequirements
autoUpdate
Configures automatic updates of OneAgent pods. If enabled, the Dynatrace Operator will periodically check for a new version of OneAgent via Dynatrace API. If a new version is available, the Dynatrace Operator will roll it out automatically. Note: This only works if no image or version parameter is set!
true
boolean
dnsPolicy
Set the DNS Policy for OneAgent pods. For details, see Pods DNS Policy.
ClusterFirstWithHostNet
string
annotations
Add custom OneAgent annotations.
map[string]string
labels
Your defined labels for OneAgent pods in order to structure workloads as desired.
map[string]string
env
Set additional environment variables for the OneAgent pods.
[]EnvVar
args
Set additional arguments to the OneAgent installer. For available options, see Linux custom installation. For the list of limitations, see Limitations.
[]string
.spec.activeGate
capabilities parameter is required.
resources and group parameters are recommended.
All other parameters are optional.
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-ingest1 opens the metrics ingest endpoint on the DynaKube ActiveGate and redirects all pods to it. - dynatrace-api1 enables calling the Dynatrace API via ActiveGate.
string
image
Use a custom ActiveGate image. Defaults to the latest ActiveGate image from the Dynatrace cluster.
Add a custom properties file by providing it as a value or by referencing it from a secret. 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.
string
tlsSecretName
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.
string
dnsPolicy
Set the DNS policy for ActiveGate pods.
ClusterFirstWithHostNet
string
priorityClassName
Assign a priority class to the ActiveGate pods. By default, no class is set. For details, see Pod Priority and Preemption.
A custom certificate is required for this capability. See the tlsSecretName parameter for details.
Dynatrace Operator version 1.2.0+
.spec
apiUrl parameter is required.
All other parameters are optional.
Parameter
Description
Default value
Data type
apiUrl
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
-
string
customPullSecret
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.
-
string
dynatraceApiRequestThreshold
Minimum minutes between Dynatrace API requests.
15
integer
enableIstio
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.
-
boolean
networkZone
Sets a network zone for the OneAgent and ActiveGate pods.
-
string
proxy
Set custom proxy settings either directly or from a secret with the field proxy. Applies to Dynatrace Operator, ActiveGate, and OneAgents.
-
DynaKubeProxy
skipCertCheck
Disable certificate check for the connection between Dynatrace Operator and the Dynatrace Cluster. Set to true if you want to skip certification validation checks.
-
boolean
tokens
Name of the secret holding the tokens used for connecting to Dynatrace.
-
string
trustedCAs
Adds custom RootCAs from a configmap. The key to the data must be certs. This applies to Dynatrace Operator, OneAgent, and ActiveGate.
-
string
.spec.oneAgent
Parameter
Description
Default value
Data type
hostGroup
Specify the name of the group to which you want to assign the host. This method is preferred over the now obsolete --set-host-group argument. If both settings are used, this field takes precedence over the --set-host-group argument.
string
.spec.oneAgent.cloudNativeFullStack
All parameters are optional.
recommended
Parameter
Description
Default value
Data type
annotations
Add custom OneAgent annotations.
map[string]string
args
Set additional arguments to the OneAgent installer. For available options, see Linux custom installation. For the list of limitations, see Limitations.
[]string
autoUpdate
Configures automatic updates of OneAgent pods. If enabled, the Dynatrace Operator will periodically check for a new version of OneAgent via Dynatrace API. If a new version is available, the Dynatrace Operator will roll it out automatically. Note: This only works if no image or version parameter is set!
true
boolean
codeModulesImage
The OneAgent image that is used to inject into Pods
string
dnsPolicy
Set the DNS Policy for OneAgent pods. For details, see Pods DNS Policy.
ClusterFirstWithHostNet
string
env
Set additional environment variables for the OneAgent pods.
Specify the node selector that controls on which nodes OneAgent will be deployed.
map[string]string
oneAgentResources
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. resource.requests shows the values needed to run; resource.limits shows the maximum limits for the pod.
ResourceRequirements
priorityClassName
Assign a priority class to the OneAgent pods. By default, no class is set. For details, see Pod Priority and Preemption.
string
secCompProfile
The SecComp Profile that will be configured in order to run in secure computing mode.
-
string
tolerations
Tolerations to include with the OneAgent DaemonSet. For details, see Taints and Tolerations.
[]Toleration
version
The OneAgent version to be used for host monitoring OneAgents running in the dedicated pod. This setting doesn't affect the OneAgent version used for application monitoring.
The latest version is used by default.
string
.spec.oneAgent.classicFullStack
All parameters are optional.
Parameter
Description
Default value
Data type
annotations
Add custom OneAgent annotations.
map[string]string
args
Set additional arguments to the OneAgent installer. For available options, see Linux custom installation. For the list of limitations, see Limitations.
[]string
autoUpdate
Configures automatic updates of OneAgent pods. If enabled, the Dynatrace Operator will periodically check for a new version of OneAgent via Dynatrace API. If a new version is available, the Dynatrace Operator will roll it out automatically. Note: This only works if no image or version parameter is set!
true
boolean
dnsPolicy
Set the DNS Policy for OneAgent pods. For details, see Pods DNS Policy.
ClusterFirstWithHostNet
string
env
Set additional environment variables for the OneAgent pods.
[]EnvVar
image
Use a custom OneAgent Docker image. Defaults to the image from the Dynatrace cluster.
Name of the image.
string
labels
Your defined labels for OneAgent pods in order to structure workloads as desired.
map[string]string
nodeSelector
Specify the node selector that controls on which nodes OneAgent will be deployed.
map[string]string
oneAgentResources
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. resource.requests shows the values needed to run; resource.limits shows the maximum limits for the pod.
ResourceRequirements
priorityClassName
Assign a priority class to the OneAgent pods. By default, no class is set. For details, see Pod Priority and Preemption.
string
secCompProfile
The SecComp Profile that will be configured in order to run in secure computing mode.
-
string
tolerations
Tolerations to include with the OneAgent DaemonSet. For details, see Taints and Tolerations.
[]Toleration
version
The OneAgent version to be used.
The latest version is used by default.
string
.spec.oneAgent.applicationMonitoring
All parameters are optional.
Parameter
Description
Default value
Data type
codeModulesImage
The OneAgent image that is used to inject into Pods
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
version
The OneAgent version to be used.
The latest version is used by default.
string
.spec.oneAgent.hostMonitoring
All parameters are optional.
Parameter
Description
Default value
Data type
annotations
Add custom OneAgent annotations.
map[string]string
args
Set additional arguments to the OneAgent installer. For available options, see Linux custom installation. For the list of limitations, see Limitations.
[]string
autoUpdate
Configures automatic updates of OneAgent pods. If enabled, the Dynatrace Operator will periodically check for a new version of OneAgent via Dynatrace API. If a new version is available, the Dynatrace Operator will roll it out automatically. Note: This only works if no image or version parameter is set!
true
boolean
dnsPolicy
Set the DNS Policy for OneAgent pods. For details, see Pods DNS Policy.
ClusterFirstWithHostNet
string
env
Set additional environment variables for the OneAgent pods.
[]EnvVar
image
Use a custom OneAgent Docker image.
The image from the Dynatrace cluster.
string
labels
Your defined labels for OneAgent pods in order to structure workloads as desired.
map[string]string
nodeSelector
Specify the node selector that controls on which nodes OneAgent will be deployed.
map[string]string
oneAgentResources
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. resource.requests shows the values needed to run; resource.limits shows the maximum limits for the pod.
ResourceRequirements
priorityClassName
Assign a priority class to the OneAgent pods. By default, no class is set. For details, see Pod Priority and Preemption.
string
secCompProfile
The SecComp Profile that will be configured in order to run in secure computing mode.
-
string
tolerations
Tolerations to include with the OneAgent DaemonSet. For details, see Taints and Tolerations.
[]Toleration
version
The OneAgent version to be used.
The latest version is used by default.
string
.spec.activeGate
capabilities parameter is required.
resources and group parameters are recommended.
All other parameters are optional.
Parameter
Description
Default value
Data type
annotations
Add custom ActiveGate annotations.
map[string]string
capabilities
Defines the ActiveGate pod capabilities: what functionality should be enabled. Possible values: - routing enables OneAgent routing. - kubernetes-monitoring enables Kubernetes API monitoring. - metrics-ingest1 opens the metrics ingest endpoint on the DynaKube ActiveGate and redirects all pods to it. - dynatrace-api1 enables calling the Dynatrace API via ActiveGate.
string
customProperties
Add a custom properties file by providing it as a value or by referencing it from a secret. 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.
string
dnsPolicy
Set the DNS policy for ActiveGate pods.
ClusterFirstWithHostNet
string
env
Set additional environment variables for the ActiveGate pods.
Use a custom ActiveGate image. Defaults to the latest ActiveGate image from the Dynatrace cluster.
string
labels
Your defined labels for ActiveGate pods in order to structure workloads as desired.
map[string]string
nodeSelector
Specify the node selector that controls on which nodes ActiveGate will be deployed.
map[string]string
priorityClassName
Assign a priority class to the ActiveGate pods. By default, no class is set. For details, see Pod Priority and Preemption.
string
replicas
Amount of replicas of ActiveGate pods.
1
int
resources
Resource settings for ActiveGate container. Consumption of the ActiveGate heavily depends on the workload to monitor; adjust values accordingly.
ResourceRequirements
tlsSecretName
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.