Skip to content

Commit a56d206

Browse files
authored
Update README.md
1 parent dd34295 commit a56d206

File tree

1 file changed

+36
-2
lines changed

1 file changed

+36
-2
lines changed

README.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,21 @@ run
2525
cd terraform/setup && terraform init && terraform apply
2626
``
2727

28+
### 1.4 [Optional] Create a PR to [AOC Repo](https://github.com/aws-observability/aws-otel-collector) and record the version number
29+
30+
This is optional item, only do it if your goal is to add a component or fix a bug into the AOC Repo. Everytime when you create a PR to AOC repo, there will be a workflow to be running in this PR to do regression test and also, build testing artifacts[rpm, image, etc] for your code. Every PR will have a separate version number which you will be able to use it in the testing framework to verify whether your new code can pass your new testing suite.
31+
32+
1. create a branch in [AOC Repo](https://github.com/aws-observability/aws-otel-collector). [please don't fork at this moment, just create a branch directly in the AOC Repo]. [todo, after the repo becomes public, you can use fork instead of creating branch]
33+
34+
2. create a PR to merge the new branch to the `main` branch.
35+
36+
3. Waiting for the workflow checking in the PR to be finished.
37+
38+
4. find out the version number, click into the workflow page, click `e2etest-preparation` step, and click `Versioning for testing`, record the version number. Ex(v0.1.12-299946851).
39+
40+
5. provide your testing aws account id to Ying(wangmyin@), so that he will give permission to your aws account to fetch the testing image from a private ECR. [todo, once we migrate to dockerhub, you don't need this step]
41+
42+
2843
## 2. Run ECS Test
2944

3045
### 2.1 run with the testing-suite
@@ -33,7 +48,13 @@ cd terraform/setup && terraform init && terraform apply
3348
cd terraform/ecs && terraform init && terraform apply -var-file="../testing-suites/statsd-ecs.tfvars"
3449
```
3550

36-
### 2.2 don't forget to clean the resources
51+
### 2.1 run with a specific aoc version
52+
53+
```shell
54+
cd terraform/ecs && terraform init && terraform apply -var-file="../testing-suites/statsd-ecs.tfvars" -var="aoc_version={the version you got from workflow}"
55+
```
56+
57+
### 2.3 don't forget to clean the resources
3758

3859
```shell
3960
cd terraform/ecs && terraform destory"
@@ -46,7 +67,14 @@ cd terraform/ecs && terraform destory"
4667
cd terraform/ec2 && terraform init && terraform apply -var="sshkey_s3_bucket={the bucket name you set in setup}" -var-file="../testing-suites/statsd-ec2.tfvars"
4768
```
4869
49-
### 3.2 don't forget to clean the resources
70+
### 3.2 run with a specfic aoc version
71+
72+
73+
```shell
74+
cd terraform/ec2 && terraform init && terraform apply -var="sshkey_s3_bucket={the bucket name you set in setup}" -var-file="../testing-suites/statsd-ec2.tfvars" -var="aoc_version={the version you got from workflow}"
75+
```
76+
77+
### 3.3 don't forget to clean the resources
5078
```shell
5179
cd terraform/ec2 && terraform destory"
5280
```
@@ -61,6 +89,12 @@ create a eks cluster in your account before run below command
6189
cd terraform/eks && terraform init && terraform apply -var="eks_cluster_name={the eks cluster name in your account}" -var-file="../testing-suites/statsd-eks.tfvars"
6290
```
6391

92+
### 4.2 run with a specfic aoc version
93+
94+
```shell
95+
cd terraform/eks && terraform init && terraform apply -var="eks_cluster_name={the eks cluster name in your account}" -var-file="../testing-suites/statsd-eks.tfvars" -var="aoc_version={the version you got from workflow}"
96+
```
97+
6498
### 4.3 don't forget to clean the resources
6599

66100
```

0 commit comments

Comments
 (0)