Red Hat OpenShift での PSA の設定

OpenShift で Web モニタリング PSA および API モニタリング PSA を展開するには、Amazon EKS または Azure AKS で OpenShift クラスタを作成する必要があります。次のいずれかの方法で PSA を設定できます。

手動展開自動化スクリプトを使用した展開
  1. Docker イメージをプルします。
  2. イメージにタグを付け、レジストリにプッシュします。
  3. OpenShift での PSA の手動展開
  4. Kubernetes クラスタをモニタします。
  1. 自動化スクリプトを使用した OpenShift での PSA の展開
  2. Kubernetes クラスタをモニタします。
警告: このページには、AWS CLI のマニュアルへのリンクが含まれています。AWS CLI で自身のマニュアルを管理しているため、Splunk AppDynamics では AWS CLI のマニュアルの精度については一切保証しません。
警告: 自動化スクリプトを使用する場合は、OpenShift クラスタとノードを手動で設定し、PSA を展開する前にコンテナレジストリにログインする必要があります。

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

注: 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>"

Docker イメージのプル

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

次のコマンドを実行して、エージェントイメージをプルします。
docker pull appdynamics/heimdall-psa

docker pull appdynamics/chrome-agent-psa

docker pull appdynamics/api-monitoring-agent-psa

(Optional) Add Custom Python Libraries

注: 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 then 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
    注: 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.

イメージにタグを付け、レジストリにプッシュします。

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

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

Web モニタリング PSA：

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>

API モニタリング PSA：

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

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

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

Web モニタリング PSA：

aws ecr create-repository --repository-name sum/sum-heimdall aws ecr create-repository --repository-name sum/sum-chrome-agent

API モニタリング PSA：

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

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

Web モニタリング PSA：

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>

API モニタリング PSA：

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-api-monitoring-agent:<agent-tag>

OpenShift での PSA の手動展開

注: Web モニタリング PSA および API モニタリング PSA をインストールするときは、それぞれの該当する一連の手順に必ず従ってください。一部の手順は、両方で共通しています。

イメージがレジストリに登録されると、アプリケーションはクラスタに展開されます。Helm チャートを使用して、必要な順序ですべての Kubernetes リソースを展開および作成します。

  1. 次の手順に従って、Helm をインストールします。
  2. Apache Ignite ポッドを実行するための新しい名前空間を作成します。
    警告:
    • 最初に Apache Ignite のコマンドを実行してから、Heimdall のコマンドを実行してください。
    • PSA 23.12 以降、Ignite と Heimdall を measurement という名前の単一の名前空間に展開する必要があります。
    新しい measurement 名前空間を作成するには、次のように入力します。 
    kubectl create namespace measurement
    Apache Ignite を展開する前に、いくつかの設定オプションを設定する必要があります。設定オプションを表示するには、すでにダウンロードした ignite-psa.tgz ファイルに移動し、次のように入力します。 
    helm show values ignite-psa.tgz > values-ignite.yaml
  3. （オプション） Apache Ignite の Amazon Elastic File System（Amazon EFS）を有効にします。 values-ignite.yaml ファイルを開き、永続設定で次の詳細を更新します。
    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
    注: Helm チャートを展開後、次のコマンドを実行して、Persistent Volume（PV）と Persistent Volume Claim（PVC）が実行されているかどうかを確認できます。
    kubectl get pv -n measurement
kubectl get pvc -n measurement
    PV および PVC のステータスが Bound に変わったら、Amazon EFS 設定が完了したことを示します。
    注: Amazon EFS for Heimdall を有効にするには、values.yaml ファイルの設定を更新します。
  4. 上記の設定を使用して Helm チャートを展開するには、すでにダウンロードした ignite-psa.tgz ファイルに移動し、次のように入力します。 
    helm install synth ignite-psa.tgz --values values-ignite.yaml --namespace measurement
    すべての Kubernetes リソースがクラスタに作成され、Apache Ignite を使用できます。数秒後、Apache Ignite が初期化され、コントローラに表示されます。
  5. ポッドが実行されているかどうかを確認するには、次のように入力します。
    kubectl get pods --namespace measurement
    Apache Ignite ポッドが正常に実行された後にのみ、次の手順に進みます。
  6. 1 つのコマンドを使用して、展開の詳細を含む Helm チャートを展開できます。エージェントを展開するには、以前にダウンロードした zip ファイルの Helm チャート を使用します。Private Synthetic Agent を展開する前に、いくつかの設定オプションを設定する必要があります。設定オプションを表示するには、すでにダウンロードした sum-psa-heimdall.tgz ファイルに移動し、次のように入力します。 
    helm show values sum-psa-heimdall.tgz > values.yaml

    以下は、values.yaml ファイルで編集する必要がある設定キーと値のペアです。

    Web モニタリング PSA：
    設定キー値
    heimdall > repository<aws_account_id>.dkr.ecr.<region>.amazonaws.com/sum/sum-heimdall
    heimdall > tag<heimdall-tag>
    heimdall > pullPolicyAlways
    chromeAgent > repository<aws_account_id>.dkr.ecr.<region>.amazonaws.com/sum/sum-chrome-agent
    chromeAgent > tag<agent-tag>
    shepherd > urlシェパード URL
    shepherd > credentialsログイン情報
    shepherd > locationagent location
    永続化

    （オプション）Amazon EFS for Heimdall を有効にする場合は、次の詳細を指定します。

    # 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
    注: Helm チャートを展開後、次のコマンドを実行して PV と PVC が実行されているかどうかを確認できます。
    kubectl get pv -n measurement
kubectl get pvc -n measurement
    PV および PVC のステータスが Bound に変わったら、Amazon EFS 設定が完了したことを示します。
    API モニタリング PSA：
    設定キー値
    heimdall > repository<aws_account_id>.dkr.ecr.<region>.amazonaws.com/sum/sum-heimdall
    heimdall > tag<heimdall-tag>
    heimdall > pullPolicyAlways
    apiMonitoringAgent > repository <aws_account_id>.dkr.ecr.<region>.
    apiMonitoringAgent > tag<agent-tag>
    ingressBandwidth 1024k 以上（要件に応じて）。
    egressBandwidth1024k 以上（要件に応じて）。
    shepherd > urlシェパード URL
    shepherd > credentialsログイン情報
    shepherd > locationagent location
    永続化

    （オプション）Amazon EFS for Heimdall を有効にする場合は、次の詳細を指定します。

    # 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
    注: Helm チャートを展開後、次のコマンドを実行して PV と PVC が実行されているかどうかを確認できます。
    kubectl get pv -n measurement
kubectl get pvc -n measurement
    PV および PVC のステータスが Bound に変わったら、Amazon EFS 設定が完了したことを示します。
    残りの値はデフォルトのままにすることも、要件に基づいて設定することもできます。シェパード URL、ログイン情報、場所、およびオプションのキーと値のペアの詳細については、「Web モニタリング PSA および API モニタリング PSA の設定」を参照してください。
    注: Kubernetes クラスタがロックダウンされていて、クラスタ全体の設定を行うことができない場合は、ポッドレベルの変更を行うことができます。

    たとえば、ポッドレベルの DNS サーバー設定を変更して、DNS 名の解決に内部ネームサーバーを使用する場合は、values.yaml ファイルで次の詳細を指定します。

    agentDNSConfig:
enabled: true
dnsPolicy: "None"
dnsConfig:
nameservers: ["4.4.4.4"]
searches: ["svc.cluster.local", "cluster.local"]
    複数のネームサーバーを追加する必要がある場合は、次の手順を実行します。
    1. values.yaml ファイルで dnsPolicy を「None」に設定します。
      agentDNSConfig:
