diff --git a/.changeset/heavy-owls-float.md b/.changeset/heavy-owls-float.md index 1b0bc9f016..1997e64d72 100644 --- a/.changeset/heavy-owls-float.md +++ b/.changeset/heavy-owls-float.md @@ -3,7 +3,7 @@ '@backstage/plugin-techdocs': patch --- -Google Cloud authentication in TechDocs has been improved. https://github.com/backstage/backstage/pull/3981 +Google Cloud authentication in TechDocs has been improved. `techdocs.publisher.googleGcs.credentials` is now optional. If it is missing, `GOOGLE_APPLICATION_CREDENTIALS` environment variable (and some other methods) will be used to authenticate. diff --git a/docs/features/techdocs/using-cloud-storage.md b/docs/features/techdocs/using-cloud-storage.md index b06f5c00a8..7be977887b 100644 --- a/docs/features/techdocs/using-cloud-storage.md +++ b/docs/features/techdocs/using-cloud-storage.md @@ -180,7 +180,7 @@ In the IAM console, do the following: **2.2 Attach policies** Remember that you can use Bucket policy **or** User policy. Just make sure that -you grant all the permissions to the TechDocs user: `3:PutObject`, +you grant all the permissions to the TechDocs user: `s3:PutObject`, `s3:GetObject`, `s3:ListBucket` and `s3:GetBucketLocation`. **2.2.1 Create the bucket policy** diff --git a/packages/techdocs-common/src/stages/publish/googleStorage.ts b/packages/techdocs-common/src/stages/publish/googleStorage.ts index ffed59b8ba..6dd7e12aea 100644 --- a/packages/techdocs-common/src/stages/publish/googleStorage.ts +++ b/packages/techdocs-common/src/stages/publish/googleStorage.ts @@ -72,7 +72,7 @@ export class GoogleGCSPublish implements PublisherBase { logger.error( `Could not retrieve metadata about the GCS bucket ${bucketName}. ` + 'Make sure the bucket exists. Also make sure that authentication is setup either by explicitly defining ' + - 'techdocs.publisher.googleGcs.credentials in app config or by using environment variables' + + 'techdocs.publisher.googleGcs.credentials in app config or by using environment variables. ' + 'Refer to https://backstage.io/docs/features/techdocs/using-cloud-storage', ); throw new Error(err.message);