Skip to content

Commit ca8db43

Browse files
hmanwani-rhGitHub Actions
hmanwani-rh
authored and
GitHub Actions
committed
RHIDP-6149: Supported platform list in installation docs (#1054)
* RHIDP-6149: Supported platform list in installation docs * Review comment incorporated Configuring default configuration Configuring default configuration Configurable PVC mounting Configurable PVC mounting Incorporate technical suggestions Incorporate technical suggestions Configuring default configuration Configuring default configuration Configuring default configuration
1 parent 486782f commit ca8db43

File tree

6 files changed

+174
-7
lines changed

6 files changed

+174
-7
lines changed

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="assembly-configuring-default-secret-pvc-mounts_{context}"]
3+
= Configuring default mounts for Secrets and PVCs
4+
5+
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.
6+
7+
include::modules/configuring-external-databases/proc-configuring-mount-paths.adoc[leveloffset=+1]
8+
9+
include::modules/configuring-external-databases/proc-mounting-to-specific-containers.adoc[leveloffset=+1]

‎modules/configuring-external-databases/proc-configuring-default-configuration-for-secrets-and-pvcs.adoc‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
[id="proc-default-configuration-for-secrets-and-pvcs_{context}"]
3+
= Configuring default configuration for Secrets and PVCs
4+
5+
By default, the mount path is the {product-short} container's working directory, and if you do not define the mount path, it defaults to `/opt/app-root/src`. You can add the `rhdh.redhat.com/mount-path` annotation to your configuration file to specify the mount path.
6+
7+
.Procedure
8+
9+
. Specify the mount path where the PVC mounts to by adding the `rhdh.redhat.com/mount-path` annotation to your configuration as shown in the following example:
10+
+
11+
.Example specifying where the PVC mounts
12+
[source,yaml,subs="+attributes,+quotes"]
13+
----
14+
apiVersion: v1
15+
kind: PersistentVolumeClaim
16+
metadata:
17+
name: _<my_claim>_
18+
annotations:
19+
rhdh.redhat.com/mount-path: /mount/path/from/annotation
20+
----
21+
where:
22+
23+
`rhdh.redhat.com/mount-path`:: Specifies which mount path the PVC mounts to (in this case, `/mount/path/from/annotation` directory).
24+
<my_claim>:: Specifies the PVC to mount.
25+
26+
. Specify the mount path where the Secret mounts to by adding the `rhdh.redhat.com/mount-path` annotation to your configuration as shown in the following example:
27+
+
28+
.Example specifying where the Secret mounts
29+
[source,yaml,subs="+attributes,+quotes"]
30+
----
31+
apiVersion: v1
32+
kind: Secret
33+
metadata:
34+
name: _<my_secret>_
35+
annotations:
36+
rhdh.redhat.com/mount-path: /mount/path/from/annotation
37+
----
38+
where:
39+
40+
<my_secret>:: Specifies the Secret name.
41+
42+
. Use the following configuration to mount Secrets to all containers:
43+
+
44+
.Example configuration for mounting to all containers
45+
[source,yaml,subs="+attributes,+quotes"]
46+
----
47+
apiVersion: v1
48+
kind: Secret
49+
metadata:
50+
name: _<my_secret>_
51+
annotations:
52+
rhdh.redhat.com/containers: `*`
53+
----
54+
+
55+
[IMPORTANT]
56+
====
57+
Set `rhdh.redhat.com/containers` to `*` to mount it to all containers in the deployment.
58+
====
59+
60+
. Use commas to separate the list of containers (for example, `init-dynamic-plugins` and `,backstage-backend`) where the files mount to as shown in the following example:
61+
+
62+
.Example configuration for separating the list of containers
63+
[source,yaml,subs="+attributes,+quotes"]
64+
----
65+
apiVersion: v1
66+
kind: PersistentVolumeClaim
67+
metadata:
68+
name: myclaim
69+
annotations:
70+
rhdh.redhat.com/containers: "init-dynamic-plugins,backstage-backend"
71+
----
72+
+
73+
[NOTE]
74+
====
75+
The `myclaim` PVC mounts to the `init-dynamic-plugins` and `backstage-backend` containers.
76+
====

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

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
[id="proc-configure-mount-path-secrets-pvcs_{context}"]
3+
= Configuring mount paths for Secrets and PVCs
4+
5+
By default, the mount path is the {product-short} container's working directory. If you do not define the mount path, it defaults to `/opt/app-root/src`.
6+
7+
You can add the `rhdh.redhat.com/mount-path` annotation to specify a custom path.
8+
9+
.Procedure
10+
11+
. To specify a PVC mount path, add the `rhdh.redhat.com/mount-path` annotation to your configuration file as shown in the following example:
12+
+
13+
.Example specifying where the PVC mounts
14+
[source,yaml,subs="+attributes,+quotes"]
15+
----
16+
apiVersion: v1
17+
kind: PersistentVolumeClaim
18+
metadata:
19+
name: _<my_claim>_
20+
annotations:
21+
rhdh.redhat.com/mount-path: /mount/path/from/annotation
22+
----
23+
where:
24+
25+
`rhdh.redhat.com/mount-path`:: Specifies which mount path the PVC mounts to (in this case, `/mount/path/from/annotation` directory).
26+
<my_claim>:: Specifies the PVC to mount.
27+
28+
. To specify a Secret mount path, add the `rhdh.redhat.com/mount-path` annotation to your configuration file as shown in the following example:
29+
+
30+
.Example specifying where the Secret mounts
31+
[source,yaml,subs="+attributes,+quotes"]
32+
----
33+
apiVersion: v1
34+
kind: Secret
35+
metadata:
36+
name: _<my_secret>_
37+
annotations:
38+
rhdh.redhat.com/mount-path: /mount/path/from/annotation
39+
----
40+
where:
41+
42+
<my_secret>:: Specifies the Secret name.

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

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
[id="proc-mount-secrets-pvcs-specific-containers_{context}"]
3+
= Mounting Secrets and PVCs to specific containers
4+
5+
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.
6+
7+
.Procedure
8+
9+
. To mount Secrets to *all* containers, set the `rhdh.redhat.com/containers` annotation to `*`:
10+
+
11+
.Example mounting to all containers
12+
[source,yaml,subs="+attributes,+quotes"]
13+
----
14+
apiVersion: v1
15+
kind: Secret
16+
metadata:
17+
name: _<my_secret>_
18+
annotations:
19+
rhdh.redhat.com/containers: `*`
20+
----
21+
+
22+
[IMPORTANT]
23+
====
24+
Set `rhdh.redhat.com/containers` to `*` to mount it to all containers in the deployment.
25+
====
26+
27+
. To mount to specific containers, separate the names with commas:
28+
+
29+
.Example separating the list of containers
30+
[source,yaml,subs="+attributes,+quotes"]
31+
----
32+
apiVersion: v1
33+
kind: PersistentVolumeClaim
34+
metadata:
35+
name: myclaim
36+
annotations:
37+
rhdh.redhat.com/containers: "init-dynamic-plugins,backstage-backend"
38+
----
39+
+
40+
[NOTE]
41+
====
42+
This configuration mounts the `myclaim` PVC to the `init-dynamic-plugins` and `backstage-backend` containers.
43+
====

‎modules/installation/proc-install-operator.adoc‎

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,7 @@
55
[id="proc-install-operator_{context}"]
66
= Installing the {product} Operator
77

8-
As an administrator, you can install the {product} Operator. Authorized users can use the Operator to install {product} on the following platforms:
9-
10-
* {ocp-brand-name} ({ocp-short})
11-
* {eks-brand-name} ({eks-short})
12-
* {aks-brand-name} ({aks-short})
13-
14-
For more information on {ocp-short} supported versions, see the link:https://access.redhat.com/support/policy/updates/developerhub[{product} Life Cycle].
8+
As an administrator, you can install the {product} Operator. Authorized users can use the Operator to install {product} on {ocp-brand-name} ({ocp-short}) and supported Kubernetes platforms. For more information on supported platforms and versions, see the link:https://access.redhat.com/support/policy/updates/developerhub[{product} Life Cycle] page.
159

1610
Containers are available for the following CPU architectures:
1711

‎titles/configuring/master.adoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,5 +33,8 @@ include::modules/installation/proc-configuring-an-rhdh-instance-with-tls-in-kube
3333
include::modules/dynamic-plugins/con-dynamic-plugins-cache.adoc[ leveloffset=+1]
3434

3535

36+
include::assemblies/assembly-configuring-default-secret-pvc-mounts.adoc[leveloffset=+1]
37+
38+
3639
include::modules/dynamic-plugins/proc-installing-and-configuring-redis-cache.adoc[leveloffset=+1]
3740

0 commit comments

Comments
 (0)