Download PDF
Download page Set up PSA in Azure AKS.
Set up PSA in Azure AKS
Set up the Web Monitoring PSA and API Monitoring PSA in Azure AKS as follows. If you want to set up PSA in an existing Kubernetes cluster, skip the Create the Kubernetes Cluster section.
This document contains links to Azure CLI documentation. AppDynamics makes no representation as to the accuracy of Azure CLI documentation because Azure CLI controls its own documentation.
You can deploy PSA on an existing Kubernetes cluster in public or private clouds. The automation scripts do not support Kubernetes cluster creation.
- If you use the automated script, you must manually set up the Kubernetes cluster and nodes and log in to container registries before deploying PSA.
- If you use a separate registry, specify the registry in the automated script before deploying PSA:
Open the
install_psa
file and go to thepush_images_to_docker_registry()
function.- Under that function, after ${DOCKER_REGISTRY_URL}/, specify the registry names of
sum-chrome-agent
,sum-api-monitoring-agent,
andsum-heimdall.
Under the
generate_psa_k8s_deployment()
function, update the repository names on the YAML values.
- You must build the images on the host with the same OS type of Kubernetes cluster nodes.
Create the Kubernetes Cluster
To create a Kubernetes cluster in Azure AKS:
Install and authenticate Azure CLI.
To create a resource group, enter
RESOURCE_GROUP=heimdall-onprem az group create --name $RESOURCE_GROUP --location eastus
CODETo create a container registry, enter:
ACR_NAME=heimdallonprem az acr create --resource-group $RESOURCE_GROUP --name $ACR_NAME --sku Basic
CODETo create a cluster, enter:
CLUSTER_NAME=heimdall-onprem az aks create \ --resource-group $RESOURCE_GROUP \ --name $CLUSTER_NAME \ --enable-managed-identity \ --kubernetes-version 1.x.x \ --node-count 4 \ --node-vm-size Standard_D8s_v3 \ --generate-ssh-keys \ --attach-acr $ACR_NAME
CODEReplace the
kubernetes-version
in the above code with one of the supported versions. See Supported Kubernetes versions.The
node-vm-size
andnode-count
in the above code are selected according to the recommended configuration type. You can specify a configuration of your choice with a different type and number of nodes. See node-vm-size.You must be the owner or administrator of the Azure subscription to run the
--attach-acr
command.
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
(Optional) Configure Proxy Server
Configuring a proxy server is supported only on Web Monitoring PSA.
When you configure a proxy server, it applies to all the domains. To configure a proxy server only for certain domains, perform the following steps:
- Navigate to the
sum-chrome-agent/agent
directory. - Open the
chrome.py
file. Navigate to the following string:
if self._proxy_server: chrome_options.add_argument('--proxy-server={}'.format(self._proxy_server))
CODEAppend the following details:
bypass_list = ["*abc.com", "*xyz1.com", "*xyz2.com"] chrome_options.add_argument('--proxy-bypass-list=%s' % ";".join(bypass_list))
CODEDomain URLs that you specify in
bypass_list
are not redirected to the proxy server. You can add any number of domains in thebypass_list
. All other unspecified domain URLs are redirected to the proxy server.Specify the proxy server address on the
values.yaml
file. See Key-Value Pairs Configuration.If you make any changes to the
bypass_list
after building the docker image, you must rebuild the docker image.
Deploy PSA in AKS
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.
Perform the following steps to install PSA:
- Unzip the PSA installation zip file.
Run the following command to install PSA in AKS:
./install_psa -e kubernetes -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>
CODEA sample installation command looks like this:
./install_psa -e kubernetes -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
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. |
-l | Load images to the Minkube environment |
-v | Debug mode |
-u | *Shepherd URL For example, |
-a | *EUM Account For example, |
-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 |
-q | Specify true or false to enable or disable Ignite Persistence. |
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 recommend that you monitor the cluster to check its health periodically.
Install the Monitoring Stack
To create a separate
monitoring
namespace, enter:kubectl create namespace monitoring
CODETo review configuration options, enter:
helm show values sum-psa-monitoring.tgz > values-monitoring.yaml
CODEThis 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
CODEAfter 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
CODELaunch localhost:3000 from the browser and log in using the default credentials with username as
admin
and password asprom-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 kubernetes -p