Skip to content

Commit 07441b2

Browse files
author
GitHub Actions
committed
Fix inconsistent reference to the app config file
Fix inconsistent reference to the app config file Fix inconsistent reference to the app config file Fix inconsistent reference to the app config file Fix inconsistent reference to the app config file
1 parent 78e21c3 commit 07441b2

File tree

33 files changed

+85
-85
lines changed

33 files changed

+85
-85
lines changed

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,10 @@ 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} ConfigMap such as `app-config-rhdh`, and add the following lines to the `{my-app-config-file}` content:
6767
+
6868
--
69-
.`app-config-rhdh.yaml` fragment with mandatory fields to enable authentication with GitHub
69+
.`{my-app-config-file}` fragment with mandatory fields to enable authentication with GitHub
7070
[source,yaml]
7171
----
7272
auth:
@@ -106,7 +106,7 @@ To enable authentication without requiring to provision users in the {product-sh
106106
+
107107
WARNING: Use `dangerouslyAllowSignInWithoutUserInCatalog` to explore {product-short} features, but do not use it in production.
108108
+
109-
.`app-config-rhdh.yaml` fragment with optional field to allow authenticating users absent from the software catalog
109+
.`{my-app-config-file}` fragment with optional field to allow authenticating users absent from the software catalog
110110
[source,yaml]
111111
----
112112
auth:
@@ -135,7 +135,7 @@ dangerouslyAllowSignInWithoutUserInCatalog: true
135135
The callback URL that GitHub uses when initiating an OAuth flow, such as: __<your_intermediate_service_url/handler>__.
136136
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.
137137
+
138-
.`app-config-rhdh.yaml` fragment with optional `enterpriseInstanceUrl` field
138+
.`{my-app-config-file}` fragment with optional `enterpriseInstanceUrl` field
139139
[source,yaml,subs="+quotes"]
140140
----
141141
auth:
@@ -150,7 +150,7 @@ auth:
150150
Your GitHub Enterprise URL.
151151
Requires you defined the `GITHUB_HOST_DOMAIN` secret in the previous step.
152152
+
153-
.`app-config-rhdh.yaml` fragment with optional `enterpriseInstanceUrl` field
153+
.`{my-app-config-file}` fragment with optional `enterpriseInstanceUrl` field
154154
[source,yaml,subs="+quotes"]
155155
----
156156
auth:
@@ -168,7 +168,7 @@ To enable GitHub integration with a different authentication provider, complete
168168
* Add the GitHub provider to the existing `auth` section.
169169
* Keep the `signInPage` section from your authentication provider configuration.
170170
171-
.`app-config-rhdh.yaml` fragment with mandatory fields to enable GitHub integration and use a different authentication provider
171+
.`{my-app-config-file}` fragment with mandatory fields to enable GitHub integration and use a different authentication provider
172172
[source,yaml,subs="+quotes"]
173173
----
174174
auth:

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +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`).
30+
* Optional custom scopes for the Microsoft Graph API that you define both in this section and in the {product-short} configuration (`{my-app-config-file}`).
3131
+
3232
[NOTE]
3333
====
@@ -50,10 +50,10 @@ To grant administrator consent, a directory administrator must go to the link:ht
5050
`AUTH_AZURE_CLIENT_ID`:: Enter your saved *Application (client) ID*.
5151
`AUTH_AZURE_CLIENT_SECRET`:: Enter your saved *Application (client) secret*.
5252

53-
. Set up the Microsoft Azure authentication provider in your {product-short} custom configuration, such as `app-config-rhdh`:
53+
. Set up the Microsoft Azure authentication provider in your {product-short} custom configuration, such as `{my-app-config-file}`:
5454
+
5555
--
56-
.`app-config-rhdh.yaml` fragment
56+
.`{my-app-config-file}` fragment
5757
[source,yaml,subs="+quotes,+attributes"]
5858
----
5959
auth:
@@ -84,7 +84,7 @@ To enable authentication without requiring to provision users in the {product-sh
8484
+
8585
WARNING: Use `dangerouslyAllowSignInWithoutUserInCatalog` to explore {product-short} features, but do not use it in production.
8686
+
87-
.`app-config-rhdh.yaml` fragment with optional field to allow authenticating users absent from the software catalog
87+
.`{my-app-config-file}` fragment with optional field to allow authenticating users absent from the software catalog
8888
[source,yaml]
8989
----
9090
auth:
@@ -106,7 +106,7 @@ If you want to use this parameter for a single-tenant application, uncomment and
106106
If your application registration is multi-tenant, leave this parameter blank.
107107
For more information, see link:https://learn.microsoft.com/en-us/azure/active-directory/manage-apps/home-realm-discovery-policy[Home Realm Discovery].
108108
+
109-
.`app-config-rhdh.yaml` fragment with optional `domainHint` field
109+
.`{my-app-config-file}` fragment with optional `domainHint` field
110110
[source,yaml,subs="+quotes,+attributes"]
111111
----
112112
auth:
@@ -122,7 +122,7 @@ Optional for additional scopes.
122122
To add scopes for the application registration, uncomment and enter the list of scopes that you want to add.
123123
The default and mandatory value lists: `'openid', 'offline_access', 'profile', 'email', 'User.Read'`.
124124
+
125-
.`app-config-rhdh.yaml` fragment with optional `additionalScopes` field
125+
.`{my-app-config-file}` fragment with optional `additionalScopes` field
126126
[source,yaml,subs="+quotes,+attributes"]
127127
----
128128
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}` section 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}` 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}` 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 the `{my-app-config-file}`, 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/configuring/proc-using-the-helm-chart-to-run-rhdh-with-your-custom-configuration.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ You can use the {product} Helm chart to add a custom application configuration f
2222
upstream:
2323
backstage:
2424
extraAppConfig:
25-
- configMapRef: {my-app-config-config-map}
25+
- configMapRef: {my-app-config-file}
2626
filename: {my-app-config-file}
2727
----
2828
.. Click *Upgrade*.

