From c28af0f5ef82f02a368a96904b529145070a568e Mon Sep 17 00:00:00 2001 From: Tiago Barbosa Date: Fri, 16 Aug 2024 09:45:02 +0100 Subject: [PATCH] docs: improving documentation for oauth config Signed-off-by: Tiago Barbosa --- docs/getting-started/backstage.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/docs/getting-started/backstage.md b/docs/getting-started/backstage.md index ef89861..8b362f8 100644 --- a/docs/getting-started/backstage.md +++ b/docs/getting-started/backstage.md @@ -176,11 +176,17 @@ pagerDuty: oauth: clientId: ${PD_CLIENT_ID} clientSecret: ${PD_CLIENT_SECRET} - subDomain: ${PD_ACCOUNT_SUBDOMAIN} - region: ${PD_ACCOUNT_REGION} // Optional. allowed values: 'us', 'eu'. - // Defaults to 'us'. + subDomain: ${PD_ACCOUNT_SUBDOMAIN} + region: ${PD_ACCOUNT_REGION} // Optional. + // Allowed values: 'us', 'eu'. + // Defaults to 'us'. ``` +!!! note + The `subDomain` property requires only the first segment of your PagerDuty account url. **Example:** If your PagerDuty account url is `https://myaccount.pagerduty.com` then your `subDomain` value should be `myaccount`. + + Configuring it with an invalid value might cause authentication to fail. + #### REST API Token In `app-config.yaml` file add the following configuration to set your REST API Token: @@ -212,7 +218,7 @@ pagerDuty: oauth: clientId: ${PD_CLIENT_ID_1} clientSecret: ${PD_CLIENT_SECRET_1} - subDomain: ${PD_ACCOUNT_SUBDOMAIN_!} + subDomain: ${PD_ACCOUNT_SUBDOMAIN_1} region: ${PD_ACCOUNT_REGION_1} // Optional. allowed values: 'us', 'eu'. // Defaults to 'us'. - id: ${PD_ACCOUNT_SUBDOMAIN_2} @@ -223,6 +229,11 @@ pagerDuty: subDomain: ${PD_ACCOUNT_SUBDOMAIN_2} ``` +!!! note + The `subDomain` property requires only the first segment of your PagerDuty account url. **Example:** If your PagerDuty account url is `https://myaccount.pagerduty.com` then your `subDomain` value should be `myaccount`. + + Configuring it with an invalid value might cause authentication to fail. + #### REST API Token In `app-config.yaml` file add the following configuration to set your REST API Token: