From 9767bf8570a0f619507fdb1580fe243612bc4b93 Mon Sep 17 00:00:00 2001 From: Leon Date: Tue, 4 Jan 2022 13:19:04 -0500 Subject: [PATCH 1/2] 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 --- docs/integrations/aws-s3/locations.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/docs/integrations/aws-s3/locations.md b/docs/integrations/aws-s3/locations.md index fe1c6050c2..500e610161 100644 --- a/docs/integrations/aws-s3/locations.md +++ b/docs/integrations/aws-s3/locations.md @@ -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} +``` From cf073fa2cf05c9c8141b013643fd25809c74e7ca Mon Sep 17 00:00:00 2001 From: Leon Stein Date: Tue, 4 Jan 2022 14:05:03 -0500 Subject: [PATCH 2/2] prettify Signed-off-by: Leon Stein --- docs/integrations/aws-s3/locations.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/integrations/aws-s3/locations.md b/docs/integrations/aws-s3/locations.md index 500e610161..b0c6829e2c 100644 --- a/docs/integrations/aws-s3/locations.md +++ b/docs/integrations/aws-s3/locations.md @@ -39,9 +39,10 @@ integrations: roleArn: 'arn:aws:iam::xxxxxxxxxxxx:role/example-role' ``` -Configuration allows specifying custom S3 endpoint, along with +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): +to support integration with providers like +[LocalStack](https://github.com/localstack/localstack): ```yaml integrations: