Skip to content

Commit a71e6bc

Browse files
authored
Fix inconsistent reference to the app config file (#1006)
1 parent 29474dd commit a71e6bc

File tree

30 files changed

+89
-76
lines changed

30 files changed

+89
-76
lines changed

modules/authentication/proc-enabling-authentication-with-github.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,9 @@ TIP: If you plan to make changes using the GitHub API, ensure that `Read and wri
6363
`GITHUB_WEBHOOK_URL`:: Enter your {product-short} URL: `pass:c,a,q[{my-product-url}]`.
6464
`GITHUB_WEBHOOK_SECRET`:: Enter the saved *Webhook secret*.
6565

66-
. To set up the GitHub authentication provider and enable integration with the GitHub API in your {product-short} custom configuration, edit your custom {product-short} ConfigMap such as `app-config-rhdh`, and add the following lines to the `app-config-rhdh.yaml` content:
66+
. To set up the GitHub authentication provider and enable integration with the GitHub API in your {product-short} custom configuration, edit your custom {product-short} config map such as `{my-app-config-config-map}`, and add the following lines to the `{my-app-config-file}` file content:
6767
+
68+
.`{my-app-config-file}` file fragment with mandatory fields to enable authentication with GitHub
6869
--
6970
.`app-config-rhdh.yaml` fragment with mandatory fields to enable authentication with GitHub
7071
[source,yaml]
@@ -135,7 +136,7 @@ dangerouslyAllowSignInWithoutUserInCatalog: true
135136
The callback URL that GitHub uses when initiating an OAuth flow, such as: __<your_intermediate_service_url/handler>__.
136137
Define it when {product-short} is not the immediate receiver, such as in cases when you use one OAuth app for many {product-short} instances.
137138
+
138-
.`app-config-rhdh.yaml` fragment with optional `enterpriseInstanceUrl` field
139+
.`{my-app-config-file}` file fragment with optional `enterpriseInstanceUrl` field
139140
[source,yaml,subs="+quotes"]
140141
----
141142
auth:
@@ -150,7 +151,7 @@ auth:
150151
Your GitHub Enterprise URL.
151152
Requires you defined the `GITHUB_HOST_DOMAIN` secret in the previous step.
152153
+
153-
.`app-config-rhdh.yaml` fragment with optional `enterpriseInstanceUrl` field
154+
.`{my-app-config-file}` file fragment with optional `enterpriseInstanceUrl` field
154155
[source,yaml,subs="+quotes"]
155156
----
156157
auth:
@@ -168,7 +169,7 @@ To enable GitHub integration with a different authentication provider, complete
168169
* Add the GitHub provider to the existing `auth` section.
169170
* Keep the `signInPage` section from your authentication provider configuration.
170171
171-
.`app-config-rhdh.yaml` fragment with mandatory fields to enable GitHub integration and use a different authentication provider
172+
.`{my-app-config-file}` file fragment with mandatory fields to enable GitHub integration and use a different authentication provider
172173
[source,yaml,subs="+quotes"]
173174
----
174175
auth:

modules/authentication/proc-enabling-authentication-with-microsoft-azure.adoc

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@
2727
* `openid`
2828
* `profile`
2929
* `User.Read`
30-
* Optional custom scopes for the Microsoft Graph API that you define both in this section and in the {product-short} configuration (`app-config-rhdh.yaml`).
31-
+
30+
* Optional custom scopes for the Microsoft Graph API that you define both in this section and in the `{my-app-config-file}` {product-short} configuration file.
3231
[NOTE]
3332
====
3433
Your company might require you to grant admin consent for these permissions.
@@ -50,10 +49,10 @@ To grant administrator consent, a directory administrator must go to the link:ht
5049
`AUTH_AZURE_CLIENT_ID`:: Enter your saved *Application (client) ID*.
5150
`AUTH_AZURE_CLIENT_SECRET`:: Enter your saved *Application (client) secret*.
5251

53-
. Set up the Microsoft Azure authentication provider in your {product-short} custom configuration, such as `app-config-rhdh`:
52+
. Set up the Microsoft Azure authentication provider in your `{my-app-config-file}` file:
5453
+
5554
--
56-
.`app-config-rhdh.yaml` fragment
55+
.`{my-app-config-file}` file fragment
5756
[source,yaml,subs="+quotes,+attributes"]
5857
----
5958
auth:
@@ -106,7 +105,7 @@ If you want to use this parameter for a single-tenant application, uncomment and
106105
If your application registration is multi-tenant, leave this parameter blank.
107106
For more information, see link:https://learn.microsoft.com/en-us/azure/active-directory/manage-apps/home-realm-discovery-policy[Home Realm Discovery].
108107
+
109-
.`app-config-rhdh.yaml` fragment with optional `domainHint` field
108+
.`{my-app-config-file}` file fragment with optional `domainHint` field
110109
[source,yaml,subs="+quotes,+attributes"]
111110
----
112111
auth:
@@ -122,7 +121,7 @@ Optional for additional scopes.
122121
To add scopes for the application registration, uncomment and enter the list of scopes that you want to add.
123122
The default and mandatory value lists: `'openid', 'offline_access', 'profile', 'email', 'User.Read'`.
124123
+
125-
.`app-config-rhdh.yaml` fragment with optional `additionalScopes` field
124+
.`{my-app-config-file}` file fragment with optional `additionalScopes` field
126125
[source,yaml,subs="+quotes,+attributes"]
127126
----
128127
auth:

modules/authorization/proc-configuring-the-RBAC-backend-plugin.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
[id="configuring-the-rbac-backend-plugin_{context}"]
22
= Configuring the RBAC backend plugin
33

4-
You can configure the RBAC backend plugin by updating the `app-config.yaml` file to enable the permission framework.
4+
You can configure the RBAC backend plugin by updating the `{my-app-config-file}` file to enable the permission framework.
55

66
.Prerequisites
77
* You have installed the `@janus-idp/backstage-plugin-rbac` plugin in {product-short}. For more information, see link:{plugins-configure-book-url}[{plugins-configure-book-title}].
88

99
.Procedure
10-
* Update the `app-config.yaml` file to enable the permission framework as shown:
10+
* Update the `{my-app-config-file}` file to enable the permission framework as shown:
1111

1212
[source,yaml,subs=+quotes]
1313
----
@@ -25,5 +25,5 @@ permission
2525

2626
[NOTE]
2727
====
28-
The `pluginsWithPermission` section of the `app-config.yaml` section includes only three plugins by default. Update the section as needed to include any additional plugins that also incorporate permissions.
28+
The `pluginsWithPermission` section of the `{my-app-config-file}` file includes only three plugins by default. Update the section as needed to include any additional plugins that also incorporate permissions.
2929
====

modules/authorization/proc-defining-authorizations-in-external-files-by-using-helm.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ name::: `rbac-policies`
9393

9494
. Update your {product-short} `{my-app-config-file}` configuration file to use the `rbac-policies.csv` and `rbac-conditional-policies.yaml` external files:
9595
+
96-
.`app-config.yml` fragment
96+
.`{my-app-config-file}` file fragment
9797
[source,yaml]
9898
----
9999
permission:

modules/authorization/proc-defining-authorizations-in-external-files-by-using-the-operator.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,9 @@ spec:
9090
- name: rbac-policies
9191
----
9292

93-
. Update your {product-short} `app-config.yaml` configuration file to use the `rbac-policies.csv` and `rbac-conditional-policies.yaml` external files:
93+
. Update your {product-short} `{my-app-config-file}` configuration file to use the `rbac-policies.csv` and `rbac-conditional-policies.yaml` external files:
9494
+
95-
.`app-config.yml` fragment
95+
.`{my-app-config-file}` file fragment
9696
[source,yaml]
9797
----
9898
permission:

modules/authorization/proc-enabling-the-rbac-plugin.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ plugins:
2525
See link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}].
2626

2727
. Declare policy administrators to enable a select number of authenticated users to configure RBAC policies through the REST API or Web UI, instead of modifying the CSV file directly.
28-
The permissions can be specified in a separate CSV file referenced in the `app-config-rhdh` ConfigMap, or permissions can be created using the REST API or Web UI.
28+
The permissions can be specified in a separate CSV file referenced in your `{my-app-config-config-map}` config map, or permissions can be created using the REST API or Web UI.
2929
+
3030
To declare users such as _<your_policy_administrator_name>_ as policy administrators, edit your custom {product-short} ConfigMap, such as `app-config-rhdh`, and add following code to the `{my-app-config-file}` content:
3131
+

modules/authorization/proc-setting-up-the-guest-authentication-provider.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ You can enable guest authentication and use it alongside the RBAC frontend plugi
88

99
.Procedure
1010

11-
* In the `app-config.yaml` file, add the user entity reference to resolve and enable the `dangerouslyAllowOutsideDevelopment` option, as shown in the following example:
11+
* In the `{my-app-config-file}` file, add the user entity reference to resolve and enable the `dangerouslyAllowOutsideDevelopment` option, as shown in the following example:
1212

1313
[source,yaml,subs="+attributes,+quotes"]
1414
----
@@ -22,5 +22,5 @@ auth:
2222

2323
[NOTE]
2424
====
25-
You can use `user:default/guest` as the user entity reference to match the added user under the `permission.rbac.admin.users` section of the `app-config.yaml` file.
25+
You can use `user:default/guest` as the user entity reference to match the added user under the `permission.rbac.admin.users` section of the `{my-app-config-file}` file.
2626
====

modules/customizing-templates/proc-adding-templates.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ You can add an existing template to your {product} instance by using the Catalog
1515
1616
.Procedure
1717

18-
* In the `app-config.yaml` configuration file, modify the `catalog.rules` section to include a rule for templates, and configure the `catalog.locations` section to point to the template that you want to add, as shown in the following example:
18+
* In the `{my-app-config-file}` configuration file, modify the `catalog.rules` section to include a rule for templates, and configure the `catalog.locations` section to point to the template that you want to add, as shown in the following example:
1919
+
2020
[source,yaml]
2121
----

modules/customizing-the-appearance/proc-customize-rhdh-branding-logo.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[id="proc-customize-rhdh-branding-logo_{context}"]
66
= Customizing the branding logo of your {product-short} instance
77

8-
You can customize the branding logo of your {product-short} instance by configuring the `branding` section the `app-config-rhdh.yaml` file, as shown in the following example:
8+
You can customize the branding logo of your {product-short} instance by configuring the `branding` section the `{my-app-config-file}` file, as shown in the following example:
99

1010
[source,yaml]
1111
----

modules/customizing-the-appearance/proc-customize-rhdh-font.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[id="proc-customize-rhdh-font_{context}"]
55
= Customizing the font for your {product-short} instance
66

7-
You can configure the `typography` section of the `app-config-rhdh.yaml` file to change the default font family and size of the page text, as well as the font family and size of each heading level, as shown in the following example:
7+
You can configure the `typography` section of the `{my-app-config-file}` file to change the default font family and size of the page text, as well as the font family and size of each heading level, as shown in the following example:
88

99
[source,yaml]
1010
----

0 commit comments

Comments
 (0)