Fix inconsistencies with referencing my-rhdh-secrets

Author: GitHub Actions

modules/configuring/proc-mounting-additional-files-in-your-custom-configuration-using-rhdh-operator.adoc

@@ -40,14 +40,14 @@ data:
 ----
 ====
 +
-.Minimal `{my-product-secrets}` Secret example
+.Minimal `_<my-product-secrets>_` Secret example
 ====
 [source,yaml,subs="+attributes,+quotes"]
 ----
 apiVersion: v1
 kind: Secret
 metadata:
-  name: `{my-product-secrets}`
+  name: `_<my-product-secrets>_`
 StringData:
   secret11.txt: |
     secret-content
@@ -69,9 +69,14 @@ spec:
           key: file12.txt
           mountPath: /my/my-rhdh-config-map/path
       secrets:
-        - name: `{my-product-secrets}`
+        - name: `_<my-product-secrets>_`
           key: secret11.txt
           mountPath: /my/my-rhdh-secret/path
 
 ----
 ====
+
+[NOTE]
+====
+Replace `<my-product-secrets>` with your {product-short} secret name.
+====

modules/configuring/proc-provisioning-your-custom-configuration.adoc

@@ -13,7 +13,7 @@ Your changes on this configuration might get reverted on {product-short} restart
 * By using the link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/cli_tools/index#cli-about-cli_cli-developer-commands[{openshift-cli}], you have access, with developer permissions, to the {ocp-short} cluster aimed at containing your {product-short} instance.
 
 .Procedure
-. Author your custom `{my-product-secrets}.txt` file to provision your secrets as environment variables values in an {ocp-short} secret, rather than in clear text in your configuration files.
+. Author your custom `_<my-product-secrets>_.txt` file to provision your secrets as environment variables values in an {ocp-short} secret, rather than in clear text in your configuration files.
 It contains one secret per line in `KEY=value` form.
 +
 * link:{authentication-book-url}[Enter your authentication secrets].
