Set up PSA in Minikube

Warning:
  • 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, or any other Kubernetes cluster.

Set up the Web Monitoring PSA and API Monitoring PSA in Minikube as follows. If you want to set up PSA in an existing Kubernetes cluster, skip the Create the Kubernetes Cluster section.

Deploy ManuallyDeploy Using the Automation Script
  1. Create the Kubernetes Cluster
  2. Pull the Docker image
  3. Save Images to Minikube's Docker Daemon
  4. Deploy PSA Manually
  5. Monitor the Kubernetes cluster
  1. Create the Kubernetes Cluster
  2. Deploy PSA Using the Automation Script
  3. Monitor the Kubernetes cluster
Note: Most of the steps are common for both Web Monitoring PSA and API Monitoring PSA. Wherever applicable, the differences in steps are highlighted.
Note: You can deploy PSA on an existing Kubernetes cluster in public or private clouds. The automation scripts do not support Kubernetes cluster creation.

Kubernetes クラスタの作成

Minikube で Kubernetes クラスタを作成するには、次の手順を実行します。

  1. 次の手順に従って、Minikube をインストールします。
  2. クラスタを開始するには、次のように入力します。 
    minikube start --kubernetes-version=v1.x.x --cpus <number-of-cpus> --memory <amount-of-ram>
    注: Minikube は、デフォルトで Minikube のリリース時に使用可能な Kubernetes の最新バージョンをインストールします。OldestKubernetesVersionサポートされているバージョンの最新情報については、constants.go の NewestKubernetesVersion と を参照してください。
クラスタへのアクセス

Kubernetes クラスタにアクセスするには、次の手順に従って、クラスタとの対話型ユーティリティである kubectl をインストールします。

クラスタが実行されていることを確認するには、次のように入力します。

kubectl get nodes

(Optional) Configure Proxy Server

When you configure a proxy server, it applies to all the domains. Configure a proxy server by specifying the proxy server address on the values.yaml file. See Key-Value Pairs Configuration.

To bypass any domains from the proxy server, perform the following steps:

Note: Configuring the bypass list is supported only on Web Monitoring PSA.
  1. Open the values.yaml file.
  2. Add the domain URLs in the bypassList field under browserMonitoringAgent:
    browserMonitoringAgent:
enabled: true
server: "<proxy server address>"
bypassList: "<specify the domain URLs that you want to bypass separated by semicolon>"

    For example, bypassList: "*abc.com;*xyz1.com;*xyz2.com"

    Domain URLs that you specify in bypassList are not redirected to the proxy server. You can add any number of domains in the bypassList. All other unspecified domain URLs are redirected to the proxy server.

Pull the Docker Image

Pull the pre-built docker images for sum-chrome-agent, sum-api-monitoring-agent, and sum-heimdall from DockerHub. The pre-built images include the dependent libraries, so you can use these images even when you do not have access to the Internet.

Run the following commands to pull the agent images:

docker pull appdynamics/heimdall-psa
docker pull appdynamics/chrome-agent-psa
docker pull appdynamics/api-monitoring-agent-psa

(Optional) Add Custom Python Libraries

Note: 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 you just loaded as the base image
FROM appdynamics/chrome-agent-psa:<agent-tag>
USER root
RUN apk add py3-pip
USER appdynamics
# Install algorithm for python3 on top of that
RUN python3 -m pip install algorithms==0.1.4 --break-system-packages
    Note: 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
    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 the cluster to access it. Execute the following command to save the images to Minikube docker:

Web Monitoring PSA 
docker save appdynamics/heimdall-psa:<heimdall-tag> | (eval $(minikube docker-env) && docker load)
docker save appdynamics/chrome-agent-psa:<agent-tag> | (eval $(minikube docker-env) && docker load)
API Monitoring PSA: 
docker save appdynamics/heimdall-psa:<heimdall-tag> | (eval $(minikube docker-env) && docker load)
docker save appdynamics/api-monitoring-agent-psa:<agent-tag> | (eval $(minikube docker-env) && docker load)

Deploy PSA Manually

Note: 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 procedures.

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

  1. Install Helm following these instructions.
  2. Create a new namespace to run Apache Ignite pods.
    Warning: Ensure that you first run the Apache Ignite commands and then run the Heimdall commands.
    To create a new namespace for Ignite, enter:
    kubectl create namespace measurement
    Before you deploy Apache Ignite, you must set some configuration options. To view the configuration options, navigate to the previously downloaded ignite-psa.tgz file and enter: 
    helm show values ignite-psa.tgz > values-ignite.yaml
    Note: If you want to enable persistence, set persistence > enabled. This is an optional configuration.
  3. To deploy the Helm chart using the above-mentioned configuration, navigate to the previously downloaded ignite-psa.tgz file and enter:
    : 
    helm install synth ignite-psa.tgz --values values-ignite.yaml --namespace measurement
    All the Kubernetes resources are created in the cluster, and you can use Apache Ignite. After a few seconds, Apache Ignite initializes and is visible in the Controller.
  4. To verify if the pods are running, enter: 
    kubectl get pods --namespace measurement
    Proceed to the next steps only after the Apache Ignite pods run successfully. Using a single command, you can deploy the Helm chart, which contains the deployment details. To deploy the agent, 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
    Web Monitoring PSA:
    Configuration KeyValue
    heimdall > repositorysum-heimdall
    heimdall > tag<heimdall-tag>
    heimdall > pullPolicyNever
    chromeAgent > repositorysum-chrome-agent
    chromeAgent > tag<agent-tag>
    shepherd > urlShepherd URL
    shepherd > credentialscredentials
    shepherd > locationagent location
    API Monitoring PSA:
    Configuration KeyValue
    heimdall > repositorysum-heimdall
    heimdall > tag<heimdall-tag>
    heimdall > pullPolicyNever
    apiMonitoringAgent > repositorysum-api-monitoring-agent
    apiMonitoringAgent > tag<agent-tag>
    shepherd > urlShepherd URL
    shepherd > credentialscredentials
    shepherd > locationagent location
    Web Monitoring PSA and API Monitoring PSA for details on shepherd URL, credentials, location, and optional key-value pairs.
    Note: If the Kubernetes cluster is locked down, and you cannot make cluster-wide configuration, you can make pod-level changes.

    For example, if you want to change the pod-level DNS server setting to use your internal nameservers for DNS name resolution, specify the following details in the values.yaml file:

    Configuration KeyValue
    agentDNSConfig:
    enabled: true
    dnsConfig:
    nameservers:["4.4.4.4"]
    searches:["svc.cluster.local", "cluster.local"]
  5. 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
    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.
  6. To verify if the pods are running, enter:
    kubectl get pods --namespace measurement
    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
    Warning:

    To remove the deployment:

    helm uninstall heimdall-onprem --namespace measurement

    This is not recommended unless it is required.

Deploy PSA Using the Automation Script

Download the PSA installation zip file from the Splunk AppDynamics Download Center or from the beta upload tool. This file contains Docker files for sum-chrome-agent, sum-api-monitoring-agent, sum-heimdall, Helm charts, and automation scripts. To build an image for sum-chrome-agent, sum-api-monitoring-agent, and sum-heimdall, ensure that Docker is installed. You can download and install Docker from here if it is not installed.

Perform the following steps to install PSA:

  1. Unzip the PSA installation zip file.
  2. Run the following command to install PSA in Minikube: 
    ./install_psa -e minikube -l -v -u <Shepherd-URL> -a <EUM-account> -k <EUM-key> -c <location-code> -d <location-description> -t <location-name> -s <location-state> -o <location-country> -i <location-latitude> -g <location-longitude> -p <PSA-tag> -r <heimdall-replica-count> -z <agent-type> -m <chrome-agent_min/max-memory> -n <API-agent_min/max-memory> -x <chrome-agent_min/max-CPU> -y <API-agent_min/max-CPU> -b <heimdall_min/max-memory> -f <heimdall_min/max-CPU> -q <ignite-persistence> -j <ingress-and-egress-bandwidth-value-for-the-API-monitoring-pod> -w <heimdall_proxy_server>~<api_monitoring_proxy_server>~<web_monitoring_proxy_server> -B <"bypassURL1;bypassURL2;bypassURL3"> -C true
    A sample installation command looks like this: 
    ./install_psa -e minikube -l -v -u <Shepherd-URL> -a <EUM-account> -k <EUM-key> -c DEL -d Delhi -t Delhi -s DEL -o India -i 28.70 -g 77.10 -p 23.5 -r 1 -z all -m 100Mi/500Mi -n 100Mi/100Mi -x 0.5/1.5 -y 0.1/0.1 -b 2Gi/2Gi -f 2/2 -q true -j 1024k -w 127.0.0.1:8887~127.0.0.1:8888~127.0.0.1:8889 -B "*abc.com;*xyz1.com;*xyz2.com" -C true
    The following table describes the usage of the flags in the command. Asterisk (*) on the description denotes mandatory parameters.
The following table describes the usage of the flags in the command. Asterisk (*) on the description denotes mandatory parameters.
FlagDescription
-e

*Environment

For example, Docker, Minikube, or Kubernetes.

-l*Load images to the Minkube environment
-vDebug mode
-u

*Shepherd URL

For example, https://sum-shadow-master-shepherd.saas.appd-test.com/

For the list of Shepherd URLs, see Shepherd URL.

-a

*EUM Account

For example, Ati-23-2-saas-nov2

-k

*EUM Key

For example, 2d35df4f-92f0-41a8-8709-db54eff7e56c

-c

*Location Code

For example, DEL NY

-d

*Location Description

For example, 'Delhi, 100001'

-t

*Location City

For example, Delhi

-s

*Location State

For example, CA

-o

*Location Country

For example, India, United States

-i

Location Latitude

For example, 28.70

-g

Location Longitude

For example, 77.10

-p

*PSA release tag

For example, 23.12

-r*Heimdall replica count
-z

*Agent type

For example, web, api, or all

-m

*Minimum/Maximum memory in Mi/Gi for sum-chrome-agent
-n*Minimum/Maximum memory in Mi/Gi for sum-api-monitoring-agent
-x*Minimum/Maximum CPU for sum-chrome-agent
-y*Minimum/Maximum CPU for sum-api-monitoring-agent
-b*Minimum/Maximum memory in Mi/Gi for sum-heimdall
-f*Minimum/Maximum CPU for sum-heimdall
-qSpecify true or false to enable or disable Ignite Persistence.
-jIngress and egress bandwidth value for the API monitoring pod.
-w

Specify the proxy servers for Heimdall, API, and Web monitoring, separated by a tilde(~).

If you do not need to set up any proxy server, you can leave it blank.

-B

Specify the domain URLs that you want to bypass from the proxy server.

For example, "*abc.com;*xyz1.com;*xyz2.com"

-CSpecify true to enable performance logs on the Chrome browser. The default value is false.

Monitor the Kubernetes Cluster

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

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

Install the Monitoring Stack

  1. To create a separate monitoring namespace, enter: 

    kubectl create namespace monitoring
    To review configuration options, enter: 
    helm show values sum-psa-monitoring.tgz > values-monitoring.yaml
    This generates a values-monitoring.yaml file that contains all the configuration options. To modify and pass the generated values-monitoring.yaml file while installing the Helm chart, enter:
    helm install psa-monitoring sum-psa-monitoring.tgz --values values-monitoring.yaml --namespace monitoring

  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

  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, Apache Ignite, Heimdall, and running measurements.

Uninstall PSA

To uninstall PSA, run the following command:

./uninstall_psa -e -p -m

The following table describes the usage of the flags in the command.

FlagDescription
-e

Environment

For example, Docker, Minikube, or Kubernetes.

-pUninstall PSA only
-mUninstall PSA and Minikube

Upgrade PSA in Minikube

Pull the Docker Image

Pull the pre-built docker images for sum-chrome-agent, sum-api-monitoring-agent, and sum-heimdall from DockerHub. The pre-built images include the dependent libraries, so you can use these images even when you do not have access to the Internet.

Run the following commands to pull the agent images:

docker pull appdynamics/heimdall-psa
docker pull appdynamics/chrome-agent-psa
docker pull appdynamics/api-monitoring-agent-psa

Add Custom Python Libraries

This is an optional step. 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 then create RUN directives to run pythonpip. For example, to install the library algorithms you can create a Dockerfile: 
    # Use the sum-chrome-agent image you just loaded as the base image
FROM appdynamics/chrome-agent-psa:<agent-tag>
USER root
RUN apk add py3-pip
USER appdynamics
# Install algorithm for python3 on top of that
RUN python3 -m pip install algorithms==0.1.4 --break-system-packages
    Note: You can create any number of RUN directives to install the required libraries.
  2. To build the new image, enter: Web Monitoring PSA:
    docker build -t sum-chrome-agent:<agent-tag> - < Dockerfile
    The newly built agent image contains the required libraries. API Monitoring PSA:
    docker build -f Dockerfile-PSA -t sum-api-monitoring-agent:<monitoring-tag> .
    The newly built agent image contains the required libraries.

Tag and Push Images to the Registry

Note: Managed Kubernetes services, such as EKS or AKS, provide container registries where you can push your image. No other configuration is needed. Kubernetes cluster within EKS or AKS will have the access to these images.

To tag the images, enter:

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)
docker save sum-api-monitoring-agent:<agent-tag> | (eval $(minikube docker-env) && docker load)

Update the Helm Chart

Follow these values.yaml steps and update the configuration key value pairs in the values.yaml file:

Upgrade the PSA

Note: From PSA 23.12 onwards, you must deploy Ignite and Heimdall in a single namespace named measurement.
  1. Navigate to the new Linux distribution folder and run the following command:
    helm install synth ignite-psa.tgz --values values-ignite.yaml --namespace measurement
  2. Wait until the status of Ignite pods changes to running. Then, run the following command:
    helm upgrade heimdall-onprem sum-psa-heimdall.tgz --values values.yaml --namespace measurement
  3. After the status of the new Heimdall and Ignite pods changes to running, uninstall the old Ignite namespace:
    helm uninstall synth -n ignite