RHIDP-4780: Document per-ConfigMap/Secret configuration of mountPath (#842)

* Content added

* Fixing indentation error

* Incorporated comments

* Incorporated comments

* Incorporated comments

* Update ref-release-notes-new-features.adoc

---------

Co-authored-by: Gerry-Forde <[email protected]>

Author: pabel-rh

artifacts/attributes.adoc

@@ -28,6 +28,7 @@
 :my-product-database-certificates-secrets: my-rhdh-database-certificates-secrets
 :my-product-database-secrets: my-rhdh-database-secrets
 :my-product-url: https://__<my_developer_hub_url>__
+:my-extra-file-configmap: my-project-configmap
 
 // Red Hat Platforms
 :ocp-brand-name: Red Hat OpenShift Container Platform

assemblies/assembly-provisioning-a-custom-configuration.adoc

@@ -22,6 +22,7 @@ include::modules/configuring/proc-provisioning-your-custom-configuration.adoc[le
 
 include::modules/configuring/proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc[leveloffset=+1]
 
+include::modules/configuring/proc-mounting-additional-files-in-your-custom-configuration-using-rhdh-operator.adoc[leveloffset=+2]
 
 include::modules/configuring/proc-using-the-helm-chart-to-run-rhdh-with-your-custom-configuration.adoc[leveloffset=+1]
 

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

@@ -0,0 +1,77 @@
+[id="mounting-additional-files-in-your-custom-configuration-using-rhdh-operator"]
+= Mounting additional files in your custom configuration using the {product} operator
+
+You can use the {product-short} Operator to mount extra files, such as a ConfigMap or Secret, to the container in a preferred location.
+
+The `mountPath` field specifies the location where a ConfigMap or Secret is mounted. The behavior of the mount, whether it includes or excludes a `subPath`, depends on the specification of the `key` or `mountPath` fields.
+
+* If `key` and `mountPath` are not specified: Each key or value is mounted as a `filename` or content with a `subPath`.
+* If `key` is specified with or without `mountPath`: The specified key or value is mounted with a `subPath`.
+* If only `mountPath` is specified: A directory containing all the keys or values is mounted without a `subPath`.
+
+[NOTE]
+====
+* {ocp-short} does not automatically update a volume mounted with `subPath`. By default, the {product-very-short} operator monitors these ConfigMaps or Secrets and refreshes the {product-very-short} Pod when changes occur.
+* For security purposes, {product} does not give the Operator Service Account read access to Secrets. As a result, mounting files from Secrets without specifying both mountPath and key is not supported.
+====
+
+
+.Prerequisites
+* You have developer permissions to access the {ocp-short} cluster containing your {product-short} instance using the {openshift-cli}.
+* link:{installing-on-ocp-book-url}[Your {ocp-short} administrator has installed the {product} Operator in {ocp-short}].
+
+.Procedure
+
+. In {ocp-short}, create your ConfigMap or Secret with the following YAML codes:
++
+.Minimal `{my-extra-file-configmap}` ConfigMap example
+====
+[source,yaml,subs="+attributes,+quotes"]
+----
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: {my-extra-file-configmap}
+data:
+  file11.txt: |
+    My file11 content
+  file 12.txt: |
+    My file12 content
+----
+====
++
+.Minimal `{my-product-secrets}` Secret example
+====
+[source,yaml,subs="+attributes,+quotes"]
+----
+apiVersion: v1
+kind: Secret
+metadata:
+  name: {my-product-secrets}
+StringData:
+  secret11.txt: |
+    secret-content
+----
+====
+For more information, see xref:provisioning-your-custom-configuration[Provisioning and using your custom {product} configuration].
+
+. Set the value of the `configMaps name` to the name of the ConfigMap or `secrets name` to the name of the Secret in your `{product-custom-resource-type}` CR. For example:
++
+====
+[source,yaml,subs="+attributes,+quotes"]
+----
+spec:
+  application:
+    extraFiles:
+      mountPath: /my/path
+      configMaps:
+        - name: {my-extra-file-configmap}
+          key: file12.txt
+          mountPath: /my/my-rhdh-config-map/path
+      secrets:
+        - name: {my-product-secrets}
+          key: secret11.txt
+          mountPath: /my/my-rhdh-secret/path
+
+----
+====

modules/release-notes/ref-release-notes-new-features.adoc

@@ -7,7 +7,7 @@ This section highlights new features in {product} {product-version}.
 [id="enhancement-rhidp-2200"]
 == Added an individual `mountPath`
 
-This update adds an additional individual `mountPath` for extra configmaps or secrets.
+This update adds an individual `mountPath` for link:{configuring-book-url}#proc-mounting-additional-files-in-your-custom-configuration-using-rhdh-operator[extra ConfigMaps or Secrets].
 
 [id="feature-rhidp-3621"]
 == `PersistentVolumeClaims` support is available
@@ -27,25 +27,24 @@ This update removes the `kube-rbac-proxy` sidecar container from the RHDH Operat
 [id="feature-rhidp-4414"]
 == Identifying Backstage flavor for plugins by using the `developerHub.flavor` field
 
-With this update, you can use the `developerHub.flavor` field to identify whether plugins are running on {product-very-short}, {rhtap-very-short}, or vanilla Backstage, as shown in the following example:
-
-.`app-config.yaml` fragment with the `developerhub.flavor` field
-
-[source,yaml,subs="quotes"]
-----
-developerHub:
-  flavor: <flavor>;
-----
-
-`flavor`::
-Identify the flavor of Backstage that is running. Default value: `rhdh`
+With this update, you can use the `developerHub.flavor` field to identify whether plugins are running on {product-very-short}, {rhtap-very-short}, or vanilla Backstage, as shown in the following example:
+
+.`app-config.yaml` fragment with the `developerhub.flavor` field
+
+[source,yaml,subs="+quotes"]
+----
+developerHub:
+  flavor: <flavor>;
+----
+
+`flavor`::
+Identify the flavor of Backstage that is running. Default value: `rhdh`
 
 
 [id="feature-rhidp-4419"]
 == Ability to manage PVCs in RHDH Operator
 
-You can now mount directories from pre-created PersistentVolumeClaims (PVCs) using the `spec.application.extraFiles.pvcs` field, while configuring RHDH Operator.
-For more information, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html-single/configuring/index#configuring-the-deployment[Persistent Volume Claim (PVC)].
+You can now mount directories from pre-created PersistentVolumeClaims (PVCs) using the `spec.application.extraFiles.pvcs` field, while configuring {product-very-short} Operator.
 
 
 [id="feature-rhidp-4805"]
@@ -56,8 +55,8 @@ With this update, you can use {rhbk-brand-name} as an authentication provider. T
 [id="feature-rhidp-4806"]
 == Ability to install third-party plugins in RHDH
 
-You can now install third-party plugins in {product} without rebuilding the {product-very-short} application.
-
+You can now install third-party plugins in {product} without rebuilding the {product-very-short} application.
+
 For more information, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html-single/introduction_to_plugins/index[Third party plugins].
 
 [id="feature-rhidp-5156"]