Skip to content

Commit 844f1a0

Browse files
committed
clarity regarding mandatory vs. optional fields, work on vocabulary
Signed-off-by: Fabrice Flore-Thébault <[email protected]>
1 parent 9085e55 commit 844f1a0

File tree

1 file changed

+21
-12
lines changed

1 file changed

+21
-12
lines changed

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

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,18 @@ spec:
7575
----
7676
====
7777

78-
spec.application.appConfig.configMaps::
78+
Mandatory fields::
79+
80+
No fields are mandatory.
81+
You can create an empty {product-custom-resource-type} custom resource
82+
and run {product-short} with the default configuration.
83+
84+
Optional fields::
85+
86+
`spec.application.appConfig.configMaps`:::
7987
Enter your config map name list.
8088
+
81-
.Register the `{my-app-config-config-map}` config map.
89+
.Mount files in the `{my-app-config-config-map}` config map.
8290
====
8391
[source,yaml,subs="+attributes,+quotes"]
8492
----
@@ -91,7 +99,7 @@ spec:
9199
----
92100
====
93101
+
94-
.Register the `{my-app-config-config-map}` and `rbac-policies` config maps.
102+
.Mount files in the `{my-app-config-config-map}` and `rbac-policies` config maps.
95103
====
96104
[source,yaml,subs="+attributes,+quotes"]
97105
----
@@ -104,10 +112,11 @@ spec:
104112
- name: rbac-policies
105113
----
106114
====
107-
spec.application.extraEnvs.envs::
115+
116+
`spec.application.extraEnvs.envs`:::
108117
Optionally, enter your additional environment variables that are not secrets, such as xref:proc-configuring-proxy-in-operator-deployment_running-behind-a-proxy[your proxy environment variables].
109118
+
110-
.Register your `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables.
119+
.Inject your `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables.
111120
====
112121
[source,yaml,subs="+attributes,+quotes"]
113122
----
@@ -124,10 +133,10 @@ spec:
124133
----
125134
====
126135

127-
spec.application.extraEnvs.secrets::
136+
`spec.application.extraEnvs.secrets`:::
128137
Enter your environment variables secret name list.
129138
+
130-
.Register the `{my-product-secrets}` secret
139+
.Inject the environment variables in your `{my-product-secrets}` secret
131140
====
132141
[source,yaml,subs="+attributes,+quotes"]
133142
----
@@ -139,7 +148,7 @@ spec:
139148
----
140149
====
141150
+
142-
.Register the `{my-product-secrets}` and `{my-product-database-secrets}` secrets
151+
.Inject the envvironment variables in the `{my-product-secrets}` and `{my-product-database-secrets}` secrets
143152
====
144153
[source,yaml,subs="+attributes,+quotes"]
145154
----
@@ -152,10 +161,10 @@ spec:
152161
----
153162
====
154163

155-
spec.application.extraFiles.secrets::
164+
`spec.application.extraFiles.secrets`:::
156165
Enter your certificates files secret name and files list.
157166
+
158-
.Register the `{my-product-database-certificates-secrets}` secret containing the `postgres-crt.pem`, `postgres-ca.pem`, and `postgres-key.key` files
167+
.Mount the `postgres-crt.pem`, `postgres-ca.pem`, and `postgres-key.key` files contained in the `{my-product-database-certificates-secrets}` secret
159168
[source,yaml,subs="+attributes,+quotes"]
160169
----
161170
spec:
@@ -167,7 +176,7 @@ spec:
167176
key: postgres-crt.pem, postgres-ca.pem, postgres-key.key
168177
----
169178

170-
spec.database.enableLocalDb::
179+
`spec.database.enableLocalDb`:::
171180
Enable or disable the local PostgreSQL database.
172181
+
173182
.Disable the local PostgreSQL database generation to use an external postgreSQL database
@@ -186,7 +195,7 @@ spec:
186195
enableLocalDb: true
187196
----
188197

189-
spec.deployment::
198+
`spec.deployment`:::
190199
Optionally, xref:configuring-the-deployment[enter your deployment configuration].
191200

192201
. Apply your {product-custom-resource-type} custom resource to start or update your {product-short} instance.

0 commit comments

Comments
 (0)