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

Rebuild yarn.lock after new release

Browse Source
This commit is contained in:
Himanshu Mishra
2020-12-03 22:54:30 +01:00
parent f0bfd369b3
commit 1051e5f342
3 changed files with 198 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/techdocs/configuration.md
+5 -4
View File
@@ -1,12 +1,13 @@
---
id: configuration
title: TechDocs Configuration Options
description: Reference documentation for configuring TechDocs using app-config.yaml
description:
Reference documentation for configuring TechDocs using app-config.yaml
---
Using the `app-config.yaml` in the Backstage app, you can configure TechDocs using several options.
This page serves as a reference to all the available configuration options for TechDocs.
Using the `app-config.yaml` in the Backstage app, you can configure TechDocs
using several options. This page serves as a reference to all the available
configuration options for TechDocs.
```yaml
# File: app-config.yaml
docs/features/techdocs/using-cloud-storage.md
+29 -16
View File
@@ -4,18 +4,21 @@ title: Using Cloud Storage for TechDocs generated files
description: Using Cloud Storage for TechDocs generated files
---
In the [TechDocs architecture](./architecture.md) you have the option to choose where you want to store
the Generated static files which TechDocs uses to render documentation. In both the "Basic" and "Recommended"
setup, you can add cloud storage providers like Google GCS, Amazon AWS S3, etc. By default, TechDocs
uses the local filesystem of the `techdocs-backend` plugin in the "Basic" setup. And in the recommended setup,
having one of the cloud storage is a prerequisite. Read more on the TechDocs Architecture documentation page.
In the [TechDocs architecture](./architecture.md) you have the option to choose
where you want to store the Generated static files which TechDocs uses to render
documentation. In both the "Basic" and "Recommended" setup, you can add cloud
storage providers like Google GCS, Amazon AWS S3, etc. By default, TechDocs uses
the local filesystem of the `techdocs-backend` plugin in the "Basic" setup. And
in the recommended setup, having one of the cloud storage is a prerequisite.
Read more on the TechDocs Architecture documentation page.
On this page you you can read how to enable them.
On this page you can read how to enable them.
## Configuring Google GCS Bucket with TechDocs
Follow the [official Google Cloud documentation](https://googleapis.dev/nodejs/storage/latest/index.html#quickstart) for the latest instructions
on the following steps involving GCP.
Follow the
[official Google Cloud documentation](https://googleapis.dev/nodejs/storage/latest/index.html#quickstart)
for the latest instructions on the following steps involving GCP.
**1. Set `techdocs.publisher.type` config in your `app-config.yaml`**
@@ -29,7 +32,8 @@ techdocs:
**2. GCP (Google Cloud Platform) Project**
Create or choose a dedicated GCP project. Set `techdocs.publisher.google.projectId` to the project ID.
Create or choose a dedicated GCP project. Set
`techdocs.publisher.google.projectId` to the project ID.
```yaml
techdocs:
@@ -41,13 +45,20 @@ techdocs:
**3. Service account API key**
Create a new Service Account and a key associated with it. In roles of the service account, use "Storage Admin".
Create a new Service Account and a key associated with it. In roles of the
service account, use "Storage Admin".
If you want to create a custom role, make sure to include both `get` and `create` permissions for both "Objects" and "Buckets". See https://cloud.google.com/storage/docs/access-control/iam-permissions
If you want to create a custom role, make sure to include both `get` and
`create` permissions for both "Objects" and "Buckets". See
https://cloud.google.com/storage/docs/access-control/iam-permissions
A service account can have many keys. Open your newly created account's page (in IAM & Admin console), and create a new key. Use JSON format for the key.
A service account can have many keys. Open your newly created account's page (in
IAM & Admin console), and create a new key. Use JSON format for the key.
A `<GCP-PROJECT-ID-random-uid>.json` file will be downloaded. This is the secret key TechDocs will use to make API calls. Make it available in your Backstage server and/or your local development server and set it in the app config `techdocs.publisher.google.pathToKey`.
A `<GCP-PROJECT-ID-random-uid>.json` file will be downloaded. This is the secret
key TechDocs will use to make API calls. Make it available in your Backstage
server and/or your local development server and set it in the app config
`techdocs.publisher.google.pathToKey`.
```yaml
techdocs:
@@ -60,8 +71,9 @@ techdocs:
**4. GCS Bucket**
Create a dedicated bucket for TechDocs sites. techdocs-backend will publish documentation to this bucket.
TechDocs will fetch files from here to serve documentation in Backstage.
Create a dedicated bucket for TechDocs sites. techdocs-backend will publish
documentation to this bucket. TechDocs will fetch files from here to serve
documentation in Backstage.
Set the name of the bucket to `techdocs.publisher
@@ -77,4 +89,5 @@ techdocs:
**5. That's it!**
Your Backstage app is now ready to use Google Cloud Storage for TechDocs, to store the static generated documentation files.
Your Backstage app is now ready to use Google Cloud Storage for TechDocs, to
store the static generated documentation files.