Set up Kubernetes monitoring (deprecated)

Deploy Dynatrace Operator and enable Kubernetes API monitoring

There are two ways to configure Dynatrace Operator to monitor your Kubernetes cluster, (automated or manual. See below for instructions.

Automated

1. In the Dynatrace menu, go to Hub.
2. Find and select Kubernetes.
3. Select Monitor Kubernetes.
4. On the Monitor Kubernetes / OpenShift page, follow the on-screen deployment instructions.
   • Name: This name is used by various Dynatrace settings, including Kubernetes cluster name, Network Zone, ActiveGate Group, and Host Group
   • Platform: Kubernetes
   • PaaS token and API token: To create these tokens automatically, select Create tokens
5. Under Execute the following command in your terminal, Dynatrace creates a command based on your input in the previous steps. After you have set all of the preceding parameters, select Copy to copy the command to your clipboard.
6. Paste the command to your terminal and run it.

Manual

1. Generate an API token and a PaaS token in your Dynatrace environment.
   Note: Make sure you have the following permissions enabled for the API token in the API v1 section:

• Access problem and event feed, metrics, and topology
• Read configuration
• Write configuration

1. Create the necessary objects for Dynatrace Operator.
   Dynatrace Operator acts on its separate namespace, dynatrace. It holds the operator deployment and all dependent objects, such as permissions, custom resources, and the corresponding DaemonSet and StatefulSet. You can also observe the logs of Dynatrace Operator.

bashcopydownload
kubectl create namespace dynatrace
kubectl apply -f https://github.com/Dynatrace/dynatrace-operator/releases/download/v0.2.2/kubernetes.yaml
kubectl -n dynatrace logs -f deployment/dynatrace-operator

2. Create the secret holding API and PaaS tokens for authentication to the Dynatrace Cluster.
   The name of the secret is important in a later step when you configure the custom resource (.spec.tokens). In the following code snippet, the name is dynakube. Be sure to replace API_TOKEN and PAAS_TOKEN with the values explained in the prerequisites.

bashcopydownload
kubectl -n dynatrace create secret generic dynakube --from-literal="apiToken=API_TOKEN" --from-literal="paasToken=PAAS_TOKEN"

3. Get the DynaKube custom resource from the GitHub repository.

bashcopydownload
curl -Lo cr.yaml https://github.com/Dynatrace/dynatrace-operator/blob/release-0.2/config/samples/cr.yaml

4. Adapt the values of the custom resource as indicated below.

Example of a basic configuration:

yamlcopydownload
apiVersion: dynatrace.com/v1alpha1
kind: DynaKube
metadata:
  name: dynakube
  namespace: dynatrace
spec:
  # 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 https://www.dynatrace.com/support/help/shortlink/environment-id.
  #
  apiUrl: https://YOUR_ENVIRONMENT_ID.live.dynatrace.com/api

  # Name of the secret holding the API and PaaS tokens.
  # If unset, Dynatrace Operator uses the name of the custom resource.
  #
  # tokens: ""

  # Enables and configures an ActiveGate instance that allows monitoring
  # of Kubernetes environments.
  #
  kubernetesMonitoring:
    #   Enable Kubernetes monitoring functionality.
    #
    enabled: true
  classicFullStack:
    # Enable classic oneagent monitoring
    enabled: true
    tolerations:
      - effect: NoSchedule
        key: node-role.kubernetes.io/master
        operator: Exists

Parameters

For a complete list of parameters, see the list below.

Global parameters

ActiveGate parameters

OneAgent parameters

Classic full-stack observability parameters

Kubernetes API Monitoring parameters

Routing parameters

For a complete file with all the properties, see the custom resource file on GitHub.

yamlcopydownload
classicFullStack:
 env:
  - name: ONEAGENT_ENABLE_VOLUME_STORAGE
    value: "true"

yamlcopydownload
classicFullStack:
 env:
  - name: ONEAGENT_ENABLE_VOLUME_STORAGE
    value: "true"
  - name: ONEAGENT_CONTAINER_STORAGE_PATH
    value: /var/vcap/store

yamlcopydownload
classicFullStack:
 env:
  - name: ONEAGENT_ENABLE_VOLUME_STORAGE
    value: "true"
  - name: ONEAGENT_CONTAINER_STORAGE_PATH
    value: /opt

yamlcopydownload
classicFullStack:
 env:
  - name: ONEAGENT_ENABLE_VOLUME_STORAGE
    value: "true"

5. Apply the custom resource.

bashcopydownload
kubectl apply -f cr.yaml

Configure proxy optional

• You can configure optional parameters like proxy settings in the cr.yaml file in order to
  • Download the OneAgent installer
  • Ensure communication between the OneAgent and your Dynatrace environment
  • Ensure communication between Dynatrace Operator and the Dynatrace API.

There are two ways to provide the proxy, depending on whether your proxy uses credentials.

copydownload
apiVersion: dynatrace.com/v1alpha1
kind: DynaKube
metadata:
  name: dynakube
  namespace: dynatrace
spec:
  apiUrl: https://environmentid.live.dynatrace.com/api
  proxy:
    value: http://mysuperproxy

Connect your Kubernetes cluster to Dynatrace

Some Kubernetes pages require that your Kubernetes cluster is connected to Dynatrace. This connection creates relationships among applications, services, processes, hosts, and Kubernetes objects, such as pods and namespaces.

See Connect your Kubernetes clusters to Dynatrace for instructions on how to connect your cluster to Dynatrace.

Monitor large Kubernetes environments

Contact Dynatrace ONE if you want to monitor environments that are larger than:

• 50 Kubernetes clusters per Dynatrace environment
• 500 nodes per Kubernetes cluster
• 50,000 pods per Kubernetes cluster

Uninstall Dynatrace Operator

Remove DynaKube custom resources and clean all remaining Dynatrace Operator–specific objects.

copydownload
kubectl delete -n dynatrace dynakube --all
kubectl delete -f https://github.com/Dynatrace/dynatrace-operator/releases/latest/download/kubernetes.yaml