Set up PSA in Amazon EKS

Set up the Web Monitoring PSA and API Monitoring PSA in Amazon Elastic Kubernetes Service (Amazon EKS) as follows. If you want to set up PSA in an existing Kubernetes cluster, skip the Create the Kubernetes Cluster section.

Deploy Manually Deploy Using the Automation Script
  1. Create the Kubernetes Cluster.
  2. Pull the Docker image
  3. Tag and push images to the Registry
  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
Warning: This document contains links to AWS CLI documentation. Splunk AppDynamics \ makes no representation as to the accuracy of AWS CLI documentation because AWS CLI controls its own documentation.
Note: You can deploy PSA on an existing Kubernetes cluster in public or private clouds. The automation scripts do not support Kubernetes cluster creation.
Note:
  • 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:

    1. Open the install_psa file and go to the push_images_to_docker_registry() function.

    2. Under that function, after ${DOCKER_REGISTRY_URL}/, specify the registry names of sum-chrome-agent, sum-api-monitoring-agent, and sum-heimdall.

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

Kubernetes クラスタの作成

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

  1. AWS CLI をインストールして設定します。
  2. プラットフォームに応じて、インストール手順に従って https://eksctl.io/installation/ をインストールします。
  3. Kubernetes クラスタを作成するには、次のように入力します。
    CODE 
    EKSCTL_CLUSTER_NAME=eks-heimdall-onprem-cluster
EKSCTL_NODEGROUP_NAME=eks-heimdall-onprem-worker-nodes
EKSCTL_KUBERNETES_VERSION=1.x.x
eksctl create cluster \
--name ${EKSCTL_CLUSTER_NAME} \
--version ${EKSCTL_KUBERNETES_VERSION} \
--region us-west-2 \
--zones us-west-2a,us-west-2b,us-west-2c \
--nodegroup-name ${EKSCTL_NODEGROUP_NAME} \
--node-type t3.2xlarge \
--nodes 4 \
--nodes-min 2 \
--nodes-max 6 \
--ssh-access \
--ssh-public-key ~/.ssh/id_rsa.pub \
--managed \
--vpc-nat-mode Disable
    注: EKSCTL_KUBERNETES_VERSION を次のいずれかのバージョンに置き換えます。

    EKS Kubernetes バージョン

    .
    注: コードスニペットの node-type、nodes、nodes-min、および nodes-max は、推奨される設定タイプに基づいて選択されます。異なるタイプとノード数で、任意の設定を指定できます。サポートされている SFP および SFP+ モジュールのリストについては、

    EC2 インスタンスタイプ

    .

クラスタへのアクセス

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

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

CODE 
kubectl get nodes

（オプション）プロキシサーバーの設定

プロキシサーバーを設定すると、すべてのドメインに適用されます。values.yaml ファイルにプロキシサーバーアドレスを指定して、プロキシサーバーを設定します。「キーと値のペアの設定」を参照してください。

プロキシサーバーからドメインをバイパスするには、次の手順を実行します。

注: バイパスリストの設定は、Web モニタリング PSA でのみサポートされています。
  1. values.yaml を開きます。
  2. bypassList browserMonitoringAgent にドメイン URL を追加します。
    CODE 
    browserMonitoringAgent:
enabled: true
server: "<proxy server address>"
bypassList: "<specify the domain URLs that you want to bypass separated by semicolon>"

    たとえば、 bypassList: "*abc.com;*xyz1.com;*xyz2.com" bypassList で指定するドメイン URL はプロキシサーバーにリダイレクトされません。bypassList に任意の数のドメインを追加できます。他のすべての指定されていないドメイン URL は、プロキシサーバーにリダイレクトされます。

Docker イメージのプル

DockerHub から sum-chrome-agent、sum-api-monitoring-agent、sum- heimdall の既成の Docker イメージをプルします。既成イメージには依存ライブラリが含まれているため、インターネットにアクセスできない場合でもこれらのイメージを使用できます。

次のコマンドを実行して、エージェントイメージをプルします。

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

（オプション）カスタム Python ライブラリの追加

使用可能な標準ライブラリセットに加えて、スクリプト測定で使用するカスタム Python ライブラリをエージェントに追加できます。ベースイメージとしてロードしたイメージに基づいて新しいイメージをビルドします。

