Dynatrace Operator
The Dynatrace Operator supports rollout and lifecycle management of various Dynatrace components in Kubernetes and OpenShift.
OneAgent
classicFullStack rolls out a OneAgent pod per node to monitor pods on it and the node itself
applicationMonitoring is a webhook based injection mechanism for automatic app-only injection
CSI Driver can be enabled to cache OneAgent downloads per node
hostMonitoring is only monitoring the hosts (i.e. nodes) in the cluster without app-only injection
CSI Driver is used to provide a writeable volume for the Oneagent as it's running in read-only mode
cloudNativeFullStack is a combination of applicationMonitoring and hostMonitoring
CSI Driver is used for both features
ActiveGate
routing routes OneAgent traffic through the ActiveGate
kubernetes-monitoring allows monitoring of the Kubernetes API
metrics-ingest routes enriched metrics through ActiveGate
For more information please have a look at our DynaKube Custom Resource examples and our official help page.
Support lifecycle
As the Dynatrace Operator is provided by Dynatrace Incorporated, support is provided by the Dynatrace Support team, as described on the support page. Github issues will also be considered on a case-by-case basis regardless of support contracts and commercial relationships with Dynatrace.
A detailed support matrix for different versions of Kubernetes and Openshift can be found in the official technology support pages.
Quick Start
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
For install instructions on Openshift, head to the official help page
To create the namespace and apply the operator run the following commands
- ``` shell
- $ kubectl create namespace dynatrace
- $ kubectl apply -f https://github.com/Dynatrace/dynatrace-operator/releases/latest/download/kubernetes.yaml
- ```
If using cloudNativeFullStack or applicationMonitoring with CSI driver, the following command is required as well:
- ``` shell
- $ kubectl apply -f https://github.com/Dynatrace/dynatrace-operator/releases/latest/download/kubernetes-csi.yaml
- ```
A secret holding tokens for authenticating to the Dynatrace cluster needs to be created upfront. Create access tokens of type Dynatrace APIand use its values in the following commands respectively. For assistance please refer to Create user-generated access tokens.
The token scopes required by the Dynatrace Operator are documented on our official help page
- ``` shell
- $ kubectl -n dynatrace create secret generic dynakube --from-literal="apiToken=DYNATRACE_API_TOKEN" --from-literal="dataIngestToken=DATA_INGEST_TOKEN"
- ```
Create DynaKube custom resource for ActiveGate and OneAgent rollout
The rollout of the Dynatrace components is governed by a custom resource of type DynaKube. This custom resource will contain parameters for various Dynatrace capabilities (OneAgent deployment mode, ActiveGate capabilities, 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.
The recommended approach is using classic Fullstack injection to roll out Dynatrace to your cluster, available as classicFullStack sample. In case you want to have adjustments please have a look at our DynaKube Custom Resource examples.
Save one of the sample configurations, change the API url to your environment and apply it to your cluster.
- ``` shell
- $ kubectl apply -f cr.yaml
- ```
For detailed instructions see our official help page.
Uninstall dynatrace-operator
For instructions on how to uninstall the dynatrace-operator on Openshift, head to the official help page
Clean-up all Dynatrace Operator specific objects:
- ``` shell
- $ kubectl delete -f https://github.com/Dynatrace/dynatrace-operator/releases/latest/download/kubernetes.yaml
- ```
If the CSI driver was installed, the following command is required as well:
- ``` shell
- $ kubectl delete -f https://github.com/Dynatrace/dynatrace-operator/releases/latest/download/kubernetes-csi.yaml
- ```
Hacking
See HACKING for details on how to get started enhancing Dynatrace Operator.
Contributing
See CONTRIBUTING for details on submitting changes.
License
Dynatrace Operator is under Apache 2.0 license. See LICENSE for details.