You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
RHIDP-5372- Fix inconsistent reference to the app config file (redhat-developer#914)
* 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
* Fix inconsistent reference to the app config file
* Fix inconsistent reference to the app config file
* Apply peer suggestions
---------
Co-authored-by: GitHub Actions <[email protected]>
Copy file name to clipboardexpand all lines: modules/authentication/proc-enabling-authentication-with-github.adoc
+6-7
Original file line number
Diff line number
Diff line change
@@ -63,10 +63,9 @@ TIP: If you plan to make changes using the GitHub API, ensure that `Read and wri
63
63
`GITHUB_WEBHOOK_URL`:: Enter your {product-short} URL: `pass:c,a,q[{my-product-url}]`.
64
64
`GITHUB_WEBHOOK_SECRET`:: Enter the saved *Webhook secret*.
65
65
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:
67
-
.. Configure mandatory fields:
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:
68
67
+
69
-
.`app-config-rhdh.yaml` fragment with mandatory fields to enable authentication with GitHub
68
+
.`{my-app-config-file}` file fragment with mandatory fields to enable authentication with GitHub
70
69
[source,yaml]
71
70
----
72
71
auth:
@@ -99,7 +98,7 @@ signInPage: github # <3>
99
98
The callback URL that GitHub uses when initiating an OAuth flow, such as: __<your_intermediate_service_url/handler>__.
100
99
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.
101
100
+
102
-
.`app-config-rhdh.yaml` fragment with optional `enterpriseInstanceUrl` field
101
+
.`{my-app-config-file}` file fragment with optional `enterpriseInstanceUrl` field
103
102
[source,yaml,subs="+quotes"]
104
103
----
105
104
auth:
@@ -114,7 +113,7 @@ auth:
114
113
Your GitHub Enterprise URL.
115
114
Requires you defined the `GITHUB_HOST_DOMAIN` secret in the previous step.
116
115
+
117
-
.`app-config-rhdh.yaml` fragment with optional `enterpriseInstanceUrl` field
116
+
.`{my-app-config-file}` file fragment with optional `enterpriseInstanceUrl` field
118
117
[source,yaml,subs="+quotes"]
119
118
----
120
119
auth:
@@ -161,7 +160,7 @@ Configure the sign-in resolver to bypass the user provisioning requirement in th
161
160
+
162
161
WARNING: Use `dangerouslyAllowSignInWithoutUserInCatalog` to explore {product-short} features, but do not use it in production.
163
162
+
164
-
.`app-config-rhdh.yaml` fragment with optional field to allow signing in users absent from the software catalog
163
+
.`{my-app-config-file}` file fragment with optional field to allow signing in users absent from the software catalog
165
164
[source,yaml]
166
165
----
167
166
auth:
@@ -196,7 +195,7 @@ To enable GitHub integration with a different authentication provider, complete
196
195
* Add the GitHub provider to the existing `auth` section.
197
196
* Keep the `signInPage` section from your authentication provider configuration.
198
197
199
-
.`app-config-rhdh.yaml` fragment with mandatory fields to enable GitHub integration and use a different authentication provider
198
+
.`{my-app-config-file}` file fragment with mandatory fields to enable GitHub integration and use a different authentication provider
Copy file name to clipboardexpand all lines: modules/authentication/proc-enabling-authentication-with-microsoft-azure.adoc
+6-7
Original file line number
Diff line number
Diff line change
@@ -27,8 +27,7 @@
27
27
* `openid`
28
28
* `profile`
29
29
* `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.
32
31
[NOTE]
33
32
====
34
33
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
50
49
`AUTH_AZURE_CLIENT_ID`:: Enter your saved *Application (client) ID*.
51
50
`AUTH_AZURE_CLIENT_SECRET`:: Enter your saved *Application (client) secret*.
52
51
53
-
. Set up the Microsoft Azure authentication provider in your {product-short} custom configuration, such as `app-config-rhdh`:
54
-
.. Configure mandatory fields:
52
+
. Set up the Microsoft Azure authentication provider in your `{my-app-config-file}` file:
55
53
+
56
-
.`app-config-rhdh.yaml` fragment
54
+
--
55
+
.`{my-app-config-file}` file fragment
57
56
[source,yaml,subs="+quotes,+attributes"]
58
57
----
59
58
auth:
@@ -79,7 +78,7 @@ If you want to use this parameter for a single-tenant application, uncomment and
79
78
If your application registration is multi-tenant, leave this parameter blank.
80
79
For more information, see link:https://learn.microsoft.com/en-us/azure/active-directory/manage-apps/home-realm-discovery-policy[Home Realm Discovery].
81
80
+
82
-
.`app-config-rhdh.yaml` fragment with optional `domainHint` field
81
+
.`{my-app-config-file}` file fragment with optional `domainHint` field
83
82
[source,yaml,subs="+quotes,+attributes"]
84
83
----
85
84
auth:
@@ -95,7 +94,7 @@ Optional for additional scopes.
95
94
To add scopes for the application registration, uncomment and enter the list of scopes that you want to add.
96
95
The default and mandatory value lists: `'openid', 'offline_access', 'profile', 'email', 'User.Read'`.
97
96
+
98
-
.`app-config-rhdh.yaml` fragment with optional `additionalScopes` field
97
+
.`{my-app-config-file}` file fragment with optional `additionalScopes` field
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.
5
5
6
6
.Prerequisites
7
7
* 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}].
8
8
9
9
.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:
11
11
12
12
[source,yaml,subs=+quotes]
13
13
----
@@ -25,5 +25,5 @@ permission
25
25
26
26
[NOTE]
27
27
====
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.
Copy file name to clipboardexpand all lines: modules/authorization/proc-defining-authorizations-in-external-files-by-using-helm.adoc
+1-1
Original file line number
Diff line number
Diff line change
@@ -93,7 +93,7 @@ name::: `rbac-policies`
93
93
94
94
. Update your {product-short} `{my-app-config-file}` configuration file to use the `rbac-policies.csv` and `rbac-conditional-policies.yaml` external files:
Copy file name to clipboardexpand all lines: modules/authorization/proc-defining-authorizations-in-external-files-by-using-the-operator.adoc
+2-2
Original file line number
Diff line number
Diff line change
@@ -90,9 +90,9 @@ spec:
90
90
- name: rbac-policies
91
91
----
92
92
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:
Copy file name to clipboardexpand all lines: modules/authorization/proc-enabling-the-rbac-plugin.adoc
+1-1
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ plugins:
25
25
See link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}].
26
26
27
27
. 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.
29
29
+
30
30
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:
Copy file name to clipboardexpand all lines: modules/authorization/proc-setting-up-the-guest-authentication-provider.adoc
+2-2
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ You can enable guest authentication and use it alongside the RBAC frontend plugi
8
8
9
9
.Procedure
10
10
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:
12
12
13
13
[source,yaml,subs="+attributes,+quotes"]
14
14
----
@@ -22,5 +22,5 @@ auth:
22
22
23
23
[NOTE]
24
24
====
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.
Copy file name to clipboardexpand all lines: modules/customizing-templates/proc-adding-templates.adoc
+1-1
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ You can add an existing template to your {product} instance by using the Catalog
15
15
16
16
.Procedure
17
17
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:
= Customizing the branding logo of your {product-short} instance
7
7
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:
Copy file name to clipboardexpand all lines: modules/customizing-the-appearance/proc-customize-rhdh-font.adoc
+1-1
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
[id="proc-customize-rhdh-font_{context}"]
5
5
= Customizing the font for your {product-short} instance
6
6
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:
Copy file name to clipboardexpand all lines: modules/customizing-the-appearance/proc-customize-rhdh-page-theme.adoc
+1-1
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
[id="proc-customize-rhdh-page-theme_{context}"]
5
5
= Customizing the page theme header for your {product-short} instance
6
6
7
-
You can customize the header color for the light and dark theme modes in your {product-short} instance by modifying the `branding.theme` section of the `app-config-rhdh.yaml` file. You can also customize the page headers for additional {product-short} pages, such as the *Home*, *Catalog*, and *APIs* pages.
7
+
You can customize the header color for the light and dark theme modes in your {product-short} instance by modifying the `branding.theme` section of the `{my-app-config-file}` file. You can also customize the page headers for additional {product-short} pages, such as the *Home*, *Catalog*, and *APIs* pages.
Copy file name to clipboardexpand all lines: modules/customizing-the-appearance/proc-customize-rhdh-palette.adoc
+1-1
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
[id="proc-customize-rhdh-branding_{context}"]
5
5
= Customizing the theme mode color palettes for your {product-short} instance
6
6
7
-
You can customize the color palettes of the light and dark theme modes in your {product-short} instance by configuring the `light.palette` and `dark.palette` parameters in the `branding.theme` section of the `app-config-rhdh.yaml` file, as shown in the following example:
7
+
You can customize the color palettes of the light and dark theme modes in your {product-short} instance by configuring the `light.palette` and `dark.palette` parameters in the `branding.theme` section of the `{my-app-config-file}` file, as shown in the following example:
Copy file name to clipboardexpand all lines: modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc
+12-1
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,18 @@ The sidebar menu in {product} consists of two main parts that you can configure:
6
6
Dynamic plugin menu items:: Your preferences and your active plugins define dynamically one part of the sidebar menu.
7
7
Main menu items:: The core navigation structure of sidebar is static.
8
8
9
-
.Default static menu item configuration
9
+
* *Dynamic plugin menu items*: These items are displayed beneath the main menu and can be customized based on the plugins installed. The main menu items section is dynamic and can change based on your preferences and installed plugins.
10
+
11
+
.Procedure
12
+
13
+
. Customize the main menu items using the following steps:
14
+
+
15
+
--
16
+
.. Open the `{my-app-config-file}` file.
17
+
.. To customize the order and parent-child relationships for the main menu items, use the `dynamicPlugins.frontend.default.main-menu-items.menuItems` field.
18
+
.. For dynamic plugin menu items, use the `dynamicPlugins.frontend.<package_name>.menuItems` field.
Copy file name to clipboardexpand all lines: modules/customizing-the-appearance/ref-customize-rhdh-custom-components.adoc
+1-1
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ There are two component variants that you can use to customize various component
11
11
12
12
In addition to assigning a component variant to each parameter in the light or dark theme mode configurations, you can toggle the `rippleEffect` `on` or `off`.
13
13
14
-
The following code shows the options that you can use in the `app-config-rhdh.yaml` file to configure the theme components for your {product-short} instance:
14
+
The following code shows the options that you can use in the link:{configuring-book-url}[`{my-app-config-file}` file] to configure the theme components for your {product-short} instance:
You can use the default Backstage theme configurations to make your {product-short} instance look like a standard Backstage instance. You can also modify the `app-config-rhdh.yaml` file to customize or disable particular parameters.
7
+
You can use the default Backstage theme configurations to make your {product-short} instance look like a standard Backstage instance. You can also modify the `{my-app-config-file}` file to customize or disable particular parameters.
8
8
9
9
== Default Backstage theme color palette
10
10
11
-
The `app-config-rhdh.yaml` file uses the following configurations for the default Backstage color palette:
11
+
The `{my-app-config-file}` file uses the following configurations for the default Backstage color palette:
12
12
13
13
[source,yaml]
14
14
----
@@ -138,7 +138,7 @@ app:
138
138
warningText: "#000000"
139
139
----
140
140
141
-
Alternatively, you can use the following `variant` and `mode` values in the `app-config-rhdh.yaml` file to apply the previous default configuration:
141
+
Alternatively, you can use the following `variant` and `mode` values in the `{my-app-config-file}` file to apply the previous default configuration:
142
142
143
143
[source,yaml]
144
144
----
@@ -155,7 +155,7 @@ app:
155
155
156
156
== Default Backstage page themes
157
157
158
-
The default Backstage header color is white in light mode and black in dark mode, as shown in the following `app-config-rhdh.yaml` file configuration:
158
+
The default Backstage header color is white in light mode and black in dark mode, as shown in the following `{my-app-config-file}` file configuration:
Copy file name to clipboardexpand all lines: modules/customizing-the-appearance/ref-customize-rhdh-default-rhdh.adoc
+4-4
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,11 @@
4
4
[id="ref-customize-rhdh-default-rhdh_{context}"]
5
5
= Default {product} theme
6
6
7
-
You can use the default {product} theme configurations to make your {product-short} instance look like a standard {product} instance. You can also modify the `app-config-rhdh.yaml` file to customize or disable particular parameters.
7
+
You can use the default {product} theme configurations to make your {product-short} instance look like a standard {product} instance. You can also modify the `{my-app-config-file}` file to customize or disable particular parameters.
8
8
9
9
== Default {product} theme color palette
10
10
11
-
The `app-config-rhdh.yaml` file uses the following configurations for the default {product} color palette:
11
+
The `{my-app-config-file}` file uses the following configurations for the default {product} color palette:
12
12
13
13
[source,yaml]
14
14
----
@@ -202,7 +202,7 @@ app:
202
202
headerBackgroundImage: "none"
203
203
----
204
204
205
-
Alternatively, you can use the following `variant` and `mode` values in the `app-config-rhdh.yaml` file to apply the previous default configuration:
205
+
Alternatively, you can use the following `variant` and `mode` values in the `{my-app-config-file}` file to apply the previous default configuration:
206
206
207
207
[source,yaml]
208
208
----
@@ -219,7 +219,7 @@ app:
219
219
220
220
== Default {product} page themes
221
221
222
-
The default {product-short} header color is white in light mode and black in dark mode, as shown in the following `app-config-rhdh.yaml` file configuration:
222
+
The default {product-short} header color is white in light mode and black in dark mode, as shown in the following `{my-app-config-file}` file configuration:
Copy file name to clipboardexpand all lines: modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc
+2-2
Original file line number
Diff line number
Diff line change
@@ -14,8 +14,8 @@ The Home page uses a 12-column grid to position your cards. You can use the opti
14
14
** position (x and y)
15
15
16
16
.Procedure
17
-
. Configure the layout of the cards on the home page by entering one of the following configurations in your {product-short} `{my-app-config-file}` file.
18
-
* Use the full space on smaller windows and half of the space on larger windows as shown in the following example:
17
+
* Configure your {product-short} `{my-app-config-file}` configuration file by choosing one of the following options:
18
+
** Use the full space on smaller windows and half of the space on larger windows as follows:
Copy file name to clipboardexpand all lines: modules/customizing-the-quick-access-card/proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc
+5-5
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ To use the `red-hat-developer-hub-customization-provider` service, add the URL f
36
36
*Target Port* automatically generates a Kubernetes or {ocp-short} service to communicate with.
37
37
====
38
38
+
39
-
. Add the following code to the `app-config-rhdh.yaml` file:
39
+
. Add the following code to the link:{configuring-book-url}[`{my-app-config-file}` file]:
40
40
+
41
41
[source,yaml]
42
42
----
@@ -54,7 +54,7 @@ proxy:
54
54
+
55
55
[NOTE]
56
56
====
57
-
The `red-hat-developer-hub-customization-provider` service contains the 8080 port by default. If you are using a custom port, you can specify it with the 'PORT' environmental variable in the `app-config-rhdh.yaml` file.
57
+
The `red-hat-developer-hub-customization-provider` service contains the 8080 port by default. If you are using a custom port, you can specify it with the 'PORT' environmental variable in the `{my-app-config-file}` file.
58
58
====
59
59
+
60
60
. Replace the `HOMEPAGE_DATA_URL` by adding the URL to `rhdh-secrets` or by directly replacing it in your custom ConfigMap.
@@ -111,14 +111,14 @@ If the request call fails or is not configured, the {product-short} instance fal
111
111
112
112
* If the images or icons do not load, then allowlist them by adding your image or icon host URLs to the content security policy (csp) `img-src` in your custom ConfigMap as shown in the following example:
0 commit comments