Skip to content

Commit ac5f847

Browse files
authored
Merge pull request #453 from bjrara/doc
Update doc layout
2 parents a3c1c10 + f854aa0 commit ac5f847

22 files changed

+8
-97
lines changed
File renamed without changes.

deployment-template/eks/standalone-otel-eks-deployment.yaml renamed to deployment-template/eks/otel-container-insights-prometheus.yaml

File renamed without changes.

docs/developers/container-insight-install-aoc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ export AWS_REGION=<aws-region>
1616
```
1717

1818
2. Deploy a standalone aws-otel-collector application. An example config template can be
19-
found [here](../../deployment-template/eks/standalone-otel-eks-deployment.yaml).
19+
found [here](../../deployment-template/eks/otel-container-insights-prometheus.yaml).
2020
* Replace `{{region}}` with the name of the region where the logs are published (e.g. `us-west-2`).
2121
* Replace `{{cluster_name}}` with the actual eks cluster name.
2222

2323
```bash
24-
cat standalone-otel-eks-deployment.yaml |
24+
cat otel-container-insights-prometheus.yaml |
2525
sed "s/{{region}}/$AWS_REGION/g" |
2626
sed "s/{{cluster_name}}/$CLUSTER_NAME/g" |
2727
kubectl apply -f -

docs/developers/container-insights-eks-jmx.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ docker push $AWS_ACCOUNT_ID.dkr.ecr.$AWS_REGION.amazonaws.com/prometheus-sample-
3939

4040
```bash
4141
SAMPLE_TRAFFIC_NAMESPACE=javajmx-sample
42-
curl https://raw.githubusercontent.com/aws-observability/aws-otel-collector/main/examples/eks/eks-containerinsight-javajmx-sample.yaml |
42+
curl https://raw.githubusercontent.com/aws-observability/aws-otel-test-framework/terraform/sample-apps/jmx/examples/prometheus-metrics-sample.yaml |
4343
sed "s/{{aws_account_id}}/$AWS_ACCOUNT_ID/g" |
4444
sed "s/{{region}}/$AWS_REGION/g" |
4545
sed "s/{{namespace}}/$SAMPLE_TRAFFIC_NAMESPACE/g" |

docs/developers/ecs-demo.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,11 @@ This example will introduce how to use AWS-OTel-Collector to send application tr
5252
The easiest way to deploy AWSOTelCollector on Amazon ECS is to run it as a sidecar, defining it in the same task definition as your application.
5353

5454
**ECS Fargate Template**
55-
You can find ECS Fargate AWSOTelCollector [Installing template](../../examples/ecs/ecs-fargate-sidecar.json). Instructions for setting up a service in your ECS cluster using Fargate can be found [here](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/getting-started-fargate.html).
55+
You can find ECS Fargate AWSOTelCollector [Installing template](../../examples/ecs/aws-cloudwatch/ecs-fargate-sidecar.json). Instructions for setting up a service in your ECS cluster using Fargate can be found [here](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/getting-started-fargate.html).
5656

5757
**ECS EC2 Template**
5858
Another example is installing AWSOTelCollector on ECS EC2 instance as sidecar to send telemetry data.
59-
You can find ECS EC2 AWSOTelCollector [Installing template](../../examples/ecs/ecs-ec2-sidecar.json). Instructions for setting up a service in your ECS cluster using EC2 can be found [here](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/getting-started-ecs-ec2.html).
59+
You can find ECS EC2 AWSOTelCollector [Installing template](../../examples/ecs/aws-cloudwatch/ecs-ec2-sidecar.json). Instructions for setting up a service in your ECS cluster using EC2 can be found [here](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/getting-started-ecs-ec2.html).
6060

6161
**Configure The Task Definition**
6262
The two ECS task definition templates are provided to run AWS-OTel-Collector as sidecar to send application metrics and traces on Amazon ECS. Notice that in the task definition templates we provided, you have to replace `{{region}}` with the region your want to send the data to. Fill `{{ecsTaskRoleArn}}` and `{{ecsExecutionRoleArn}}` with the IAM role (`ECS-AWSOTel`) you created above.

docs/developers/eks-demo.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,11 @@ export CLUSTER_NAME=<eks-cluster-name>
5555
export AWS_REGION=<aws-region>
5656
```
5757

58-
3. Deploy the application. An example config template can be found [here](../../deployment-template/eks/eks-sidecar.yaml).
58+
3. Deploy the application. An example config template can be found [here](../../deployment-template/eks/otel-cloudwatch-sidecar.yaml).
5959
* Replace `{{region}}` with the name of the region where the logs are published (e.g. `us-west-2`).
6060
* Replace `{{cluster_name}}` with the actual eks cluster name.
6161
```bash
62-
cat eks-sidecar.yaml |
62+
cat otel-cloudwatch-sidecar.yaml |
6363
sed "s/{{region}}/$AWS_REGION/g" |
6464
sed "s/{{cluster_name}}/$CLUSTER_NAME/g" |
6565
kubectl apply -f -
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ services:
2323
# - AWS_PROFILE=myprofile
2424

2525
volumes:
26-
- ../examples/config-test.yaml:/etc/otel-agent-config.yaml
26+
- ./config-test.yaml:/etc/otel-agent-config.yaml
2727
- ~/.aws:/root/.aws
2828
ports:
2929
- "1777:1777" # pprof extension
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)