@@ -71,16 +71,21 @@ $ oc create configmap {my-app-config-config-map} --from-file={my-app-config-file
 +
 Alternatively, link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/nodes/index#nnodes-pods-configmap-create-from-console_configmaps[create the config map by using the web console].
 
-.. Provision your `{my-product-secrets}.txt` file to the `{my-product-secrets}` secret in the _<{my-product-namespace}>_ project.
+.. Provision your `_<my-product-secrets>_.txt` file to the `<my-product-secrets>` secret in the _<{my-product-namespace}>_ project.
 +
 [source,terminal,subs="+attributes,+quotes"]
 ----
-$ oc create secret generic `{my-product-secrets}` --from-file=`{my-product-secrets}.txt` --namespace={my-product-namespace}
+$ oc create secret generic `<my-product-secrets>` --from-file=`_<my-product-secrets>_.txt` --namespace={my-product-namespace}
 ----
 +
 Alternatively,
 link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/nodes/index#nodes-pods-secrets-creating-web-console-secrets_nodes-pods-secrets[create the secret by using the web console].
 
+[NOTE]
+====
+`<my-product-secrets>` is your preferred {product-short} secret name.
+====
+
 .Next steps
 Consider provisioning additional config maps and secrets:
 

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

@@ -31,7 +31,7 @@ spec:
          - name: {my-app-config-config-map}
     extraEnvs:
       secrets:
-         - name: `{my-product-secrets}`
+         - name: `<my-product-secrets>`
     extraFiles:
       mountPath: /opt/app-root/src
     replicas: 1
@@ -60,7 +60,7 @@ spec:
     dynamicPluginsConfigMapName: dynamic-plugins-rhdh
     extraEnvs:
       secrets:
-         - name: `{my-product-secrets}`
+         - name: `<my-product-secrets>`
          - name: {my-product-database-secrets}
     extraFiles:
       mountPath: /opt/app-root/src
@@ -136,31 +136,36 @@ spec:
 `spec.application.extraEnvs.secrets`:::
 Enter your environment variables secret name list.
 +
-.Inject the environment variables in your `{my-product-secrets}` secret
+.Inject the environment variables in your `<my-product-secrets>` secret
 ====
 [source,yaml,subs="+attributes,+quotes"]
 ----
 spec:
   application:
     extraEnvs:
       secrets:
-         - name: `{my-product-secrets}`
+         - name: `<my-product-secrets>`
 ----
 ====
 +
-.Inject the environment variables in the `{my-product-secrets}` and `{my-product-database-secrets}` secrets
+.Inject the environment variables in the `<my-product-secrets>` and `{my-product-database-secrets}` secrets
 ====
 [source,yaml,subs="+attributes,+quotes"]
 ----
 spec:
   application:
     extraEnvs:
       secrets:
-         - name: `{my-product-secrets}`
+         - name: `<my-product-secrets>`
          - name: {my-product-database-secrets}
 ----
 ====
 
+[NOTE]
+====
+Replace `<my-product-secrets>` with your {product-short} secret name.
+====
+
 `spec.application.extraFiles.secrets`:::
 Enter your certificates files secret name and files list.
 +

modules/customizing/proc-customizing-the-backend-secret.adoc

@@ -11,15 +11,15 @@ You can define your custom {product-short} backend secret.
 .Procedure
 
 . To define the {product-short} backend secret,
-add to your custom `{my-product-secrets}.txt` file the `BACKEND_SECRET` environment variable with a base64 encoded string.
-Use a unique value for each {product-short} instance.
+add to your custom `_<my-product-secrets>_.txt` file the `BACKEND_SECRET` environment variable with a base64 encoded string.
+Use a unique value for each {product-short} instance. _<release_name>_
 +
 [source,yaml,subs="+quotes,+attributes"]
 ----
-$ echo > `{my-product-secrets}.txt` "BACKEND_SECRET=$(node -p 'require("crypto").randomBytes(24).toString("base64")')"
+$ echo > `_<my-product-secrets>_.txt` "BACKEND_SECRET=$(node -p 'require("crypto").randomBytes(24).toString("base64")')"
 ----
 +
-.`{my-product-secrets}.txt` example
+.`_<my-product-secrets>_.txt` example
 ----
 BACKEND_SECRET=3E2/rIPuZNFCtYHoxVP8wjriffnN1q/z
 ----

modules/dynamic-plugins/proc-config-dynamic-plugins-rhdh-operator.adoc

@@ -10,7 +10,7 @@ You can store the configuration for dynamic plugins in a `ConfigMap` object that
 
 [NOTE]
 ====
-If the `pluginConfig` field references environment variables, you must define the variables in your `{my-product-secrets}` secret.
+If the `pluginConfig` field references environment variables, you must define the variables in your `_<my-product-secrets>_` secret.
 ====
 
 .Procedure

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

@@ -119,8 +119,8 @@ data:
 <1> The base URL to the Kubernetes control plane. You can run the `kubectl cluster-info` command to get the base URL.
 <2> Set the value of this parameter to `false` to enable the verification of the TLS certificate.
 <3> Optional: The link to the Kubernetes dashboard managing the ARO cluster.
-<4> Optional: Pass the service account token using a `K8S_SERVICE_ACCOUNT_TOKEN` environment variable that you define in your `{my-product-secrets}` secret.
-<5> Pass the CA data using a `K8S_CONFIG_CA_DATA` environment variable that you define in your `{my-product-secrets}` secret.
+<4> Optional: Pass the service account token using a `K8S_SERVICE_ACCOUNT_TOKEN` environment variable that you define in your `_<my-product-secrets>_` secret.
+<5> Pass the CA data using a `K8S_CONFIG_CA_DATA` environment variable that you define in your `_<my-product-secrets>_` secret.
 
 . Save the configuration changes.
 

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

@@ -44,19 +44,20 @@ data:
 ----
 --
 
-. Create a Secret named `{my-product-secrets}` and add a key named `BACKEND_SECRET` with a `Base64-encoded` string as value:
+. Create a `_<my-product-secrets>_` secret and add a key named `BACKEND_SECRET` with a `Base64-encoded` string as value:
 +
 --
 [source,yaml,subs="+attributes,+quotes"]
 ----
 apiVersion: v1
 kind: Secret
 metadata:
-  name: `{my-product-secrets}`
+  name: `_<my-product-secrets>_` # <1>
 stringData:
   # TODO: See https://backstage.io/docs/auth/service-to-service-auth/#setup
   BACKEND_SECRET: "xxx"
 ----
+<1> Replace `<my-product-secrets>` with a unique identifier for your secret configuration.
 
 [IMPORTANT]
 ====
@@ -103,8 +104,9 @@ spec:
         - name: "app-config-rhdh"
     extraEnvs:
       secrets:
-        - name: `{my-product-secrets}`
+        - name: `<my-product-secrets>` # <1>
 ----
+<1> Replace `<my-product-secrets>` with a unique identifier for your secret configuration.
 --
 
 . Create an Ingress resource using the following template, ensuring to customize the names as needed:

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

@@ -114,18 +114,19 @@ data:
 ----
 --
 
-. Create a secret named `{my-product-secrets}` and add a key named `BACKEND_SECRET` with a `Base64-encoded` string value as shown in the following example:
+. Create a `_<my-product-secrets>_` secret and add a key named `BACKEND_SECRET` with a `Base64-encoded` string value as shown in the following example:
 +
 --
 [source,yaml,subs="+quotes,+attributes"]
 ----
 apiVersion: v1
 kind: Secret
 metadata:
-  name: `{my-product-secret}`
+  name: `_<my-product-secrets>_` # <1>
 stringData:
   BACKEND_SECRET: "xxx"
 ----
+<1> Replace `<my-product-secrets>` with a unique identifier for your secret configuration.
 --
 
 . Create your `{product-custom-resource-type}` custom resource (CR) manifest file named `rhdh.yaml` and include the previously created `rhdh-pull-secret` as follows: