Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gwenblum authored Sep 29, 2023
1 parent f83dcb4 commit 3b8cda9
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions 341-metrics-with-apm-daemonset-pod-agent-on-eks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ cd Tech-Community/341-metrics-with-apm-daemonset-pod-agent-on-eks

It is not required for CMX metric. Any APM instrumentation configuration file (e.g configuration.json exported from the webconsole) must be copied to the subfolder **apm-customization/config/**

3. In the snippet below, replace the token {{ecr_region}} and {{aws_account_id}} with your own values. Execute the snippet to build the image locally, and then push it to the ECR container registry. The build is based on a [Dockerfile](Dockerfile).
3. In the snippet below, replace the token **{{ecr_region}}** and **{{aws_account_id}}** with your own values. Execute the snippet to build the image locally, and then push it to the ECR container registry. The build is based on a [Dockerfile](Dockerfile).

```shell
ecr_region = "{{ecr_region}}" # replace {{ecr_region}}, for example: eu-west-3
Expand Down Expand Up @@ -83,11 +83,11 @@ For example:

Edit the Kubernetes manifest [apm-daemonset-pod-agent.yaml](apm-daemonset-pod-agent.yaml) to set the image path and the environment variables to configure the APM agent with the actual values prepared in previous steps (Step 1 and Step 3):

- replace {{ALLUVIO Aternity APM Daemonset POD agent image}} with the **URI of the APM agent container image** built previously (see Step 3.), for example: *1234-5678-90.dkr.ecr.eu-west-3.amazonaws.com/alluvio-aternity-apm-daemonset-pod-agent:23.8*
- replace **{{ALLUVIO Aternity APM Daemonset POD agent image}}** with the **URI of the APM agent container image** built previously (see Step 3.), for example: *1234-5678-90.dkr.ecr.eu-west-3.amazonaws.com/alluvio-aternity-apm-daemonset-pod-agent:23.8*

- replace {{ALLUVIO_ATERNITY_APM_CUSTOMER_ID}} with the **Customer Id** (see Step 1.), for example: *12341234-12341234-13241234*
- replace **{{ALLUVIO_ATERNITY_APM_CUSTOMER_ID}}** with the **Customer Id** (see Step 1.), for example: *12341234-12341234-13241234*

- replace {{ALLUVIO_ATERNITY_APM_SAAS_SERVER_HOST}} with the **SaaS Analysis Server Host** (see Step 1.), for example: *agents.apm.my_environment.aternity.com*
- replace **{{ALLUVIO_ATERNITY_APM_SAAS_SERVER_HOST}}** with the **SaaS Analysis Server Host** (see Step 1.), for example: *agents.apm.my_environment.aternity.com*


2. Deploy the APM Daemonset POD Agent
Expand All @@ -104,7 +104,8 @@ When ready, the agents will show up in the APM webconsole: in CONFIGURE > AGENTS

1. Prepare the image

Same as in Step 3, replace the token {{ecr_region}} and {{aws_account_id}} with the values of your environment, and execute the snippet to build the image of app. The build is based on this [Dockerfile](app/Dockerfile).
Same as in Step 3, replace the token **{{ecr_region}}** and **{{aws_account_id}}** with the values of your environment, and execute the snippet to build the image of the app.
The build is based on this [Dockerfile](app/Dockerfile).

```shell
ecr_region = "{{ecr_region}}" # replace {{ecr_region}}, for example: eu-west-3
Expand Down Expand Up @@ -138,7 +139,7 @@ The URI should be displayed in the terminal from the previous step. For example:
3. Set the image of the app in the manifest

Edit the [YAML manifest of the app](app/cookbook-341-kubernetes-job.yaml).
Find the container definition and set the image replacing {{ cookbook 341 app image }} with the URI obtained in the previous step, for example: *1234-5678-90.dkr.ecr.eu-west-3.amazonaws.com/cookbook-341-app:23.8*
Find the container definition and set the image replacing **{{ cookbook 341 app image }}** with the URI obtained in the previous step, for example: *1234-5678-90.dkr.ecr.eu-west-3.amazonaws.com/cookbook-341-app:23.8*

4. Deploy the app

Expand All @@ -158,4 +159,4 @@ Go to the APM webconsole to monitor the custom metrics (e.g. dashboards, alerts)

Copyright (c) 2023 Riverbed

The contents provided here are licensed under the terms and conditions of the MIT License accompanying the software ("License"). The scripts are distributed "AS IS" as set forth in the License. The script also include certain third party code. All such third party code is also distributed "AS IS" and is licensed by the respective copyright holders under the applicable terms and conditions (including, without limitation, warranty and liability disclaimers) identified in the license notices accompanying the software.
The contents provided here are licensed under the terms and conditions of the MIT License accompanying the software ("License"). The scripts are distributed "AS IS" as set forth in the License. The script also include certain third party code. All such third party code is also distributed "AS IS" and is licensed by the respective copyright holders under the applicable terms and conditions (including, without limitation, warranty and liability disclaimers) identified in the license notices accompanying the software.

0 comments on commit 3b8cda9

Please sign in to comment.