Skip to content

Commit 256a7f8

Browse files
committed
doc: Merged doc improvements
Signed-off-by: Alejandro Villegas <[email protected]>
1 parent 1c94eb9 commit 256a7f8

File tree

1 file changed

+66
-28
lines changed

1 file changed

+66
-28
lines changed

content/patterns/regional-dr/_index.md

Lines changed: 66 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -16,49 +16,68 @@ links:
1616

1717
# OpenShift Regional DR
1818

19-
The _Regional DR Validated Pattern for [Red Hat OpenShift][ocp]_ can increase the resiliency
20-
of your applications by connecting multiple clusters across various regions. This pattern
19+
The _Regional DR Validated Pattern for [Red Hat OpenShift][ocp]_ increases the resiliency
20+
of your applications by connecting multiple clusters across different regions. This pattern
2121
uses [Red Hat Advanced Cluster Management][acm] to offer a
2222
[Red Hat OpenShift Data Foundation][odf]-based multi-region disaster recovery plan if an
2323
entire region fails.
2424

2525
## Background
2626

27-
[Red Hat OpenShift Data Foundation][odf] offers two solutions for disaster recovery:
28-
[Metro DR][mdr] and [Regional DR][rdr]. As their name suggests, _Metro DR_ refers to
29-
a metropolitan area disasters, which occur when the disaster covers only a single area
30-
in a region (availability zone), and _Regional DR_ refers to when the entire region fails.
31-
32-
A word on synchronization. A metropolitan network is generally much faster and offers less
33-
latency; data can be written to multiple targets simultaneously, a feature required for
34-
active-active DR designs. On the other hand, writing to multiple targets in a cross-regional
35-
network might introduce unbearable latency to our applications. Therefore, _Regional DR_
36-
can only work with active-passive DR designs, where the targets are replicated asynchronously.
27+
[Red Hat OpenShift Data Foundation][odf] offers two solutions for disaster
28+
recovery: [Metro DR][mdr] and [Regional DR][rdr]. As their name suggests, _Metro
29+
DR_ refers to a metropolitan area disasters, which occur when the disaster
30+
covers only a single area in a region (availability zone), and _Regional DR_
31+
refers to when the entire region fails. Currently, only active-passive mode is
32+
supported.
33+
34+
A word on synchronization. A metropolitan network generally offers less latency;
35+
data can be written to multiple targets simultaneously, a feature required for
36+
active-active DR designs. On the other hand, writing to multiple targets in a
37+
cross-regional network might introduce unbearable latency to data
38+
synchronization and our applications. Therefore, _Regional DR_ can only work
39+
with active-passive DR designs, where the targets are replicated
40+
asynchronously.
41+
42+
The synchronization between Availability Zones is faster and can be performed
43+
synchronous. However, in order don't include a lot of latency on the data
44+
synchronization process, when data is replicated across regions, it necessary
45+
includes latencies based on the distance between both regions (e.g. The latency
46+
between two regions on Europe, will always be less than between Europe and Asia,
47+
so consider this when designing your infrastructure deployment on the values
48+
files of the pattern). This is the main reason because this RegionalDR is
49+
configured in an Active-Passive mode.
50+
51+
It requires an already existing Openshift cluster, which will be used for installing the
52+
pattern, deploying active and passive clusters manage the application
53+
scheduling.
3754

3855
### Prerequisites
3956

4057
Installing this pattern requires:
41-
* One online [Red Hat OpenShift][ocp] cluster
42-
* Cloud credentials for either [AWS][aws], [Azure][azr], or [GCP][gcp]
58+
* One online [Red Hat OpenShift][ocp] cluster to become the "Manager" cluster.
59+
This cluster will orchestrate application deployments and data synchronizations.
60+
* Connection to a Cloud Provider (AWS/Azure/GCP) configured in the Manager
61+
cluster. This is required for deploying the active and passive [OCP][ocp]
62+
clusters.
4363
* [Red Hat OpenShift CLI][cli] installed
4464

4565
### Solution elements
4666

47-
The _Regional DR Pattern_ leverages _[Red Hat OpenShift Data Foundation][odf]'s
67+
The _Regional DR Pattern_ leverages [Red Hat OpenShift Data Foundation][odf]'s
4868
[Regional DR][rdr] solution, automating applications failover between
4969
[Red Had Advanced Cluster Management][acm] managed clusters in different regions.
5070

