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 (RHEL >=8, Amazon Linux, CentOS and Ubuntu)
  • macOS with Intel processor  
  • Windows

    Installing PSA using the automated script is not supported on Windows. To install PSA on Windows, see Deploy PSA Manually.

The following table illustrates the differences between installing PSA in Kubernetes and Docker:

KubernetesDocker

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 Cisco 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.

(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 application-onprem.yaml file. See Key-Value Pairs Configuration.

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

  1. Open the application-onprem.yaml file.

  2. Add the domain URLs in the noProxy field under proxyConfig:

    proxyConfig:
      apiMonitoringAgent:
        enabled: true
        proxyServer: <proxy-server-address>
      browserMonitoringAgent:
        enabled: true
        proxyServer: <proxy-server-address>
      heimdall:
        enabled: true
        proxyServer: <proxy-server-address>
      noProxy:
        enabled: true
        proxyServer: "<specify the domain URLs that you want to bypass separated by comma>" 
    CODE

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

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

Deploy PSA in Docker 

  1. Unzip the PSA installation zip file.
  2. 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> -w <heimdall_proxy_server>~<web_monitoring_proxy_server>~<api_monitoring_proxy_server> -B <bypass-proxy-domains>
    CODE

    A 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 -w http://testproxy-heimdall.net:3213~http://testproxy-chrome.net:3213~http://testproxy-api.net:3213 -B "www.test.com,*.appdynamics.com"
    CODE

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.

-vDebug mode
-u

*Shepherd URL

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

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 for Delhi, NY for New York

-d

*Location Description

For example, 'Delhi, 100001'

-t

*Location City

For example, Delhi

-s

*Location State

For example, CA for California

-o

*Location Country

For example, India, United States

-i

Location Latitude

For example, 28.70 for Delhi

-g

Location Longitude

For example, 77.10 for Delhi

-p

*PSA release tag

For example, 23.5

-rHeimdall 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 
-w

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

-B

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

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

Monitor PSA

To monitor the CPU and memory usage of the Heimdall and Ignite containers, run the following command:

./monitoring_psa
CODE

Deploy PSA Manually

Perform the following steps:

  1. Pull the agent docker images:

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

     

  2. Navigate to ./docker-psa/appdynamics and update the following details in the onprem.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 > urlShepherd URL
      shepherd > credentialscredentials
      shepherd > locationagent location
      proxyConfig > enabled

      true

      Specify this field only if you are using the proxy server. Make the same change for Heimdall.

      proxyConfig > proxyServerProxy server URL

      API Monitoring PSA:

      Configuration Key

      Value

      apiMonitoringAgent > image<agent-tag>
      shepherd > urlShepherd URL
      shepherd > credentialscredentials
      shepherd > locationagent location
      proxyConfig > enabled

      true

      Specify this field only if you are using the proxy server. Make the same change for Heimdall.

      proxyConfig > proxyServerProxy server URL
  3. Navigate to ./docker-psa and update the Heimdall tag in the docker-compose.yaml file.

    Configuration Key

    Value

    heimdall > image<heimdall-tag>
  4. Perform Docker compose:

    docker-compose up -d
    CODE

Upgrade PSA

Perform the following steps to upgrade PSA: 

  1. Download and unzip the PSA installation zip file.

    The upgrade_psa -h command displays the parameters that you can specify.

  2. 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.

FlagDescription
-dDebug 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 SystemCommand
Linux and macOS
./uninstall_psa -e docker -p 
CODE
Windows
  1. docker ps -a
    CODE
  2. docker rm <heimdall-containerID>
    docker rm <ignite-containerID>
    CODE