Set up the Web Monitoring PSA and API Monitoring PSA in Minikube

• Minikube is installed in a single machine. Hence, it is not scalable or highly available when you set up PSA in Minikube.
• Functionality-wise, there is no difference between PSA in Minikube and PSA in AKS, EKS, GKE, or any other Kubernetes cluster.

Set up the Web Monitoring PSA and API Monitoring PSA in Minikube as follows:

1. Create the Kubernetes Cluster.
2. Build and customize the Docker image.
3. Save Images to Minikube's Docker Daemon.
4. Deploy the Web Monitoring PSA and API Monitoring PSA.
5. Monitor the Kubernetes cluster.

Most of the steps are common for both Web Monitoring PSA and API Monitoring PSA. Wherever applicable, the differences in steps are highlighted.

This document contains links to Kubernetes documentation. AppDynamics makes no representation as to the accuracy of Kubernetes documentation because Kubernetes controls its own documentation.

Create the Kubernetes Cluster

To create a Kubernetes cluster in Minikube:

1. Install Minikube following these instructions.

2. To start the cluster, enter:

   minikube start --kubernetes-version=v1.x.x --cpus <number-of-cpus> --memory <amount-of-ram>

   CODE
   

   Minikube installs the latest version of Kubernetes available at the time of Minikube release by default. For the latest information on supported versions, see OldestKubernetesVersion and NewestKubernetesVersion in constants.go.

Access the Cluster

To access the Kubernetes cluster, follow these instructions to install kubectl, a utility to interact with the cluster.

To verify that the cluster is running, enter:

kubectl get nodes

Build and Customize Image

You can download the zip file for Simple Synth PSA installation from the Appdynamics Downloads Portal or from the beta upload tool.

This file contains Dockerfiles to install the agents and set up monitoring:

• Web Monitoring PSA: Dockerfiles for sum-chrome-agent, sum-heimdall, and Helm charts
• API Monitoring PSA: Dockerfiles for synth-api-monitoring-agent, sum-heimdall, and Helm charts

To build an image for sum-chrome-agent, synth-api-monitoring-agent, and sum-heimdall, ensure that Docker is installed. If it is not installed, you can download and install Docker from here. 

For sum-chrome-agent:

1.  Unzip the zip file to access the sum-chrome-agent directory.

2. Navigate to the directory and run the following command: 

   docker build -f Dockerfile-PSA -t sum-chrome-agent:<agent-tag> .

   CODE

For synth-api-monitoring-agent:

1. Unzip the zip file to access the synth-api-monitoring-agent directory.

2. Navigate to the directory and run the following command: 

   docker build -f Dockerfile-PSA -t synth-api-monitoring-agent:<agent-tag> .

   CODE

For sum-heimdall:

1. Unzip the zip file to access the sum-heimdall directory. 

2. Navigate to this directory and run the following command: 

   docker build -f Dockerfile-PSA -t sum-heimdall:<heimdall-tag> .

   CODE

You can use any value for <heimdall-tag> and <agent-tag>, but ensure that you use the same value in the subsequent steps.

Add Custom Python Libraries 

This section is applicable only for Web Monitoring PSA.

In addition to the available standard set of libraries, you can add custom Python libraries to the agent to use in scripted measurements. You build a new image based on the image you loaded as the base image.

1. Create a Dockerfile and create RUN directives to run python pip. For example, to install the library algorithms you can create a Dockerfile: 

   # Use the sum-chrome-agent image we just loaded as the base image
   FROM sum-chrome-agent:<agent-tag>
     
   # Install algorithm for python3 on top of that
   RUN python3 -m pip install algorithms==0.1.4
     
     
   # We can add more RUN directives for installing more libraries
   # RUN python3 -m pip install ...

   CODE
   

   You can create any number of RUN directives to install the required libraries.

2. To build the new image, enter: 

   docker build -t sum-chrome-agent:<agent-tag> - < Dockerfile

   CODE

   The newly built agent image contains the required libraries. 

Save Images to Minikube's Docker Daemon 

You must tag and push the images to a registry for cluster to access it. Execute the following command to save the images to Minikube docker:

Web Monitoring PSA:

docker save sum-heimdall:<heimdall-tag> | (eval $(minikube docker-env) && docker load)
docker save sum-chrome-agent:<agent-tag> | (eval $(minikube docker-env) && docker load)

API Monitoring PSA:

docker save sum-heimdall:<heimdall-tag> | (eval $(minikube docker-env) && docker load)
docker save synth-api-monitoring-agent:<agent-tag> | (eval $(minikube docker-env) && docker load)

