Skip to content

Commit 7a0c124

Browse files
authored
RHIDP-1595: How to use HA in RHDH (redhat-developer#967)
* Added content and rectified an error in another proc * Added title * Changing using to configuring * Changing OCP to an attribute * Fixing build error * Alessandro's comment * Fixed typos * Fabrice's comments * Incorporated Lindsey's comments * Fabrice's comments * Fixing yaml issue * Minor change - Lindsey's comment
1 parent 7d82675 commit 7a0c124

6 files changed

+64
-3
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
:context: HighAvailability
3+
[id="{context}"]
4+
= Configuring high availability in {product}
5+
6+
Previously, {product} supports a single-instance application. With this configuration, if the instance fails due to software crashes, hardware issues, or other unexpected disruptions, the entire {product} service becomes unavailable, preventing the development workflows or access to the resources. With high availability, you receive a failover mechanism that ensures the service is available even if one or more components fail. By increasing the number of replicas, you introduce redundancy to help increase higher productivity and minimize disruption.
7+
8+
As an administrator, you can configure high availability in {product}. Once you set the high availability option in {product-short}, the {ocp-brand-name} built-in Load Balancer manages the ingress traffic and distributes the load to each pod. The {product-very-short} backend also manages concurrent requests or conflicts on the same resource.
9+
10+
You can configure high availability in {product-short} by scaling your `replicas` to a number greater than 1 in your configuration file. The configuration file that you use depends on the method that you used to install your {product-short} instance. If you used the Operator to install your {product-short} instance, configure the replica values in your `{product-custom-resource-type}` custom resource. If you used the Helm chart to install your {product-short} instance, configure the replica values in your Helm chart.
11+
12+
include::modules/configuring-high-availability/proc-configuring-high-availability-in-rhdh-operator-deployment.adoc[leveloffset=+1]
13+
14+
include::modules/configuring-high-availability/proc-configuring-high-availability-in-rhdh-helm-chart-deployment.adoc[leveloffset=+1]

assemblies/assembly-configuring-readonlyrootfilesystem.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ The {product} deployment consists of two containers: an `initContainer` that ins
88
* The {product} Operator
99
* The {product} Helm chart
1010
11-
include::modules/configuring-readonlyrootfilesystem/proc-configuring-readonlyrootfilesystem-option-in-rhdh-operator-deployment.adoc[leveloffset=+1]
11+
include::modules/configuring-readonlyrootfilesystem/proc-configuring-readonlyrootfilesystem-option-in-rhdh-operator-deployment.adoc[leveloffset=+1]
1212

13-
include::modules/configuring-readonlyrootfilesystem/proc-configuring-readonlyrootfilesystem-option-in-rhdh-helm-chart-deployment.adoc[leveloffset=+1]
13+
include::modules/configuring-readonlyrootfilesystem/proc-configuring-readonlyrootfilesystem-option-in-rhdh-helm-chart-deployment.adoc[leveloffset=+1]
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
[id="proc-configuring-high-availability-in-rhdh-helm-chart-deployment"]
2+
= Configuring high availability in a {product} Helm chart deployment
3+
4+
When you are deploying {product-short} using the Helm chart, you must set `replicas` to a value greater than `1` in your Helm chart. The default value for `replicas` is `1`.
5+
6+
.Procedure
7+
To configure your {product-short} Helm chart for high availability, complete the following step:
8+
9+
* In your Helm chart configuration file, set `replicas` to a value greater than `1`. For example:
10+
+
11+
====
12+
[source,yaml,subs="+attributes,+quotes"]
13+
----
14+
upstream:
15+
backstage:
16+
replicas: _<replicas_value>_ <1>
17+
----
18+
====
19+
<1> Set the number of replicas based on the number of backup instances that you want to configure.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
[id="proc-configuring-high-availability-in-rhdh-operator-deployment"]
2+
= Configuring High availability in a {product} Operator deployment
3+
4+
{product-very-short} instances that are deployed with the Operator use configurations in the `{product-custom-resource-type}` custom resource. In the `{product-custom-resource-type}` custom resource, the default value for the `replicas` field is `1`. If you want to configure your {product-very-short} instance for high availability, you must set `replicas` to a value greater than `1`.
5+
6+
7+
.Procedure
8+
9+
* In your `{product-custom-resource-type}` custom resource, set `replicas` to a value greater than `1`. For example:
10+
+
11+
====
12+
[source,yaml,subs="+attributes,+quotes"]
13+
----
14+
apiVersion: rhdh.redhat.com/v1alpha3
15+
kind: Backstage
16+
metadata:
17+
name: _<your_yaml_file>_
18+
spec:
19+
application:
20+
...
21+
replicas: _<replicas_value>_ <1>
22+
...
23+
----
24+
====
25+
<1> Set the number of replicas based on the number of backup instances that you want to configure.

modules/configuring-readonlyrootfilesystem/proc-configuring-readonlyrootfilesystem-option-in-rhdh-helm-chart-deployment.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
= Configuring the readOnlyRootFilesystem option in a {product} Helm chart deployment
33

44
.Procedure
5-
. In your 'values.yaml' file, add the `readOnlyRootFilesystem: true` line to the `containerSecurityContext` section. For example:
5+
. In your `values.yaml` file, add the `readOnlyRootFilesystem: true` line to the `containerSecurityContext` section. For example:
66
+
77
====
88
[source,yaml,subs="+attributes,+quotes"]

titles/configuring/master.adoc

+3
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ include::modules/configuring-deployment/proc-configuring-deployment-by-using-the
2121
include::assemblies/assembly-configuring-readonlyrootfilesystem.adoc[leveloffset=+1]
2222

2323

24+
include::assemblies/assembly-configuring-high-availability.adoc[leveloffset=+1]
25+
26+
2427
include::assemblies/assembly-configuring-a-proxy.adoc[leveloffset=+1]
2528

2629

0 commit comments

Comments
 (0)