You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{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.
40
40
41
41
42
42
== Recommended Deployment Models
@@ -47,7 +47,7 @@ It serves an important role in supporting Disaster Recovery (DR) and Data Migrat
47
47
48
48
This model provides true zero-downtime disaster recovery using bi-directional XDCR between two active mobile clusters.
49
49
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`.
51
51
52
52
.Set Up
53
53
To set up zero-downtime disaster recovery:
@@ -72,21 +72,21 @@ To activate disaster recovery:
72
72
This process requires no Sync Gateway service interruption.
73
73
. Verify disaster recovery cluster is handling traffic properly.
74
74
. 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.
76
76
77
77
// end::zero-downtime-active-active[]
78
78
79
79
=== Clusters in Same Region
80
80
// tag::clusters-in-same-region[]
81
81
82
82
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.
84
84
85
85
.Set Up
86
86
To set up and maintain a disaster recovery cluster:
87
87
88
88
. [*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. +
90
90
If you skip this test, you'll incur latency when Sync Gateway switches to the Disaster Recovery cluster and Sync Gateway rebuilds its indexes.
91
91
. Connect Sync Gateway to your Primary cluster.
92
92
. Start the *unidirectional* XDCR from the Primary cluster to the Disaster Recovery cluster.
When you're ready to switch to Disaster Recovery operations:
100
100
101
101
. 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.
104
104
. 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.
106
106
. Reverse the XDCR to replicate from the newly promoted Primary to the old Primary to set up a new Backup.
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.
120
120
121
121
122
122
.Set Up
123
123
To set up and maintain a disaster recovery cluster - see: <<fig-dr-diff-regn-setup>>:
124
124
125
125
. [*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.
127
127
. [*Critical step*] Turn off *all* the Sync Gateways in the Disaster Recovery cluster.
128
128
. Start the *unidirectional* XDCR from the Primary cluster to the Disaster Recovery cluster.
129
129
@@ -140,7 +140,7 @@ When you're ready to switch to Disaster Recovery operations -- see: <<fig-dr-dif
140
140
. Verify that any and all Load Balancer updates to direct all traffic to the new Sync Gateway clusters.
141
141
. Turn on the Sync Gateway cluster in the Disaster Recovery cluster.
142
142
. 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.
144
144
. Reverse the original XDCR to replicate from the newly promoted Primary to the old Primary, to set up a new Backup.
Copy file name to clipboardExpand all lines: modules/server-compatibility/pages/server-compatibility-xdcr.adoc
+12-11Lines changed: 12 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,18 +44,18 @@ Here we provide details on how XDCR feature relates to the {cbm} ecosystem.
44
44
45
45
46
46
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.
48
48
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.
50
50
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:
52
52
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.
56
56
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
59
59
60
60
[[icr-active-mobile]]
61
61
.Active-to-active mobile synchronization
@@ -71,7 +71,8 @@ XDCR replicates all of Sync Gateway’s metadata (_sync xattr) along with associ
71
71
72
72
Your default preference for the replication of {cbm} changes should always be to use inter-Sync{nbsp}Gateway replication.
73
73
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.
75
76
76
77
77
78
=== Unidirectional XDCR
@@ -83,8 +84,8 @@ In all these categories you should run XDCR in unidirectional mode, deploying Sy
83
84
====
84
85
In this example XDCR deployment:
85
86
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.
88
89
* Sync Gateway, although deployed at both ends of the XDCR replication, crucially is in *read-only* mode at the target end.
0 commit comments