Skip to content

Commit 3ce6206

Browse files
committed
style guide compliance in older docs page
1 parent 845332e commit 3ce6206

2 files changed

Lines changed: 24 additions & 23 deletions

File tree

modules/deploy/pages/setting-up-dr-cluster.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ include::ROOT:partial$_show_page_header_block.adoc[]
3636
== Introduction
3737

3838
{server-xdcr--xref} (XDCR) replicates data between two or more autonomous Couchbase Server clusters.
39-
It serves an important role in supporting Disaster Recovery (DR) and Data Migration, even where Sync Gateway is the normal replicator of choice for mobile data.
39+
It plays an important role in supporting Disaster Recovery (DR) and Data Migration, even where Sync Gateway is the normal replicator of choice for mobile data.
4040

4141

4242
== Recommended Deployment Models
@@ -47,7 +47,7 @@ It serves an important role in supporting Disaster Recovery (DR) and Data Migrat
4747

4848
This model provides true zero-downtime disaster recovery using bi-directional XDCR between two active mobile clusters.
4949
Both clusters remain operational, with seamless fail-over through load balancer switching.
50-
`shared_bucket_access=true` is required when loading a database in SGW 4.0+, and you must configure both clusters with `import_docs=true`.
50+
`shared_bucket_access=true` becomes required when loading a database in SGW 4.0+, and you must configure both clusters with `import_docs=true`.
5151

5252
.Set Up
5353
To set up zero-downtime disaster recovery:
@@ -72,21 +72,21 @@ To activate disaster recovery:
7272
This process requires no Sync Gateway service interruption.
7373
. Verify disaster recovery cluster is handling traffic properly.
7474
. Maintain bi-directional replication for recovery preparedness. +
75-
The original primary becomes new DR cluster automatically and no manual XDCR reconfiguration required.
75+
The original primary becomes the new DR cluster automatically and requires no manual XDCR reconfiguration.
7676

7777
// end::zero-downtime-active-active[]
7878

7979
=== Clusters in Same Region
8080
// tag::clusters-in-same-region[]
8181

8282
This model caters for situations where the Active and Disaster Recovery clusters are in the same region or datacenter -- see: <<fig-dr-same-regn>>.
83-
It includes an optional optimization step, which verifies that there is no downtime during the activation stage.
83+
It includes an optional optimization step, which confirms that there is no downtime during the activation stage.
8484

8585
.Set Up
8686
To set up and maintain a disaster recovery cluster:
8787

8888
. [*Optional step -- for optimization*] Start Sync Gateway with `offline: true` in the Disaster Recovery cluster to asynchronously create indexes.
89-
Having everything reindexed lowers switching costs. +
89+
Creating all indexes beforehand reduces switching costs. +
9090
If you skip this test, you'll incur latency when Sync Gateway switches to the Disaster Recovery cluster and Sync Gateway rebuilds its indexes.
9191
. Connect Sync Gateway to your Primary cluster.
9292
. Start the *unidirectional* XDCR from the Primary cluster to the Disaster Recovery cluster.
@@ -99,10 +99,10 @@ image::ROOT:{image-sgw-xdcr-dr-same-regn-setup}[,{std-image-size}]
9999
When you're ready to switch to Disaster Recovery operations:
100100

101101
. Stop the replication (XDCR) from the Primary cluster to Disaster Recovery cluster.
102-
. *When XDCR is stopped:* Switch the Load Balancer to point to the Sync Gateway on the Disaster Recovery cluster.
103-
This maintains the deployment of Sync Gateway at only one end of the XDCR replication.
102+
. *After you stop XDCR:* Switch the Load Balancer to point to the Sync Gateway on the Disaster Recovery cluster.
103+
This approach keeps the deployment of Sync Gateway at only 1 end of the XDCR replication.
104104
. Promote the Disaster Recovery cluster to Primary and the *old* Primary to Disaster Recovery.
105-
. Flush all replicated buckets in the Primary cluster as a precaution against any spurious writes that came into the Primary cluster and were not replicated when XDCR stops.
105+
. Flush all replicated buckets in the Primary cluster as a precaution against any spurious writes that enter the Primary cluster and XDCR fails to replicate when you stop it.
106106
. Reverse the XDCR to replicate from the newly promoted Primary to the old Primary to set up a new Backup.
107107