5171
### Red Hat Technologies
52-
-
5372
- [Red Hat Openshift Container Platform][ocp]
5473
- [Red Hat Openshift Data Foundation][odf]
5574
- [Red Hat Openshift GitOps][ops]
5675
- [Red Hat Openshift Advanced Cluster Management][acm]
5776
- [Red Hat Openshift Advanced Cluster Security][acs]
5877

5978
## Operators and Technologies this Pattern Uses
60-
6179
- [Regional DR Trigger Operator][opr]
80+
- [Submariner][sub]
6281

6382
## Tested on
6483

@@ -67,7 +86,8 @@ The _Regional DR Pattern_ leverages _[Red Hat OpenShift Data Foundation][odf]'s
6786
- Red Hat Openshift Container Platform v4.15
6887

6988
## Architecture
70-
89+
This section explains the architecture deployed by this Pattern and its Logical
90+
and Physical perspectives.
7191
![Regional-Resiliency-Pattern-Logical-Architecture](/images/regional-resiliency-pattern/architecture-diagram-vp-regional-dr-v6.png)
7292

7393
## Logical architecture
@@ -76,16 +96,26 @@ The _Regional DR Pattern_ leverages _[Red Hat OpenShift Data Foundation][odf]'s
7696

7797

7898
## Installation
99+
This patterns is designed to be installed in an Openshift cluster which will
100+
work as the control plane for the rest of Openshift clusters. The controller
101+
cluster will not execute the applications or store any data from them, but it
102+
will work as the control panel for the interconnection of active-passive
103+
clusters, coordinating their communication and orchestrating when and where an
104+
application is going to be deployed.
105+
106+
As part of the pattern configuration, the administrator needs to define both
107+
clusters installation details as would be done using the Openshift-installer
108+
binary.
109+
110+
For installing the pattern, follow the next steps:
111+
1. Fork the _Pattern_.
112+
2. Describe the instructions for creating the clusters and syncing data between them.
113+
3. Commit and push your changes (to your fork).
114+
4. Set your **secret** cloud provider credentials.
115+
5. Connect to your target _Hub_ cluster.
116+
6. Install the _Pattern_.
117+
7. Start deploying [resilient applications][rdr].
79118

80-
* Fork the _Pattern_.
81-
* Describe the instructions for creating the clusters and syncing data between them.
82-
* Commit and push your changes (to your fork).
83-
* Set your **secret** cloud provider credentials.
84-
* Connect to your target _Hub_ cluster.
85-
* Install the _Pattern_.
86-
* Start deploying [resilient applications][rdr].
87-
88-
Detailed installation instructions can be found [here][rrp].
89119

90120
### Pattern Configuration
91121

@@ -94,6 +124,13 @@ specifications are detailed [here][cfg].
94124

95125
Detailed configuration instructions can be found [here][rrp].
96126

127+
128+
## Owners
129+
130+
For any request, bug report or comment about this pattern, please forward it to:
131+
* Alejandro Villegas ([email protected])
132+
* Tomer Figenblat ([email protected])
133+
97134
<!-- LINKS -->
98135
[acm]: https://www.redhat.com/en/technologies/management/advanced-cluster-management
99136
[acs]: https://www.redhat.com/en/technologies/cloud-computing/openshift/advanced-cluster-security-kubernetes
@@ -107,6 +144,7 @@ Detailed configuration instructions can be found [here][rrp].
107144
[odf]: https://www.redhat.com/en/technologies/cloud-computing/openshift-data-foundation
108145
[ops]: https://www.redhat.com/en/technologies/cloud-computing/openshift/gitops
109146
[opr]: https://github.com/RHEcosystemAppEng/regional-dr-trigger-operator
147+
[sub]: https://submariner.io/
110148
[rdr]: https://docs.redhat.com/en/documentation/red_hat_openshift_data_foundation/4.16/html/configuring_openshift_data_foundation_disaster_recovery_for_openshift_workloads/rdr-solution
111-
[rrp]: https://github.com/validatedpatterns/regional-resiliency-pattern
149+
[rrp]: https://github.com/validatedpatterns/regional-resiliency-pattern?tab=readme-ov-file#installation
112150
[yml]: https://github.com/validatedpatterns/regional-resiliency-pattern/blob/main/charts/hub/rdr/values.yaml

0 commit comments

Comments
 (0)