paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 21 Packages Projects Releases Wiki Activity

feat(techdocs-common): update Azure Blob Storage

Browse Source
This commit is contained in:
vitorgrenzel
2021-01-22 16:09:06 -03:00
committed by Tiago A. Simões
parent 2d8d7697d6
commit 0be9694aa6
7 changed files with 96 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/techdocs/configuration.md
+7 -5
View File
@@ -91,12 +91,14 @@ techdocs:
# (Required) Azure Blob Storage Container Name
containerName: 'techdocs-storage'
# (Optional) An API key is required to write to a storage container.
# If not set, environment variables will be used to authenticate.
#https://docs.microsoft.com/en-us/azure/storage/common/storage-auth?toc=/azure/storage/blobs/toc.json
# (Required) An account name is required to write to a storage blob container.
# https://docs.microsoft.com/pt-br/rest/api/storageservices/authorize-with-shared-key
credentials:
account:
$env: TECHDOCS_AZURE_BLOB_STORAGE_ACCOUNT
accountName:
$env: TECHDOCS_AZURE_BLOB_STORAGE_ACCOUNT_NAME
# (Optional) An account key is required to write to a storage container.
# If missing,AZURE_TENANT_ID, AZURE_CLIENT_ID, AZURE_CLIENT_SECRET environment variable will be used.
# https://docs.microsoft.com/en-us/azure/storage/common/storage-auth?toc=/azure/storage/blobs/toc.json
accountKey:
$env: TECHDOCS_AZURE_BLOB_STORAGE_ACCOUNT_KEY
```
docs/features/techdocs/using-cloud-storage.md
+50 -26
View File
@@ -212,33 +212,17 @@ techdocs:
type: 'azureBlobStorage'
```
**2. Service account credentials**
**2. Create an Azure Blob Storage Container**
To get credentials, access the Azure Portal and go to "Settings > Access Keys",
and get your Storage account name and Primary Key.
Create a dedicated container for TechDocs sites.
[Refer to the official documentation](https://docs.microsoft.com/pt-br/azure/storage/blobs/storage-quickstart-blobs-portal).
```yaml
techdocs:
publisher:
type: 'azureBlobStorage'
azureBlobStorage:
credentials:
account:
$env: TECHDOCS_AZURE_BLOB_STORAGE_ACCOUNT
accountKey:
$env: TECHDOCS_AZURE_BLOB_STORAGE_ACCOUNT_KEY
```
TechDocs will publish documentation to this container and will fetch files from
here to serve documentation in Backstage. Note that the container names are
globally unique.
**3. Azure Blob Storage Container**
Create a dedicated container for TechDocs sites. techdocs-backend will publish
documentation to this container. TechDocs will fetch files from here to serve
documentation in Backstage.
To create a new container, access "Blob Service > Containers > New Container".
Set the name of the container to
`techdocs.publisher.azureBlobStorage.containerName`.
Set the config `techdocs.publisher.azureBlobStorage.containerName` in your
`app-config.yaml` to the name of the container you just created.
```yaml
techdocs:
@@ -246,9 +230,49 @@ techdocs:
type: 'azureBlobStorage'
azureBlobStorage:
containerName: 'name-of-techdocs-storage-container'
```
**3a. (Recommended) Authentication using environment variable**
Set the config `techdocs.publisher.azureBlobStorage.credentials.accountName` in
your `app-config.yaml` to the your account name.
The storage blob client will automatically use the environment variable
`AZURE_TENANT_ID`, `AZURE_CLIENT_ID`, `AZURE_CLIENT_SECRET` to authenticate with
Azure Blob Storage.
https://docs.microsoft.com/pt-br/azure/storage/common/storage-auth-aad for more
details.
```yaml
techdocs:
publisher:
type: 'azureBlobStorage'
azureBlobStorage:
containerName: 'name-of-techdocs-storage-bucket'
credentials:
account:
$env: TECHDOCS_AZURE_BLOB_STORAGE_ACCOUNT
accountName:
$env: TECHDOCS_AZURE_BLOB_STORAGE_ACCOUNT_NAME
```
**3b. Authentication using app-config.yaml**
If you do not prefer (3a) and optionally like to use a service account, you can
follow these steps.
To get credentials, access the Azure Portal and go to "Settings > Access Keys",
and get your Storage account name and Primary Key.
https://docs.microsoft.com/pt-br/rest/api/storageservices/authorize-with-shared-key
for more details.
```yaml
techdocs:
publisher:
type: 'azureBlobStorage'
azureBlobStorage:
containerName: 'name-of-techdocs-storage-bucket'
credentials:
accountName:
$env: TECHDOCS_AZURE_BLOB_STORAGE_ACCOUNT_NAME
accountKey:
$env: TECHDOCS_AZURE_BLOB_STORAGE_ACCOUNT_KEY
```