Skip to content

Commit

Permalink
docs: fix secretsmanager fields in sample manifests (#5728)
Browse files Browse the repository at this point in the history
Related: #5724.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the Apache 2.0 License.
  • Loading branch information
huanjani authored Mar 15, 2024
1 parent db68543 commit 7b95356
Show file tree
Hide file tree
Showing 11 changed files with 18 additions and 18 deletions.
6 changes: 3 additions & 3 deletions site/content/blogs/release-v126.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,13 +181,13 @@ secrets:
# To inject a secret from SecretsManager.
# (Recommended) Option 1. Referring to the secret by name.
DB:
secretsmanager: 'demo/test/mysql'
secretsmanager: 'mysql'
# You can refer to a specific key in the JSON blob.
DB_PASSWORD:
secretsmanager: 'demo/test/mysql:password::'
secretsmanager: 'mysql:password::'
# You can substitute predefined environment variables to keep your manifest succinct.
DB_PASSWORD:
secretsmanager: '${COPILOT_APPLICATION_NAME}/${COPILOT_ENVIRONMENT_NAME}/mysql:password::'
secretsmanager: 'mysql:password::'
# Option 2. Alternatively, you can refer to the secret by ARN.
DB: 'arn:aws:secretsmanager:us-west-2:111122223333:secret:demo/test/mysql-Yi6mvL'
Expand Down
6 changes: 3 additions & 3 deletions site/content/blogs/release-v126.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,13 +189,13 @@ secrets:
# To inject a secret from SecretsManager.
# (Recommended) Option 1. Referring to the secret by name.
DB:
secretsmanager: 'demo/test/mysql'
secretsmanager: 'mysql'
# You can refer to a specific key in the JSON blob.
DB_PASSWORD:
secretsmanager: 'demo/test/mysql:password::'
secretsmanager: 'mysql:password::'
# You can substitute predefined environment variables to keep your manifest succinct.
DB_PASSWORD:
secretsmanager: '${COPILOT_APPLICATION_NAME}/${COPILOT_ENVIRONMENT_NAME}/mysql:password::'
secretsmanager: 'mysql:password::'
# Option 2. Alternatively, you can refer to the secret by ARN.
DB: 'arn:aws:secretsmanager:us-west-2:111122223333:secret:demo/test/mysql-Yi6mvL'
Expand Down
8 changes: 4 additions & 4 deletions site/content/docs/developing/secrets.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ SSM と同様に、最初に Secrets Manager のシークレットに、`copilot

| Field | Value |
| ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name | `demo/test/mysql` |
| Name | `mysql` |
| ARN | `arn:aws:secretsmanager:us-west-2:111122223333:secret:demo/test/mysql-Yi6mvL` |
| Value | `{"engine": "mysql","username": "user1","password": "i29wwX!%9wFV","host": "my-database-endpoint.us-east-1.rds.amazonaws.com","dbname": "myDatabase","port": "3306"`} |
| Tags | `copilot-application=demo`, `copilot-environment=test` |
Expand All @@ -54,13 +54,13 @@ Manifest を次の様に変更します。
secrets:
# (推奨) オプション 1. 名前を使ってシークレットを参照します。
DB:
secretsmanager: 'demo/test/mysql'
secretsmanager: 'mysql'
# JSON blob 内の特定のキーを参照できます。
DB_PASSWORD:
secretsmanager: 'demo/test/mysql:password::'
secretsmanager: 'mysql:password::'
# 事前に定義された環境変数を利用して、Manifest を簡潔に保つ事ができます。
DB_PASSWORD:
secretsmanager: '${COPILOT_APPLICATION_NAME}/${COPILOT_ENVIRONMENT_NAME}/mysql:password::'
secretsmanager: 'mysql:password::'
# オプション 2. 別の方法として、ARN によってシークレットを指定することができます。
DB: "'arn:aws:secretsmanager:us-west-2:111122223333:secret:demo/test/mysql-Yi6mvL'"
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/manifest/backend-service.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ List of all available properties for a `'Backend Service'` manifest. To learn ab
secrets:
GITHUB_WEBHOOK_SECRET: GH_WEBHOOK_SECRET
DB_PASSWORD:
secretsmanager: 'demo/test/mysql:password::'
secretsmanager: 'mysql:password::'
```

=== "With a domain"
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/manifest/backend-service.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
secrets:
GITHUB_WEBHOOK_SECRET: GH_WEBHOOK_SECRET
DB_PASSWORD:
secretsmanager: 'demo/test/mysql:password::'
secretsmanager: 'mysql:password::'
```

=== "With a domain"
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/manifest/lb-web-service.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ List of all available properties for a `'Load Balanced Web Service'` manifest. T
secrets:
GITHUB_TOKEN: GITHUB_TOKEN
DB_SECRET:
secretsmanager: '${COPILOT_APPLICATION_NAME}/${COPILOT_ENVIRONMENT_NAME}/mysql'
secretsmanager: 'mysql'
```

=== "With a domain"
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/manifest/lb-web-service.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
secrets:
GITHUB_TOKEN: GITHUB_TOKEN
DB_SECRET:
secretsmanager: '${COPILOT_APPLICATION_NAME}/${COPILOT_ENVIRONMENT_NAME}/mysql'
secretsmanager: 'mysql'
```

=== "With a domain"
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/manifest/rd-web-service.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ List of all available properties for a `'Request-Driven Web Service'` manifest.
secrets:
GITHUB_TOKEN: GITHUB_TOKEN
DB_SECRET:
secretsmanager: '${COPILOT_APPLICATION_NAME}/${COPILOT_ENVIRONMENT_NAME}/mysql'
secretsmanager: 'mysql'

environments:
test:
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/manifest/rd-web-service.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
secrets:
GITHUB_TOKEN: GITHUB_TOKEN
DB_SECRET:
secretsmanager: '${COPILOT_APPLICATION_NAME}/${COPILOT_ENVIRONMENT_NAME}/mysql'
secretsmanager: 'mysql'

environments:
test:
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/manifest/worker-service.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ List of all available properties for a `'Worker Service'` manifest. To learn abo

secrets:
DB:
secretsmanager: '${COPILOT_APPLICATION_NAME}/${COPILOT_ENVIRONMENT_NAME}/mysql'
secretsmanager: 'mysql'
```

=== "Spot autoscaling"
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/manifest/worker-service.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@

secrets:
DB:
secretsmanager: '${COPILOT_APPLICATION_NAME}/${COPILOT_ENVIRONMENT_NAME}/mysql'
secretsmanager: 'mysql'
```

=== "Spot autoscaling"
Expand Down

0 comments on commit 7b95356

Please sign in to comment.