Note: Requires Dynatrace Cluster version 1.209
The Dynatrace Operator supports rollout and lifecycle of various Dynatrace components in Kubernetes and OpenShift.
As of launch, the Dynatrace Operator can be used to deploy a containerized ActiveGate for Kubernetes API monitoring. New capabilities will be added to the Dynatrace Operator over time including metric routing, and API monitoring for AWS, Azure, GCP, and vSphere.
With v0.2.0 we added the classicFullStack functionality which allows rolling out the OneAgent to your Kubernetes cluster. Furthermore, the Dynatrace Operator is now capable of rolling out a containerized ActiveGate for routing the OneAgent traffic.
Depending on the version of the Dynatrace Operator, it supports the following platforms:
| Dynatrace Operator version | Kubernetes | OpenShift Container Platform |
|---|---|---|
| master | 1.18+ | 3.11.188+, 4.5+ |
| v0.2.1 | 1.18+ | 3.11.188+, 4.5+ |
| v0.1.0 | 1.18+ | 3.11.188+, 4.4+ |
The Dynatrace Operator acts on its separate namespace dynatrace. It holds the operator deployment and all dependent
objects like permissions, custom resources and corresponding StatefulSets.
Installation
To create the namespace and apply the operator run the following commands
$ kubectl create namespace dynatrace
$ kubectl apply -f https://github.com/Dynatrace/dynatrace-operator/releases/latest/download/kubernetes.yamlA secret holding tokens for authenticating to the Dynatrace cluster needs to be created upfront. Create access tokens of type Dynatrace API and Platform as a Service and use its values in the following commands respectively. For assistance please refere to Create user-generated access tokens.
Make sure the Dynatrace API token has the following permission:
- Access problem and event feed, metrics and topology
$ kubectl -n dynatrace create secret generic dynakube --from-literal="apiToken=DYNATRACE_API_TOKEN" --from-literal="paasToken=PLATFORM_AS_A_SERVICE_TOKEN"The rollout of Dynatrace ActiveGate is governed by a custom resource of type DynaKube. This custom resource will
contain parameters for various Dynatrace capabilities (API monitoring, routing, etc.)
Note: .spec.tokens denotes the name of the secret holding access tokens. If not specified Dynatrace Operator searches
for a secret called like the DynaKube custom resource .metadata.name.
apiVersion: dynatrace.com/v1alpha1
kind: DynaKube
metadata:
name: dynakube
namespace: dynatrace
spec:
# dynatrace api url including `/api` path at the end
# either set ENVIRONMENTID to the proper tenant id or change the apiUrl as a whole, e.q. for Managed
#
apiUrl: https://ENVIRONMENTID.live.dynatrace.com/api
# name of secret holding `apiToken` and `paasToken`
# if unset, name of custom resource is used
#
# tokens: ""
# Optional: Sets Network Zone for OneAgent and ActiveGate pods
# Should be set if you use routing to optimize connectivity
# Make sure networkZones are enabled on your cluster before (see https://www.dynatrace.com/support/help/setup-and-configuration/network-zones/network-zones-basic-info/)
#
# networkZone: name-of-my-network-zone
# Enables and configures an ActiveGate instance that allows monitoring
# of Kubernetes environments
#
kubernetesMonitoring:
enabled: true
# Enables and configures the OneAgent to automatically run on all your K8s nodes
#
classicFullStack:
enabled: true
# Enables and configures an ActiveGate instance that allows routing
# of OneAgent traffic
# Make sure you have a NetworkZone set to optimize connectivity
#
routing:
enabled: true
# To be released
#
# Enables and configures infrastructure monitoring
# Collects data such as CPU or memory usage of host nodes.
#
infraMonitoring:
# Enable infrastructure monitoring
enabled: true
# To be released
#
# Enables and configures monitoring pods by injecting oneagent init containers into them.
# Pods to be monitored must be created in previously labeled namespaces.
#
codeModules:
# Enable pod monitoring
enabled: true
This is the most basic configuration for the DynaKube object. In case you want to have adjustments please have a look at our DynaKube Custom Resource example . Save this to cr.yaml and apply it to your cluster.
$ kubectl apply -f cr.yamlTo get native Kubernetes metrics, you need to connect the Kubernetes API to Dynatrace.
- Get the Kubernetes API URL
$ kubectl config view --minify -o jsonpath='{.clusters[0].cluster.server}'- Get the bearer token
$ kubectl get secret $(kubectl get sa dynatrace-kubernetes-monitoring -o jsonpath='{.secrets[0].name}' -n dynatrace) -o jsonpath='{.data.token}' -n dynatrace | base64 --decode-
In Dynatrace, go to Settings > Cloud and virtualization > Kubernetes
-
Select Connect new cluster
-
Provide a Name, the Kubernetes API URL, and the Bearer token for the Kubernetes cluster and click 'Connect'
For detailed instructions see our official help page.
Uninstall
Remove DynaKube custom resources and clean-up all remaining Dynatrace Operator specific objects:
$ kubectl delete -n dynatrace dynakube --all
$ kubectl delete -f https://github.com/Dynatrace/dynatrace-operator/releases/latest/download/kubernetes.yamlInstallation
To create the namespace and apply the operator run the following commands
$ oc adm new-project --node-selector="" dynatrace
$ oc apply -f https://github.com/Dynatrace/dynatrace-operator/releases/latest/download/openshift.yamlA secret holding tokens for authenticating to the Dynatrace cluster needs to be created upfront. Create access tokens of type Dynatrace API and Platform as a Service and use its values in the following commands respectively. For assistance please refere to Create user-generated access tokens.
Make sure the Dynatrace API token has the following permission:
- Access problem and event feed, metrics and topology
$ oc -n dynatrace create secret generic dynakube --from-literal="apiToken=DYNATRACE_API_TOKEN" --from-literal="paasToken=PLATFORM_AS_A_SERVICE_TOKEN"The rollout of Dynatrace ActiveGate is governed by a custom resource of type DynaKube.
Note: .spec.tokens denotes the name of the secret holding access tokens. If not specified Dynatrace Operator searches
for a secret called like the DynaKube custom resource .metadata.name.
apiVersion: dynatrace.com/v1alpha1
kind: DynaKube
metadata:
name: dynakube
namespace: dynatrace
spec:
# dynatrace api url including `/api` path at the end
# either set ENVIRONMENTID to the proper tenant id or change the apiUrl as a whole, e.q. for Managed
#
apiUrl: https://ENVIRONMENTID.live.dynatrace.com/api
# name of secret holding `apiToken` and `paasToken`
# if unset, name of custom resource is used
#
# tokens: ""
# Optional: Sets Network Zone for OneAgent and ActiveGate pods
# Should be set if you use routing to optimize connectivity
# Make sure networkZones are enabled on your cluster before (see https://www.dynatrace.com/support/help/setup-and-configuration/network-zones/network-zones-basic-info/)
#
# networkZone: name-of-my-network-zone
# Enables and configures an ActiveGate instance that allows monitoring
# of Kubernetes environments
#
kubernetesMonitoring:
enabled: true
# Enables and configures the OneAgent to automatically run on all your K8s nodes
#
classicFullStack:
enabled: true
# Enables and configures an ActiveGate instance that allows routing
# of OneAgent traffic
# Make sure you have a NetworkZone set to optimize connectivity
#
routing:
enabled: true
# To be released
#
# Enables and configures infrastructure monitoring.
# Collects data such as CPU or memory usage of host nodes.
#
infraMonitoring:
# Enable infrastructure monitoring
enabled: true
# To be released
#
# Enables and configures monitoring pods by injecting oneagent init containers into them.
# Pods to be monitored must be created in previously labeled namespaces.
#
codeModules:
# Enable pod monitoring
enabled: true
This is the most basic configuration for the DynaKube object. In case you want to have adjustments please have a look at our DynaKube Custom Resource example . Save this to cr.yaml and apply it to your cluster.
$ oc apply -f cr.yamlTo get native Kubernetes metrics, you need to connect the Kubernetes API to Dynatrace.
- Get the Kubernetes API URL
$ oc config view --minify -o jsonpath='{.clusters[0].cluster.server}'- Get the bearer token
$ oc get secret $(oc get sa dynatrace-kubernetes-monitoring -o jsonpath='{.secrets[1].name}' -n dynatrace) -o jsonpath='{.data.token}' -n dynatrace | base64 --decode-
In Dynatrace, go to Settings > Cloud and virtualization > Kubernetes
-
Select Connect new cluster
-
Provide a Name, the Kubernetes API URL, and the Bearer token for the Kubernetes cluster and click 'Connect'
For detailed instructions see our official help page.
Uninstall
Remove DynaKube custom resources and clean-up all remaining Dynatrace Operator specific objects:
$ oc delete -n dynatrace dynakube --all
$ oc delete -f https://github.com/Dynatrace/dynatrace-operator/releases/latest/download/openshift.yamlSee HACKING for details on how to get started enhancing Dynatrace Operator.
See CONTRIBUTING for details on submitting changes.
Dynatrace Operator is under Apache 2.0 license. See LICENSE for details.