Add doc on custom endpoint and path-style access

These features were added in https://github.com/backstage/backstage/commit/cf2e20a79223997baf2480db0d1c63f4c98abe8b

Signed-off-by: Leon Stein <leons727@gmail.com>
This commit is contained in:
Leon
2022-01-04 13:19:04 -05:00
committed by Leon Stein
parent ffdb98aa29
commit 9767bf8570
+15 -4
View File
@@ -20,8 +20,7 @@ To use this integration, add configuration to your `app-config.yaml`:
```yaml
integrations:
awsS3:
- host: amazonaws.com
accessKeyId: ${AWS_ACCESS_KEY_ID}
- accessKeyId: ${AWS_ACCESS_KEY_ID}
secretAccessKey: ${AWS_SECRET_ACCESS_KEY}
```
@@ -35,8 +34,20 @@ instruct the AWS S3 reader to assume a role before accessing S3:
```yaml
integrations:
awsS3:
- host: amazonaws.com
accessKeyId: ${AWS_ACCESS_KEY_ID}
- accessKeyId: ${AWS_ACCESS_KEY_ID}
secretAccessKey: ${AWS_SECRET_ACCESS_KEY}
roleArn: 'arn:aws:iam::xxxxxxxxxxxx:role/example-role'
```
Configuration allows specifying custom S3 endpoint, along with
[path-style access](https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html)
to support integration with providers like [LocalStack](https://github.com/localstack/localstack):
```yaml
integrations:
awsS3:
- endpoint: 'http://localhost:4566'
s3ForcePathStyle: true
accessKeyId: ${AWS_ACCESS_KEY_ID}
secretAccessKey: ${AWS_SECRET_ACCESS_KEY}
```