enabled: true
dnsPolicy: "None"
dnsConfig:
nameservers: ["1.1.1.1", "2.2.2.2", "3.3.3.3"]
searches: ["measurement.svc.cluster.local", "svc.cluster.local", "cluster.local"]
      nameservers で指定された最初のネームサーバーが cluster-default ネームサーバーであることを確認します。
    2. [Upstream coredns policy] を [sequential] に設定します。詳細については、Event Analytics を参照してください。
  7. 上記の設定を使用して Helm チャートを展開するには、すでにダウンロードした ファイルに移動し、次のように入力します。 
    helm install heimdall-onprem sum-psa-heimdall.tgz --values values.yaml --namespace measurement
    すべての Kubernetes リソースがクラスタに作成され、Heimdall を使用できます。数秒後、Heimdall が初期化され、コントローラに表示されます。
  8. ポッドが実行されているかどうかを確認するには、次のように入力します。 
    kubectl get pods --namespace measurement
    初期展開後に values.yaml に変更を加えるには、すでにダウンロードした sum-psa-heimdall.tgz ファイルに移動して、次のように入力します。 
    helm upgrade heimdall-onprem sum-psa-heimdall.tgz --values values.yaml --namespace measurement
    注意:

    展開を削除するには、次のコマンドを実行します。

    helm uninstall heimdall-onprem --namespace measurement

    これは、必要でない限り推奨されません。

Deploy PSA in OpenShift Using the Automation Script

Prerequisite

Before running the PSA installation script:

Perform the following steps to install PSA:

  1. Unzip the PSA installation zip file.
  2. Run the following command to install PSA :
    ./install_psa -e openshift -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> -w <heimdall_proxy_server>~<api_monitoring_proxy_server>~<web_monitoring_proxy_server>
    A sample installation command looks like this: 
    ./install_psa -e openshift -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 2048k -w 127.0.0.1:8887~127.0.0.1:8888~127.0.0.1:8889
    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.

    -lLoad images to the Minkube environment
    -vDebug mode
    -u

    *Shepherd URL

    -a

    *EUM Account

    -k

    *EUM Key

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

    Specify a single value for the API monitoring agent's ingress and egress bandwidth. The default value for OpenShift is 1024k. Splunk AppDynamics recommends keeping a value greater than or equal to that for OpenShift deployments.

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

  3. Specify the Docker registry URL when prompted.

Troubleshoot

You may encounter certain issues if the pod configurations are incorrect. The following table lists the issues and the steps you can follow to resolve them:

IssueResolution

PodSecurity violation due to SeccompProfile configuration.

Warning Message

warnings.go:70] would violate PodSecurity "restricted:v1.24": seccompProfile (pod or container "heimdall" must set securityContext.seccompProfile.type to "RuntimeDefault" or "Localhost")

Perform the following steps:

  1. Open the sum-psa-heimdall/templates/heimdall-deployment.yaml file.
  2. Locate the securityContext section of the heimdall container.
  3. Set the seccompProfile.type to RuntimeDefault:
    securityContext: seccompProfile: type: RuntimeDefault
  4. Save the changes and redeploy the PSA.

The runAsUser value is outside the allowed range.

Warning Message

runAsUser (1000) does not fall within the allowed range for any of the available Security Context Constraints (SCC)

Modify the runAsUser value to the appropriate range:

  1. Open the sum-psa-heimdall/templates/heimdall-deployment.yaml file.
  2. Locate the runAsUser field.
  3. Change the runAsUser value to <value>:
    securityContext:runAsUser: <value>
  4. Save the changes and apply the updated configuration.
  5. Run the following command:
    oc adm policy add-scc-to-user anyuid -z heimdall-serviceaccount -n measurement
    This allows containers to use any UID, including root. For more information, see Managing Security Context Constraints and About security context constraints.

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

  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:
    oc adm policy add-scc-to-group anyuid system:authenticated
    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 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 openshift -p

Upgrade PSA in Red Hat OpenShift

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, run the following commands: Web Monitoring PSA:
    docker build -t sum-chrome-agent:<agent-tag> - < Dockerfile
    API Monitoring PSA:
    docker build -f Dockerfile-PSA-Openshift -t sum-api-monitoring-agent:<agent-tag> .
    You must build the images on the host with the same OS type of Kubernetes cluster nodes. For example, if you are pushing the image to AWS, then run the following command:
    docker buildx build -f Dockerfile-PSA-Openshift --platform=linux/amd64 -t sum-api-monitoring-agent:<api-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 access to these images.

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

Since the Vanilla K8S runs on AWS infrastructure, Kubernetes Operations (kops) creates and assigns appropriate roles to the cluster nodes, and they can directly access the ECR. You do not need any other configuration. Hence, the process is the same for both EKS and Vanilla K8S using EC2.

To tag the images, enter:

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>

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

To create repositories, enter:

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

To push the images, enter:

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>

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