Skip to content

Commit

Permalink
Add WanSync docs [CN-369] (#152)
Browse files Browse the repository at this point in the history
* Add WanSync docs [CN-369]

* Apply suggestions from code review

Co-authored-by: rebekah-lawrence <[email protected]>

* update doc accoring to changes in implementation

* update field name

---------

Co-authored-by: rebekah-lawrence <[email protected]>
  • Loading branch information
SeriyBg and rebekah-lawrence authored Feb 1, 2024
1 parent 7298e59 commit 6ea6545
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/modules/ROOT/examples/wan-sync-full.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
apiVersion: hazelcast.com/v1alpha1
kind: WanSync
metadata:
name: wansync-sample
spec:
wanReplicationResourceName: wan-replication-sample
1 change: 1 addition & 0 deletions docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
** xref:replicatedmap-configuration.adoc[ReplicatedMap]
* xref:backup-restore.adoc[Persistence, Backup, and Restore]
* xref:wan-replication.adoc[Configuring WAN Replication]
* xref:wan-sync.adoc[Syncronizing WAN replicated data]
* xref:user-code-deployment.adoc[User Code Deployment]
* xref:high-availability-mode.adoc[High Availability Mode]
* xref:native-memory.adoc[Native Memory]
Expand Down
43 changes: 43 additions & 0 deletions docs/modules/ROOT/pages/wan-sync.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
= Syncronizing WAN replicated data
:description: pass:q[WAN Syncronization allows you to overcome out-of-sync issues with the WAN replicated data. ]
:page-enterprise: true

{description}

See xref:hazelcast:wan:advanced-features#synchronizing-wan-clusters.adoc[Synchronizing WAN Clusters] for more detailed information about the configuration and behavior of WAN replication in Hazelcast.

== Prerequisites for WAN Sync

Before you create and configure a `WanSync` resource, you must create the following:

- At least one `Hazelcast` resource and one `Map` resource for the source Hazelcast cluster.
- A target Hazelcast cluster that is accessible from the source cluster.
- A `WanReplication` CR that points to the target cluster.

== Configuring the WanSync Resource

To configure WAN Syncronization, you must create `WanSync` resource. For more detailed information, see the xref:api-ref.adoc#wansyncspec[API Reference].

To create `WanSync` resource you must use the existing `WanReplication` CR. This means that the `WanSync` reuses the existing and running WAN replication process.

.Example of WanSync using the existing WanReplication
[source,yaml,subs="attributes+"]
----
include::ROOT:example$/wan-sync-full.yaml[]
----

== Checking the Status of a WAN Sync

After creating the `WanSync` resource, run the following command to see the WAN syncronization status:

[source,shell]
----
kubectl get wansync wansync-sample
----

The output is similar to the following:

----
NAME STATUS
wansync-sample-sample Completed
----

0 comments on commit 6ea6545

Please sign in to comment.