modules/configuring/proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ spec:
2828
appConfig:
2929
mountPath: /opt/app-root/src
3030
configMaps:
31-
- name: {my-app-config-config-map}
31+
- name: {my-app-config-file}
3232
extraEnvs:
3333
secrets:
3434
- name: {my-product-secrets}
@@ -55,7 +55,7 @@ spec:
5555
appConfig:
5656
mountPath: /opt/app-root/src
5757
configMaps:
58-
- name: {my-app-config-config-map}
58+
- name: {my-app-config-file}
5959
- name: rbac-policies
6060
dynamicPluginsConfigMapName: dynamic-plugins-rhdh
6161
extraEnvs:
@@ -86,7 +86,7 @@ Optional fields::
8686
`spec.application.appConfig.configMaps`:::
8787
Enter your config map name list.
8888
+
89-
.Mount files in the `{my-app-config-config-map}` config map.
89+
.Mount files in the `{my-app-config-file}` config map.
9090
====
9191
[source,yaml,subs="+attributes,+quotes"]
9292
----
@@ -95,11 +95,11 @@ spec:
9595
appConfig:
9696
mountPath: /opt/app-root/src
9797
configMaps:
98-
- name: {my-app-config-config-map}
98+
- name: {my-app-config-file}
9999
----
100100
====
101101
+
102-
.Mount files in the `{my-app-config-config-map}` and `rbac-policies` config maps.
102+
.Mount files in the `{my-app-config-file}` and `rbac-policies` config maps.
103103
====
104104
[source,yaml,subs="+attributes,+quotes"]
105105
----
@@ -108,7 +108,7 @@ spec:
108108
appConfig:
109109
mountPath: /opt/app-root/src
110110
configMaps:
111-
- name: {my-app-config-config-map}
111+
- name: {my-app-config-file}
112112
- name: rbac-policies
113113
----
114114
====

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
----

0 commit comments

Comments
 (0)