注: DockerHub リポジトリから既成のイメージを使用している場合、これらの手順は必要ありません。
  1. Dockerfile を作成してから、python pip を実行する RUN ディレクティブを作成します。たとえば、algorithms ライブラリをインストールするには、次のように Dockerfile を作成します。
    CODE 
    # 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
    注: 任意の数の ディレクティブを作成して、必要なライブラリをインストールできます。
  2. 新しいイメージをビルドするには、次のように入力します。
    CODE 
    docker build -t sum-chrome-agent:<agent-tag> - < Dockerfile
    新しくビルドされたエージェントイメージには、必要なライブラリが含まれています。

Tag and Push Images to the Registry

You must tag and push the images to a registry for the cluster to access it. The Amazon EKS clusters pull the images from Elastic Container Registry (ECR), which is the managed registry provided by AWS.

Tag the Images

CODE 
docker tag appdynamics/heimdall-psa:<heimdall-tag> <aws_account_id>.dkr.ecr.<region>.amazonaws.com/sum/sum-heimdall:<heimdall-tag>
docker tag appdynamics/chrome-agent-psa:<agent-tag> <aws_account_id>.dkr.ecr.<region>.amazonaws.com/sum/sum-chrome-agent:<agent-tag>
docker tag appdynamics/api-monitoring-agent-psa:<agent-tag> <aws_account_id>.dkr.ecr.<region>.amazonaws.com/sum/sum-api-monitoring-agent:<agent-tag>

You need to replace <aws_account_id> & <region> with your account id and region values.

To create repositories, enter:

CODE 
aws ecr create-repository --repository-name sum/sum-heimdall
aws ecr create-repository --repository-name sum/sum-chrome-agent
aws ecr create-repository --repository-name sum/sum-api-monitoring-agent

Push the Images

CODE 
aws ecr get-login-password --region us-west-2 | docker login --username AWS --password-stdin <aws_account_id>.dkr.ecr.<region>.amazonaws.com
docker push <aws_account_id>.dkr.ecr.<region>.amazonaws.com/sum/sum-heimdall:<heimdall-tag>
docker push <aws_account_id>.dkr.ecr.<region>.amazonaws.com/sum/sum-chrome-agent:<agent-tag>
docker push <aws_account_id>.dkr.ecr.<region>.amazonaws.com/sum/sum-api-monitoring-agent:<agent-tag>

Deploy PSA Manually

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 the 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:

    CODE 
    kubectl create namespace measurement

    Beforeyou 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:

    CODE 
    helm show values ignite-psa.tgz > values-ignite.yaml
  3. (Optional) Enable Amazon Elastic File System (Amazon EFS) for Apache Ignite.Open the values-ignite.yaml file and update the following details under persistence:
    CODE 
    persistence:
# To turn on persistence, kindly set enabled to true. Do not modify onPremMode value
enabled: true
onPremMode: true
enableEfs: false  # Set to true if you are using efs
persistenceVolume:
size: 8Gi
provisioner: efs.csi.aws.com # Replace with your provisioner value
provisionerParameters:
type: efs # Specify that it's for Amazon EFS
fileSystemId: fs-01285427ea904c120  # Replace with your EFS file system ID
provisioningMode: efs-ap # Replace with your provisioner mode
walVolume:
size: 8Gi
provisioner: efs.csi.aws.com # Replace with your provisioner value
provisionerParameters:
type: efs  # Specify that it's for Amazon EFS
fileSystemId: fs-01285427ea904c120  # Replace with your EFS file system ID
provisioningMode: efs-ap # Replace with your provisioner mode
enableHostPath: false  # Set to true if you are using hostpath
hostPath:
persistenceMount: /mnt/ignite/persistence
walMount: /mnt/ignite/wal
    Note: After deploying the Helm chart, you can run the following command to verify if the Persistent Volume (PV) and Persistent Volume Claim (PVC) are running:
    CODE 
    kubectl get pv -n measurement
kubectl get pvc -n measurement
    When the status of PV and PVC changes to Bound, it indicates that the Amazon EFS configuration is complete.
    Note: To enable Amazon EFS for Heimdall, update the configuration in the values.yaml file.
  4. To deploy the Helm chart using the above-mentioned configuration, navigate to the previously downloaded ignite-psa.tgz file and enter:
    CODE 
    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.
  5. To verify if the pods are running, enter:
    CODE 
    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:

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

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

    Configuration Key Value
    heimdall > repository <aws_account_id>.dkr.ecr.<region>.amazonaws.com/sum/sum-heimdall
    heimdall > tag <heimdall-tag>
    heimdall > pullPolicy Always
    chromeAgent > repository <aws_account_id>.dkr.ecr.<region>.amazonaws.com/sum/sum-chrome-agent
    chromeAgent > tag <agent-tag>
    shepherd > url Shepherd URL
    shepherd > credentials credentials
    shepherd > location agent location
    persistence

    (Optional) Specify the following details if you want to enable Amazon EFS for Heimdall:

    CODE 
    # To turn on persistence, kindly set enabled to true
