Skip to content

Commit 3c74607

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

9 files changed

+21
-21
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ 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 `{my-app-config-file}`:
53+
. Set up the Microsoft Azure authentication provider in your `{my-app-config-file}` file:
5454
+
5555
--
5656
.`{my-app-config-file}` fragment

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 `{my-app-config-file}`, 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/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-file}
25+
- configMapRef: {my-app-config-config-map}
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-file}
31+
- name: {my-app-config-config-map}
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-file}
58+
- name: {my-app-config-config-map}
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-file}` config map.
89+
.Mount files in the `{my-app-config-config-map}` 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-file}
98+
- name: {my-app-config-config-map}
9999
----
100100
====
101101
+
102-
.Mount files in the `{my-app-config-file}` and `rbac-policies` config maps.
102+
.Mount files in the `{my-app-config-config-map}` 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-file}
111+
- name: {my-app-config-config-map}
112112
- name: rbac-policies
113113
----
114114
====

modules/installation/proc-configuring-an-rhdh-instance-with-tls-in-kubernetes.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,9 @@ The `backstage-plugin-kubernetes` plugin is currently in link:https://access.red
8080
kind: ConfigMap
8181
apiVersion: v1
8282
metadata:
83-
name: {my-app-config-file}
83+
name: {my-app-config-config-map}
8484
data:
85-
{my-app-config-file}: |
85+
"{my-app-config-file}": |
8686
# ...
8787
  catalog:
8888
    rules:

modules/installation/proc-deploy-rhdh-instance-eks.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@
2525
apiVersion: v1
2626
kind: ConfigMap
2727
metadata:
28-
name: {my-app-config-file}
28+
name: {my-app-config-config-map}
2929
data:
30-
{my-app-config-file}: |
30+
"{my-app-config-file}": |
3131
app:
3232
title: {product}
3333
baseUrl: https://<rhdh_dns_name>
@@ -100,7 +100,7 @@ spec:
100100
enabled: false
101101
appConfig:
102102
configMaps:
103-
- name: {my-app-config-file}
103+
- name: {my-app-config-config-map}
104104
extraEnvs:
105105
secrets:
106106
- name: {my-product-secrets}

modules/installation/proc-deploy-rhdh-instance-gke.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ You need to create an `A` record with the value equal to the IP address. This pr
2626
apiVersion: v1
2727
kind: ConfigMap
2828
metadata:
29-
name: {my-app-config-file}
29+
name: {my-app-config-config-map}
3030
data:
31-
{my-app-config-file}: |
31+
"{my-app-config-file}": |
3232
app:
3333
title: Red Hat Developer Hub
3434
baseUrl: https://<rhdh_domain_name>
@@ -103,7 +103,7 @@ spec:
103103
enabled: false
104104
appConfig:
105105
configMaps:
106-
- name: {my-app-config-file}
106+
- name: {my-app-config-config-map}
107107
extraEnvs:
108108
secrets:
109109
- name: {my-product-secret}

modules/installation/proc-install-rhdh-ocp-helm-gui.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Your `developer-hub` pod might be in a `CrashLoopBackOff` state if the {product-
6868
6969
[source,log]
7070
----
71-
Loaded config from `{my-app-config-file}`, env
71+
Loaded config from app-config-from-configmap.yaml, env
7272
...
7373
2023-07-24T19:44:46.223Z auth info Configuring "database" as KeyStore provider type=plugin
7474
Backend failed to start up Error: Missing required config value at 'backend.database.client'

modules/installation/proc-rhdh-deploy-aks-operator.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,15 +87,15 @@ kubectl -n <your_namespace> apply -f rhdh-ingress.yaml
8787
----
8888
--
8989

90-
. Create a `{my-app-config-file}` containing the {product-short} configuration using the following example:
90+
. Create a `{my-app-config-config-map}` config map containing the {product-short} configuration using the following example:
9191
+
9292
--
9393
[source,yaml,subs="+attributes"]
9494
----
9595
apiVersion: v1
9696
kind: ConfigMap
9797
metadata:
98-
name: {my-app-config-file}
98+
name: {my-app-config-config-map}
9999
data:
100100
{my-app-config-file}: |
101101
app:
@@ -143,7 +143,7 @@ spec:
143143
- rhdh-pull-secret
144144
appConfig:
145145
configMaps:
146-
- name: {my-app-config-file}
146+
- name: {my-app-config-config-map}
147147
extraEnvs:
148148
secrets:
149149
- name: {my-product-secret}

0 commit comments

Comments
 (0)