Install the Cluster Agent with OpenShift OperatorHub Bundle

This page describes how to install the Cluster Agent using the Splunk AppDynamics OpenShift OperatorHub Bundle which is an alternative to Install the Cluster Agent with Kubernetes CLI.

Splunk AppDynamics OpenShift OperatorHub Bundle is available at RedHat catalog.

Requirements

Before you begin, verify that you have:

• Openshift Cluster environment
• Met the requirements described in Cluster Agent Requirements and Supported Environments.

Installation Procedure

1. If you have not already installed the metrics-server, then install it. See https://github.com/kubernetes-sigs/metrics-server for the most recent installation instructions.

   kubectl apply -f https://github.com/kubernetes-sigs/metrics-server/releases/latest/download/components.yaml

   CODE

2. Download the Kubernetes or OpenShift Cluster Agent bundle from the Download portal, unzip the contents of the bundle to the current directory:

   unzip appdynamics-cluster-agent-alpine-linux-<version>.zip

   CODE

3. Create a namespace for appdynamics in your cluster.
   If you require to use a custom namespace, you can ignore this step and ensure to use the same namespace during installation. Here, we have used namespace as appdynamics.
   

   kubectl create namespace appdynamics

   CODE

4. Install the Splunk AppDynamics Operator:

   1. Go to your openshift cluster console

   2. Go to Operators > OperatorHub 

   3. Search with the appdynamics filter

   4. Click Install

5. Based on the Account Access Key for the Controller, create the Controller Access Key Secret that the Cluster Agent reports to:

   kubectl -n appdynamics create secret generic cluster-agent-secret --from-literal=controller-key=<access-key>

   CODE

6. Edit cluster-agent.yaml to set the Splunk AppDynamics Controller details for the Cluster Agent to report to.
   a. Set the nsToMonitor or nsToMonitorRegex options to include the namespaces you want to monitor.
   b. Set the image tag to the version you are installing. Refer to Cluster Agent Redhat image for the latest version tag.
   For additional configuration tasks, see Configure the Cluster Agent.

   This example assumes the use of the pre-built Cluster Agent image on RedHat Registry. See Cluster Agent Container Image to build your own image.
   

   apiVersion: cluster.appdynamics.com/v1alpha1
   kind: Clusteragent
   metadata:
     name: k8s-cluster-agent
     namespace: appdynamics
   spec:
     appName: "dev-cluster"
     controllerUrl: "http://mycontroller.com:8080"
     account: "my-account"
     # docker image info where, <version> is the image tag version that you are installing
     image: "docker.io/appdynamics/cluster-agent:<version>"
     serviceAccountName: appdynamics-cluster-agent
     nsToMonitor: [appdynamics,namespace1,namespace2]
     stdoutLogging: "true"

   YML

7. Install the Cluster Agent:

   kubectl create -f cluster-agent.yaml

   CODE

8. Check Splunk AppDynamics Operator and Splunk AppDynamics Cluster Agent pods are running. Also, Check Catalogsource, Subscription and Clusterserviceversion are created:

   # Operator pod status
   kubectl get pods -n appdynamics
   
   # CA pod status
   kubectl get pods -n appdynamics
   
   # catalogsources should be created
   kubectl get catalogsources -n appdynamics
   
   # subscriptions should be created
   kubectl get subscriptions -n appdynamics
   
   # ClusterServiceVersion should be created
   kubectl get clusterserviceversion -n appdynamics

   YML

   
   

   To uninstall, see Uninstall the Cluster Agent.

See Validate the Cluster Agent Installation to validate and troubleshoot the installation. Once the install is validated, see Container Installation Options for options to install App Server Agents in applications in the cluster.