Skip to content

Commit 0c41bca

Browse files
committed
Update README.md
1 parent f8fe9cf commit 0c41bca

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

tests/ci/cdk/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -88,10 +88,10 @@ Use the following commands to deploy the CI pipeline. Any changes to the CI or D
8888

8989
1. Ensure you are in `aws-lc/tests/ci/cdk`
9090
2. Export the relevant environment variables:
91-
- `PIPELINE_ACCOUNT_ID`: the AWS account to host your pipeline
92-
- `DEPLOY_ACCOUNT_ID`: the AWS account to deploy Docker images and CodeBuild CI tests to.
93-
- `GITHUB_REPO_OWNER`: GitHub repo targeted by the pipeline (i.e, your personal Github account)
94-
- `GITHUB_SOURCE_VERSION`: Git branch holding the latest pipeline code (default: main)
91+
- `PIPELINE_ACCOUNT_ID` (required): the AWS account to host your pipeline
92+
- `DEPLOY_ACCOUNT_ID` (optional) : the AWS account to deploy Docker images and CodeBuild CI tests to, used for dev pipelines only (can be the same as `PIPELINE_ACCOUNT_ID`)
93+
- `GITHUB_REPO_OWNER` (optional): GitHub repo targeted by the pipeline (i.e, your personal Github account)
94+
- `GITHUB_SOURCE_VERSION` (optional): Git branch holding the latest pipeline code (default: main)
9595

9696
3. [SKIP IF NO CROSS-ACCOUNT DEPLOYMENT] Give the pipeline account administrator access to the deployment account's CloudFormation. Repeat this step depending on how many deployment environment there are. You only need to run this step once when the pipeline is deploying to a new account for the first time.
9797
```shell
@@ -101,7 +101,7 @@ Use the following commands to deploy the CI pipeline. Any changes to the CI or D
101101
```shell
102102
cdk bootstrap aws://${PIPELINE_ACCOUNT_ID}/us-west-2
103103
```
104-
5. You may also need to request an increase to certain account quotas:
104+
5. (Optional) You may also need to request an increase to certain account quotas:
105105
```shell
106106
open https://${DEPLOY_REGION}.console.aws.amazon.com/servicequotas/home/services/ec2/quotas
107107
```
@@ -134,15 +134,15 @@ Use these commands if you wish to deploy individual stacks instead of the entire
134134

135135
1. Ensure you are in `aws-lc/tests/ci/cdk`
136136
2. Export the relevant environment variables:
137-
- `DEPLOY_ACCOUNT_ID`: AWS account you wish to deploy the CI stacks to
138-
- `GITHUB_REPO_OWNER`: the GitHub repo targeted by this CI setup.
137+
- `DEPLOY_ACCOUNT_ID` (required): AWS account you wish to deploy the CI stacks to
138+
- `GITHUB_REPO_OWNER` (required): the GitHub repo targeted by this CI setup.
139139

140140
2. If not done previously, bootstrap cdk before running the commands below.
141141
```shell
142142
cdk bootstrap aws://${DEPLOY_ACCOUNT_ID}/us-west-2
143143
```
144144

145-
3. You may also need to request an increase to certain account quotas:
145+
3. (Optional) You may also need to request an increase to certain account quotas:
146146
```shell
147147
open https://${DEPLOY_REGION}.console.aws.amazon.com/servicequotas/home/services/ec2/quotas
148148
```

0 commit comments

Comments
 (0)