Deploy the Web Monitoring PSA and API Monitoring PSA

Ensure that you follow the applicable sequence of steps when installing Web Monitoring PSA and API Monitoring PSA, respectively; some steps are common for both the procedures.

The application is deployed to the cluster after the images are in the Registry. You use Helm chart to deploy and create all Kubernetes resources in the required order. 

1. Install Helm following these instructions.

2. Create a new measurement namespace where Heimdall, Postgres database, and measurement pods will run.

   To create a new measurement namespace, enter: 

   kubectl create namespace measurement

   CODE

   Using a single command, you can deploy the Helm chart which contains the deployment details. To deploy the agent, you use the Helm chart sum-psa-heimdall.tgz in the zip file that you downloaded previously. Before you deploy the Private Synthetic Agent, you must set some configuration options. To view the configuration options, navigate to the previously downloaded sum-psa-heimdall.tgz file and enter: 

   helm show values sum-psa-heimdall.tgz > values.yaml

   CODE

   These are the configuration key value pairs that you need to edit in the values.yaml file:
   

   Web Monitoring PSA:

   Configuration Key	Value
   heimdall > repository	sum-heimdall
   heimdall > tag	<heimdall-tag>
   heimdall > pullPolicy	Never
   chromeAgent > repository	sum-chrome-agent
   chromeAgent > tag	<agent-tag>
   shepherd > url	Shepherd URL
   shepherd > credentials	credentials
   shepherd > location	agent location

   
   

   API Monitoring PSA:

   Configuration Key	Value
   heimdall > repository	sum-heimdall
   heimdall > tag	<heimdall-tag>
   heimdall > pullPolicy	Never
   apiMonitoringAgent > repository	synth-api-monitoring-agent
   apiMonitoringAgent > tag	<agent-tag>
   shepherd > url	Shepherd URL
   shepherd > credentials	credentials
   shepherd > location	agent location

   
   

   You can leave the rest of the values set to their defaults or configure them based on your requirements. See Configure Web Monitoring PSA and API Monitoring PSA for details on shepherd URL, credentials, location, and optional key-value pairs.

3. To deploy the Helm chart using the above-mentioned configuration, navigate to the previously downloaded sum-psa-heimdall.tgz file and enter: 

   helm install heimdall-onprem sum-psa-heimdall.tgz --values values.yaml --namespace measurement

   CODE

   All the Kubernetes resources are created in the cluster and you can use Heimdall. After a few seconds, Heimdall initializes and is visible in the Controller.

4. To verify if the pods are running, enter: 

   kubectl get pods --namespace measurement

   CODE

   To make any changes to the values.yaml after the initial deployment, navigate to the previously downloaded sum-psa-heimdall.tgz file and enter: 

   helm upgrade heimdall-onprem sum-psa-heimdall.tgz --values values.yaml --namespace measurement

   CODE
   

   To remove the deployment:

   helm uninstall heimdall-onprem --namespace measurement

   CODE

   This is not recommended unless it required.

Monitor the Kubernetes Cluster

The Helm chart sum-psa-monitoring.tgz in the zip you downloaded installs the monitoring stack. This Helm chart installs kube-prometheus-stack along with a custom Grafana dashboard to monitor the Private Simple Synthetic Agent.

Monitoring the deployment is optional; however, we highly recommended that you monitor the cluster to periodically check its health.  

Install the Monitoring Stack

1. To create a separate monitoring namespace, enter:  

   kubectl create namespace monitoring

   CODE

   To review configuration options, enter: 

   helm show values sum-psa-monitoring.tgz > values.yaml

   CODE

   This generates a values.yaml file which contains all the configuration options. To modify and pass the generated values.yaml file while installing the Helm chart, enter:

   helm install psa-monitoring sum-psa-monitoring.tgz --values values.yaml --namespace monitoring

   CODE

2. After the monitoring stack is installed, you can Launch Grafana (which runs inside the cluster) to view the dashboard. To access Grafana from outside of the cluster, you can configure port forwarding or set up Ingress. To configure port forward to access it locally, enter:

   kubectl port-forward svc/psa-monitoring-grafana 3000:80 --namespace monitoring

   CODE

3. Launch localhost:3000 from the browser and  log in using the default credentials with username as admin and password as prom-operator. A dashboard named Private Simple Synthetic Agent displays and provides details about the Kubernetes cluster, Heimdall, Postgres, and running measurements.