108108
[#fig-dr-same-regn-in-recovery]
@@ -115,15 +115,15 @@ image::ROOT:{image-sgw-xdcr-dr-same-regn-in-recovery}[,{std-image-size}]
115115
// tag::clusters-in-diff-region[]
116116

117117
This model caters for situations where the Active and Disaster Recovery clusters are in different regions or data centers.
118-
Although the model has a separate Sync Gateway cluster attached to the Disaster Recovery cluster, it maintains the deployment of Sync Gateway at only one end of the XDCR replication.
119-
The optional optimization step verifies that there is no downtime during the activation stage.
118+
Although the model has a separate Sync Gateway cluster attached to the Disaster Recovery cluster, this approach keeps the deployment of Sync Gateway at only 1 end of the XDCR replication.
119+
The optional optimization step confirms that there is no downtime during the activation stage.
120120

121121

122122
.Set Up
123123
To set up and maintain a disaster recovery cluster - see: <<fig-dr-diff-regn-setup>>:
124124

125125
. [*Optional step -- for optimization*] Start Sync Gateway with `offline: true` in the Disaster Recovery cluster to asynchronously create indexes.
126-
If you skip this test, you'll incur latency when Sync Gateway is switched to the Disaster Recovery cluster and Sync Gateway rebuilds its indexes.
126+
If you skip this test, you'll incur latency when you switch Sync Gateway to the Disaster Recovery cluster and Sync Gateway rebuilds its indexes.
127127
. [*Critical step*] Turn off *all* the Sync Gateways in the Disaster Recovery cluster.
128128
. Start the *unidirectional* XDCR from the Primary cluster to the Disaster Recovery cluster.
129129

@@ -140,7 +140,7 @@ When you're ready to switch to Disaster Recovery operations -- see: <<fig-dr-dif
140140
. Verify that any and all Load Balancer updates to direct all traffic to the new Sync Gateway clusters.
141141
. Turn on the Sync Gateway cluster in the Disaster Recovery cluster.
142142
. Assign the Disaster Recovery cluster to be the *new* Primary cluster, and make the *old* Primary cluster the *new* Disaster Recovery cluster.
143-
. Flush all replicated buckets in the Primary cluster; as a precaution against any spurious writes coming into the Primary cluster that had not been replicated when XDCR was stopped.
143+
. Flush all replicated buckets in the Primary cluster as a precaution against any spurious writes coming into the Primary cluster that XDCR did not replicate when you stopped it.
144144
. Reverse the original XDCR to replicate from the newly promoted Primary to the old Primary, to set up a new Backup.
145145

146146
[#fig-dr-diff-regn-in-recovery]

modules/server-compatibility/pages/server-compatibility-xdcr.adoc

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -44,18 +44,18 @@ Here we provide details on how XDCR feature relates to the {cbm} ecosystem.
4444

4545

4646
If you need to sync mobile clusters, you should use Inter-Sync Gateway replication -- see: {sync-inter-syncgateway-overview--xref}.
47-
It was designed to keep mobile clusters in different data centers in sync.
47+
It's designed to keep mobile clusters in different data centers in sync.
4848
The ideal use-case being the need to replicate edge clusters containing active Sync{nbsp}Gateway nodes between geographically separate cloud-based Sync Gateway deployments.
49-
A typical architecture for this use case is shown in <<icr-active-mobile>>.
49+
<<icr-active-mobile>> shows a typical architecture for this use case.
5050

51-
Inter-Sync Gateway replication provides bi-directional read/write replications that ensure:
51+
Inter-Sync Gateway replication provides bi-directional read/write replications that make sure:
5252

53-
* Cluster specific security is observed; by invoking the appropriate Sync Function.
54-
* The integrity of security history is maintained.
55-
Historical access rules are held and maintained in the Sync Gateway metadata.
53+
* Sync Gateway observes cluster-specific security by invoking the appropriate Sync Function.
54+
* Sync Gateway maintains the integrity of security history.
55+
Sync Gateway holds and maintains historical access rules in its metadata.
5656
This history is necessary to consistently handle the revocation of access grants.
57-
* A consistent Revision Id is used across all clusters, allowing clients to identify a revision regardless of the cluster it is on.
58-
* Cluster-specific _sync documents are not replicated to other mobile clusters
57+
* All clusters use a consistent Revision Id, allowing clients to identify a revision regardless of which cluster it's on.
58+
* Cluster-specific `_sync` documents are not replicated to other mobile clusters
5959

6060
[[icr-active-mobile]]
6161
.Active-to-active mobile synchronization
@@ -71,7 +71,8 @@ XDCR replicates all of Sync Gateway’s metadata (_sync xattr) along with associ
7171

7272
Your default preference for the replication of {cbm} changes should always be to use inter-Sync{nbsp}Gateway replication.
7373

74-
XDCR can be useful though in use-cases where the entire dataset from a source bucket is replicated to a target bucket. This could include categories such as active standby, disaster recovery, data migration and _lift-and-shift_ cases in hybrid cloud.
74+
XDCR proves useful in use-cases where you replicate the entire dataset from a source bucket to a target bucket.
75+
These categories include active standby, disaster recovery, data migration and _lift-and-shift_ cases in hybrid cloud.
7576

7677

7778
=== Unidirectional XDCR
@@ -83,8 +84,8 @@ In all these categories you should run XDCR in unidirectional mode, deploying Sy
8384
====
8485
In this example XDCR deployment:
8586
86-
* XDCR is run unidirectionally.
87-
It pushes data from the primary data center to the secondary data centers, where it is pulled by Sync Gateway for downstream clients.
87+
* XDCR runs unidirectionally.
88+
It pushes data from the primary datacenter to the secondary datacenter, where it's pulled by Sync Gateway for downstream clients.
8889
* Sync Gateway, although deployed at both ends of the XDCR replication, crucially is in *read-only* mode at the target end.
8990
9091
.XDCR Replication

0 commit comments

Comments
 (0)