Skip to content

Commit 87c44f1

Browse files
authored
Merge pull request #675 from gaurav-nelson/portworx-dr-edits
chore: Edited Portworx DR documentation and remove missing cluster sizing docs
2 parents 0a1999d + f8c4196 commit 87c44f1

5 files changed

Lines changed: 19 additions & 81 deletions

File tree

content/patterns/portworx-dr/_index.adoc

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -31,30 +31,27 @@ include::modules/comm-attributes.adoc[]
3131

3232
== Portworx Disaster Recovery
3333

34-
This pattern demonstrates the use of Ansible Automation Platform to orchestrate Portworx Disaster Recovery
34+
This pattern demonstrates the use of {ansible} to orchestrate Portworx Disaster Recovery
3535
on AWS with a simple example application (boutique).
3636

3737
=== Background
3838

39-
It would be ideal if all applications in the world understood availability concepts natively and had their own
40-
integrated regional failover strategies. However, many workloads do not, and users who need regional disaster recovery
41-
capabilities need to solve this problem for the applications that cannot solve it for themselves.
39+
Not all applications have integrated regional failover strategies. Users who need regional disaster recovery
40+
capabilities must solve this problem for the applications that cannot solve it for themselves.
4241

43-
==== Solution elements
42+
==== Red Hat technologies
4443

45-
==== Red Hat Technologies
46-
47-
* Red Hat OpenShift Container Platform (Kubernetes)
48-
* Red Hat Ansible Automation Platform
49-
* Red Hat Advanced Cluster Management (RHACM)
50-
* Red Hat OpenShift GitOps (ArgoCD)
44+
* {rh-ocp} (Kubernetes)
45+
* {rh-ansible}
46+
* {rh-rhacm-first}
47+
* {rh-gitops} (ArgoCD)
5148
* Red Hat External Secrets Operator
5249

53-
==== Other technologies this pattern Uses
50+
==== Other technologies this pattern uses
5451

55-
* HashiCorp Vault (Community Edition)
52+
* {hashicorp-vault} (Community Edition)
5653
* Portworx Enterprise
5754

5855
=== Architecture
5956

60-
Coming Soon
57+
Coming soon

content/patterns/portworx-dr/cluster-sizing.adoc

Lines changed: 0 additions & 21 deletions
This file was deleted.

content/patterns/portworx-dr/getting-started.adoc

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Getting Started
2+
title: Getting started
33
weight: 10
44
aliases: /portworx-dr/getting-started/
55
---
@@ -21,7 +21,7 @@ include::modules/comm-attributes.adoc[]
2121
* The Helm binary, for instructions, see link:https://helm.sh/docs/intro/install/[Installing Helm]
2222
* Additional installation tool dependencies. For details, see link:https://validatedpatterns.io/learn/quickstart/[Patterns quick start].
2323

24-
It is desirable to have a cluster for deploying the GitOps management hub assets and a separate cluster(s) for the managed cluster(s).
24+
Use a cluster for deploying the GitOps management hub assets and a separate cluster for the managed clusters.
2525

2626
[id="preparing-for-deployment"]
2727
== Preparing for deployment
@@ -36,7 +36,7 @@ It is desirable to have a cluster for deploying the GitOps management hub assets
3636
$ git clone git@github.com:your-username/portworx-dr.git
3737
----
3838

39-
. Go to your repository: Ensure you are in the root directory of your Git repository by using:
39+
. Go to the root directory of your Git repository:
4040
+
4141
[source,terminal]
4242
----
@@ -182,11 +182,8 @@ $ vi ~/values-secret.yaml
182182
$ git checkout -b my-branch
183183
----
184184

185-
. The pattern will infer the baseDomain of your cluster based on the clusterDomain which is tracked by the pattern
186-
operator. Previously, this required the pattern to be forked to be useful - but this is no longer the case (you may
187-
still wish to change other settings in the RDR chart's values file, such as `aws.region` settings. This file is at
188-
link:https://github.com/validatedpatterns/portworx-dr/blob/main/charts/hub/rdr/values.yaml[hub/rdr/values.yaml]. If you do make customizations to this or other files, it is necessary to fork the pattern so that the changes
189-
will be seen by ArgoCD. If you made any changes to this or any other files tracked by git, git add them and then commit the changes by running the following command:
185+
. The pattern infers the baseDomain of your cluster based on the clusterDomain, which the pattern operator tracks. Previously, you had to fork the pattern, but this is no longer the case. You might still want to change other settings in the RDR chart's values file, such as `aws.region` settings. This file is at
186+
link:https://github.com/validatedpatterns/portworx-dr/blob/main/charts/hub/rdr/values.yaml[hub/rdr/values.yaml]. If you customize this or other files, you must fork the pattern so that ArgoCD can detect the changes. If you changed any files tracked by git, add and commit the changes by running the following command:
190187
+
191188
[source,terminal]
192189
----
@@ -200,7 +197,7 @@ $ git commit -m "any updates"
200197
$ git push origin my-branch
201198
----
202199

203-
The preferred way to install this pattern is by using the script `./pattern.sh` script.
200+
Install this pattern by using the `./pattern.sh` file.
204201

205202
[id="deploying-cluster-using-patternsh-file"]
206203
== Deploying the pattern by using the pattern.sh file
@@ -209,13 +206,13 @@ To deploy the pattern by using the `pattern.sh` file, complete the following ste
209206

210207
. Log in to your cluster by following this procedure:
211208

212-
.. Obtain an API token by visiting link:https://oauth-openshift.apps.<your-cluster>.<domain>/oauth/token/request[https://oauth-openshift.apps.<your-cluster>.<domain>/oauth/token/request].
209+
.. Obtain an API token by visiting link:https://oauth-openshift.apps.<your_cluster>.<domain>/oauth/token/request[https://oauth-openshift.apps.<your_cluster>.<domain>/oauth/token/request].
213210

214211
.. Log in to the cluster by running the following command:
215212
+
216213
[source,terminal]
217214
----
218-
$ oc login --token=<retrieved-token> --server=https://api.<your-cluster>.<domain>:6443
215+
$ oc login --token=<retrieved-token> --server=https://api.<your_cluster>.<domain>:6443
219216
----
220217
+
221218
Or log in by running the following command:

content/patterns/ramendr-starter-kit/cluster-sizing.adoc

Lines changed: 0 additions & 21 deletions
This file was deleted.

content/patterns/retail/cluster-sizing.adoc

Lines changed: 0 additions & 14 deletions
This file was deleted.

0 commit comments

Comments
 (0)