Skip to content

Commit fb6e9d2

Browse files
authored
Merge pull request #133 from buildkite-plugins/chore/aws_s3_docs
chore: update README to cover AWS configuration
2 parents f82080c + 2e675ef commit fb6e9d2

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,8 @@ steps:
9494

9595
Store things in an S3 bucket. You need to make sure that the `aws` command is available and appropriately configured.
9696

97+
**AWS Authentication**: For AWS role assumption, use the [aws-assume-role-with-web-identity](https://github.com/buildkite-plugins/aws-assume-role-with-web-identity-buildkite-plugin) plugin. Alternatively, configure AWS credentials via IAM instance profiles, environment variables, or AWS CLI configuration.
98+
9799
You also need the agent to have access to the following defined environment variables:
98100
* `BUILDKITE_PLUGIN_S3_CACHE_BUCKET`: the bucket to use (backend will fail if not defined)
99101
* `BUILDKITE_PLUGIN_S3_CACHE_PREFIX`: optional prefix to use for the cache within the bucket
@@ -109,12 +111,14 @@ env:
109111
BUILDKITE_PLUGIN_S3_CACHE_BUCKET: "my-cache-bucket" # Required: S3 bucket to store cache objects
110112
BUILDKITE_PLUGIN_S3_CACHE_PREFIX: "buildkite/cache"
111113
BUILDKITE_PLUGIN_S3_CACHE_ENDPOINT: "https://<your-endpoint>"
112-
BUILDKITE_PLUGIN_S3_CACHE_ONLY_SHOW_ERRORS: "true"
114+
BUILDKITE_PLUGIN_S3_CACHE_ONLY_SHOW_ERRORS: "true"
113115
114116
steps:
115117
- label: ':nodejs: Install dependencies'
116118
command: npm ci
117119
plugins:
120+
- aws-assume-role-with-web-identity#v1.4.0:
121+
role-arn: $AWS_ROLE_ARN
118122
- cache#v1.7.0:
119123
backend: s3
120124
path: node_modules

0 commit comments

Comments
 (0)