Default pvc and secret config

Author: GitHub Actions

assemblies/assembly-configuring-default-secret-pvc-mounts.adoc

@@ -0,0 +1,9 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="assembly-configuring-default-secret-pvc-mounts_{context}"]
+= Configuring default mounts for Secrets and PVCs
+
+You can configure where Persistent Volume Claims (PVCs) and Secrets mount in your {product} deployment. Use annotations to define the custom mount paths and specify the containers to mount them to.
+
+include::modules/configuring-external-databases/proc-configuring-mount-paths.adoc[leveloffset=+1]
+
+include::modules/configuring-external-databases/proc-mounting-to-specific-containers.adoc[leveloffset=+1]

modules/configuring-external-databases/proc-configuring-mount-paths.adoc

@@ -0,0 +1,64 @@
+[id="proc-mount-directories-pvcs_{context}"]
+= Mounting directories from pre-created PVCs
+
+Starting from `v1alpha3`, you can mount directories from pre-created PersistentVolumeClaims (PVCs) using the `spec.application.extraFiles.pvcs` field.
+
+.Prerequisites
+* You have understanding of the mounting logic:
+** If `spec.application.extraFiles.pvcs[].mountPath` is defined, the PVC is mounted to the specified path.
+** If `spec.application.extraFiles.pvcs[].mountPath` is not defined, the PVC is mounted under the path specified in `spec.application.extraFiles.mountPath/`.
+** If `mountPath` is not defined, the PVC defaults to `/opt/app-root/src`, or you can use the {product-very-short} container's working directory if it is specified.
+
+.Procedure
+. Define the PVCs using the following YAML example:
++
+--
+.Example YAML file to define PVCs
+[source,yaml]
+----
+apiVersion: v1  
+kind: PersistentVolumeClaim  
+metadata:  
+  name: myclaim1  
+spec:  
+  accessModes:  
+    - ReadWriteOnce  
+  resources:  
+    requests:  
+      storage: 2Gi  
+---  
+apiVersion: v1  
+kind: PersistentVolumeClaim  
+metadata:  
+  name: myclaim2  
+spec:  
+  accessModes:  
+    - ReadWriteOnce  
+  resources:  
+    requests:  
+      storage: 2Gi 
+----
+--
+
+. Use the following configuration to specify how the PVCs are mounted in the container:
++
+--
+.Example configuration for mounting PVCs in a container
+[source,yaml]
+----
+spec:  
+  application:  
+    extraFiles:  
+      mountPath: /my/path  
+      pvcs:  
+        - name: myclaim1  
+        - name: myclaim2  
+          mountPath: /vol/my/claim
+----
+--
+
+.Verification
+Based on the configuration, the following directories are mounted in the container:
+
+* `/my/path/myclaim1`
+* `/vol/my/claim`

modules/configuring-external-databases/proc-mounting-to-specific-containers.adoc

@@ -0,0 +1,43 @@
+:_mod-docs-content-type: PROCEDURE
+[id="proc-mount-secrets-pvcs-specific-containers_{context}"]
+= Mounting Secrets and PVCs to specific containers
+
+By default, Secrets and PVCs mount only to the {product} `backstage-backend` container. You can add the `rhdh.redhat.com/containers` annotation to your configuration file to specify the containers to mount to.
+
+.Procedure
+
+. To mount Secrets to *all* containers, set the `rhdh.redhat.com/containers` annotation to `*`:
++
+.Example mounting to all containers
+[source,yaml,subs="+attributes,+quotes"]
+----
+apiVersion: v1
+kind: Secret
+metadata:
+  name: _<my_secret>_
+  annotations:
+    rhdh.redhat.com/containers: `*`
+----
++
+[IMPORTANT]
+====
+Set `rhdh.redhat.com/containers` to `*` to mount it to all containers in the deployment.
+====
+
+. To mount to specific containers, separate the names with commas:
++
+.Example separating the list of containers
+[source,yaml,subs="+attributes,+quotes"]
+----
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: myclaim
+  annotations:
+    rhdh.redhat.com/containers: "init-dynamic-plugins,backstage-backend"
+----
++
+[NOTE]
+====
+This configuration mounts the `myclaim` PVC to the `init-dynamic-plugins` and `backstage-backend` containers.
+====

titles/configuring/master.adoc

@@ -33,5 +33,8 @@ include::modules/installation/proc-configuring-an-rhdh-instance-with-tls-in-kube
 include::modules/dynamic-plugins/con-dynamic-plugins-cache.adoc[ leveloffset=+1]
 
 
+include::assemblies/assembly-configuring-default-secret-pvc-mounts.adoc[leveloffset=+1]
+
+
 include::modules/dynamic-plugins/proc-installing-and-configuring-redis-cache.adoc[leveloffset=+1]