persistence:
enabled: false
storageClass:
provisioner: efs.csi.aws.com # Specify that it's for Amazon EFS
parameters:
type: efs  # Specify that it's for Amazon EFS
fileSystemId: fs-01285427ea904c120   # Replace with your EFS file system ID
provisioningMode: efs-ap  # Replace with your provisioner mode
    Note: After deploying the Helm chart, you can run the following command to verify if the PV and PVC are running:
    CODE 
    kubectl get pv -n measurement
kubectl get pvc -n measurement
    When the status of PV and PVC changes to Bound, it indicates that the Amazon EFS configuration is complete.

    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.

    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 Key Value
    agentDNSConfig:
    enabled: true
    dnsConfig:
    nameservers: ["4.4.4.4"]
    searches: ["svc.cluster.local", "cluster.local"]
  6. To deploy the Helm chart using the above-mentioned configuration, navigate to the previously downloaded sum-psa-heimdall.tgz file and enter:
    CODE 
    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.

  7. To verify if the pods are running, enter:
    CODE 
    kubectl get pods --namespace measurement

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

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

    To remove the deployment:

    CODE 
    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 EKS:A sample installation command looks like this:
    CODE 
    ./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> -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:

    CODE 
    ./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 -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.
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, 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
-q Specify true or false to enable or disable Ignite Persistence.
-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"
-C Specify true to enable performance logs on the Chrome browser. The default value is false.

Kubernetes クラスタのモニタリング

ダウンロードした zip 内の Helm チャート により、モニタリングスタックがインストールされます。この Helm チャートは、Private Simple Synthetic Agent をモニタするためのカスタム Grafana ダッシュボードとともに kube-prometheus-stack をインストールします。

注: この展開のモニタリングはオプションです。ただし、クラスタをモニターして正常性を定期的に確認することを強く推奨します。

モニタリングスタックのインストール

  1. 別のモニタリング名前空間を作成するには、以下のように入力します。
    CODE 
    kubectl create namespace monitoring

    設定オプションを確認するには、次のように入力します。

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

    これにより、すべての設定オプションを含む values-monitoring ファイルが生成されます。Helm チャートのインストール中に生成された values-monitoring ファイルを変更して渡すには、次のように入力します。

    CODE 
    helm install psa-monitoring sum-psa-monitoring.tgz --values values-monitoring.yaml --namespace monitoring
  2. モニタリングスタックをインストールした後、（クラスタ内で実行される）Grafana を起動してダッシュボードを表示できます。クラスタの外部から Grafana にアクセスするには、ポートフォワーディングを設定するか、Ingress を設定します。ローカルにアクセスするようにポートフォワーディングを設定するには、次のように入力します。
    CODE 
    kubectl port-forward svc/psa-monitoring-grafana 3000:80 --namespace monitoring
  3. ブラウザから localhost:3000 を起動し、デフォルトのログイン情報（ユーザ名：admin、パスワード：prom-operator）を使用してログインします。Private Simple Synthetic Agent という名前のダッシュボードに、Kubernetes クラスタ、Apache Ignite、Heimdall、および実行中の測定に関する詳細が表示されます。

PSA のアンインストール

PSA をアンインストールするには、次のコマンドを実行します。

CODE 
./uninstall_psa -e kubernetes -p

Amazon Elastic Kubernetes Service の PSA のアップグレード

Docker イメージのプル

DockerHub から sum-chrome-agent、sum-api-monitoring-agent、sum- heimdall の既成の Docker イメージをプルします。既成イメージには依存ライブラリが含まれているため、インターネットにアクセスできない場合でもこれらのイメージを使用できます。

次のコマンドを実行して、エージェントイメージをプルします。

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

カスタム Python ライブラリの追加

この手順は任意です。使用可能な標準ライブラリセットに加えて、スクリプト測定で使用するカスタム Python ライブラリをエージェントに追加できます。ベースイメージとしてロードしたイメージに基づいて新しいイメージをビルドします。

  1. Dockerfile を作成してから、pythonpip を実行する RUN ディレクティブを作成します。たとえば、algorithms ライブラリをインストールするには、次のように Dockerfile を作成します。
    CODE 
    # 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
    注: 任意の数の ディレクティブを作成して、必要なライブラリをインストールできます。
  2. 新しいイメージを作成するには、次のコマンドを実行します。Web Monitoring PSA：
    CODE 
    docker build -t sum-chrome-agent:<agent-tag> - < Dockerfile
    API Monitoring PSA：
    CODE 
    docker build -f Dockerfile-PSA -t sum-api-monitoring-agent:<agent-tag> .
    Kubernetes クラスタノードと同じ OS タイプのホストでイメージをビルドする必要があります。たとえば、イメージを AWS にプッシュする場合は、次のコマンドを実行します。
    CODE 
    docker buildx build -f Dockerfile-PSA --platform=linux/amd64 -t sum-api-monitoring-agent:<api-tag> .
    新しくビルドされたエージェントイメージには、必要なライブラリが含まれています。

イメージのタグ付けとレジストリへのプッシュ

注: EKS や AKS などのマネージド Kubernetes サービスは、イメージをプッシュできるコンテナレジストリを提供します。その他の設定は必要ありません。EKS または AKS 内の Kubernetes クラスタは、これらのイメージにアクセスできます。

クラスタがアクセスできるように、イメージにタグを付けてレジストリにプッシュする必要があります。Amazon EKS クラスタは、AWS が提供するマネージドレジストリである Elastic Container Registry（ECR）からイメージをプルします。

Vanilla K8S は AWS インフラストラクチャで実行されるため、Kubernetes Operations（kops）が適切なロールを作成してクラスタノードに割り当て、それらは ECR に直接アクセスできます。その他の設定は必要ありません。そのため、プロセスは、EC2 を使用する EKS と Vanilla K8S の両方で同じです。

イメージにタグを付けるには、次のように入力します。

CODE 
docker tag sum-heimdall:<heimdall-tag> <aws_account_id>.dkr.ecr.<region>.amazonaws.com/sum/sum-heimdall:<heimdall-tag>
docker tag sum-chrome-agent:<agent-tag> <aws_account_id>.dkr.ecr.<region>.amazonaws.com/sum/sum-chrome-agent:<agent-tag>
docker tag sum-api-monitoring-agent:<agent-tag> <aws_account_id>.dkr.ecr.<region>.amazonaws.com/sum/sum-api-monitoring-agent:<agent-tag>

<aws_account_id> と <region> をアカウント ID とリージョンの値に置き換える必要があります。

リポジトリを作成するには、次のように入力します。

CODE 
aws ecr create-repository --repository-name sum/sum-heimdall
aws ecr create-repository --repository-name sum/sum-chrome-agent
aws ecr create-repository --repository-name sum/sum-api-monitoring-agent

イメージをプッシュするには、次のように入力します。

CODE 
aws ecr get-login-password --region us-west-2 | docker login --username AWS --password-stdin <aws_account_id>.dkr.ecr.<region>.amazonaws.com
docker push <aws_account_id>.dkr.ecr.<region>.amazonaws.com/sum/sum-heimdall:<heimdall-tag>
docker push <aws_account_id>.dkr.ecr.<region>.amazonaws.com/sum/sum-chrome-agent:<agent-tag>
docker push <aws_account_id>.dkr.ecr.<region>.amazonaws.com/sum/sum-api-monitoring-agent:<agent-tag>

Helm チャートの更新

次の手順に従って、values.yaml ファイル内の設定キーと値のペアを更新します。

PSA のアップグレード

注: PSA 23.12 以降、Ignite と Heimdall を measurement という名前の単一の名前空間に展開する必要があります。
  1. 新しい Linux ディストリビューション フォルダに移動して、次のコマンドを実行します。
    CODE 
    helm install synth ignite-psa.tgz --values values-ignite.yaml --namespace measurement
  2. Ignite ポッドのステータスが running に変わるまで待ちます。その後、次のコマンドを実行します。
    CODE 
    helm upgrade heimdall-onprem sum-psa-heimdall.tgz --values values.yaml --namespace measurement
  3. 新しい Heimdall ポッドと Ignite ポッドのステータスが runningに変更されたら、古い Ignite 名前空間をアンインストールします。
    CODE 
    helm uninstall synth -n ignite