Changeset and docs updates.
Co-authored-by: Camila Loiola <camilaibs@gmail.com> Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
This commit is contained in:
committed by
Camila Belo
parent
11117811aa
commit
bc405be6ed
@@ -0,0 +1,19 @@
|
||||
---
|
||||
'@backstage/techdocs-common': patch
|
||||
---
|
||||
|
||||
Stale TechDocs content (files that had previously been published but which have
|
||||
since been removed) is now removed from storage at publish-time. This is now
|
||||
supported by the following publishers:
|
||||
|
||||
- Google GCS
|
||||
- AWS S3
|
||||
- Azure Blob Storage
|
||||
|
||||
You may need to apply a greater level of permissions (e.g. the ability to
|
||||
delete objects in your storage provider) to any credentials/accounts used by
|
||||
the TechDocs CLI or TechDocs backend in order for this change to take effect.
|
||||
|
||||
For more details, see [#6132][issue-ref].
|
||||
|
||||
[issue-ref]: https://github.com/backstage/backstage/issues/6132
|
||||
@@ -61,7 +61,7 @@ If you do not prefer (3a) and optionally like to use a service account, you can
|
||||
follow these steps.
|
||||
|
||||
Create a new Service Account and a key associated with it. In roles of the
|
||||
service account, use "Storage Admin".
|
||||
service account, use "Storage Object Admin".
|
||||
|
||||
If you want to create a custom role, make sure to include both `get` and
|
||||
`create` permissions for both "Objects" and "Buckets". See
|
||||
@@ -143,6 +143,8 @@ permissions to:
|
||||
|
||||
- `s3:ListBucket` to retrieve bucket metadata
|
||||
- `s3:PutObject` to upload files to the bucket
|
||||
- `s3:DeleteObject` and `s3:DeleteObjectVersion` to delete stale content during
|
||||
re-publishing
|
||||
|
||||
To _read_ TechDocs from the S3 bucket the IAM policy needs to have at a minimum
|
||||
permissions to:
|
||||
@@ -345,6 +347,10 @@ techdocs:
|
||||
accountKey: ${TECHDOCS_AZURE_BLOB_STORAGE_ACCOUNT_KEY}
|
||||
```
|
||||
|
||||
In either case, the account or credentials used to access your container and all
|
||||
TechDocs objects underneath it should have the `Storage Blog Data Owner` role
|
||||
applied, in order to read, write, and delete objects as needed.
|
||||
|
||||
**4. That's it!**
|
||||
|
||||
Your Backstage app is now ready to use Azure Blob Storage for TechDocs, to store
|
||||
|
||||
Reference in New Issue
Block a user