Download PDF
Download page Set up PSA in Docker Engine.
Set up PSA in Docker Engine
You can set up PSA in the Docker engine using the automation script, which is available with the installation zip file. When you run the installation command, the script automatically builds the docker image and deploys PSA.
Supported Operating System
- Linux (CentOS and Ubuntu)
- macOS with Intel or M1 processor
Windows
Installing PSA using the automated script is not supported on Windows. To install PSA on Windows, see Deploy PSA Manually.
Proxy server configuration is not supported in the Docker engine.
The following table illustrates the differences between installing PSA in Kubernetes and Docker:
Kubernetes | Docker |
---|---|
Heimdall and Ignite are deployed as pods on the existing Kubernetes cluster through Helm Charts. | Heimdall and Ignite are deployed as containers. |
Heimdall creates Web Monitoring and API Monitoring measurement job pods through Kube APIs. | Heimdall creates Web Monitoring and API Monitoring measurement job containers through Docker APIs. |
When the measurement is ready, Heimdall deletes the job pods through the Kube APIs. | When the measurement is ready, Heimdall deletes the job containers through the Docker APIs. |
Download the PSA Installation Files
Download the PSA installation zip file from the Appdynamics Downloads Portal 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.
Deploy PSA in Docker
- Unzip the PSA installation zip file.
Run the following command to install PSA in a Docker engine:
./install_psa -e docker -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>
CODEA sample installation command looks like this:
./install_psa -e docker -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
CODE
The following table describes the usage of the flags in the command. Asterisk (*) on the description denotes mandatory parameters.
Flag | Description |
---|---|
-e | *Environment For example, Docker, Minikube, or Kubernetes. |
-v | Debug mode |
-u | *Shepherd URL For example, https://sum-shadow-master-shepherd.saas.appd-test.com/ See Shepherd URL. |
-a | *EUM Account For example, a |
-k | *EUM Key For example, |
-c | *Location Code For example, |
-d | *Location Description For example, |
-t | *Location City For example, Delhi |
-s | *Location State For example, |
-o | *Location Country For example, India, United States |
-i | Location Latitude For example, |
-g | Location Longitude For example, |
-p | *PSA release tag For example, |
-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 |
Monitor PSA
To monitor the CPU and memory usage of the Heimdall and Ignite containers, run the following command:
./monitoring_psa
Deploy PSA Manually
Perform the following steps:
Navigate to the
sum-chrome-agent
directory and run the following command:docker build -f Dockerfile-PSA -t sum-chrome-agent:<agent-tag> .
CODENavigate to the
sum-api-monitoring-agent
directory and run the following command:docker build -f Dockerfile-PSA -t sum-api-monitoring-agent:<agent-tag> .
CODENavigate to the
sum-heimdall
directory and copy the docker file:cp ./docker-PSA/Dockerfile-PSA
CODEBuild the Heimdall image:
docker build -f Dockerfile-PSA -t sum-heimdall:<heimdall-tag> .
CODE- Navigate to
./docker-psa/appdynamics
and update the following details in theonprem.yaml
file:- Shepherd URL
- EUM credentials
- Registration location
- Agent tag
These are the configuration key-value pairs that you need to edit in the
onprem
.yaml
file:Web Monitoring PSA:
Configuration Key
Value
chromeAgent > image
<agent-tag>
shepherd > url
Shepherd URL
shepherd > credentials
credentials
shepherd > location
agent location
API Monitoring PSA:
Configuration Key
Value
apiMonitoringAgent > image
<agent-tag>
shepherd > url
Shepherd URL
shepherd > credentials
credentials
shepherd > location
agent location
Navigate to
./docker-psa
and update the Heimdall tag in thedocker-compose.yaml
file.Configuration Key
Value
heimdall > image
<heimdall-tag>
Perform Docker compose:
docker-compose up -d
CODE
Upgrade PSA
Perform the following steps to upgrade PSA:
Download and unzip the PSA installation zip file.
The upgrade_psa -h command displays the parameters that you can specify.
Run the following command:
./upgrade_psa -d -v <PSA-release-tag>
CODE
The following table describes the usage of the flags in the command. The asterisk (*) on the description denotes a mandatory parameter.
Flag | Description |
---|---|
-d | Debug mode |
-v | *PSA release tag. This is the version to which you are upgrading. For example, 23.9.0. |
Uninstall PSA
To uninstall PSA, run the following commands:
Operating System | Command |
---|---|
Linux and macOS |
CODE
|
Windows |
|