diff --git a/docs/modules/ROOT/examples/wan-sync-full.yaml b/docs/modules/ROOT/examples/wan-sync-full.yaml new file mode 100644 index 00000000..72c99284 --- /dev/null +++ b/docs/modules/ROOT/examples/wan-sync-full.yaml @@ -0,0 +1,6 @@ +apiVersion: hazelcast.com/v1alpha1 +kind: WanSync +metadata: + name: wansync-sample +spec: + wanReplicationResourceName: wan-replication-sample diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index 4c9bbe3e..aea96e70 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -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] diff --git a/docs/modules/ROOT/pages/wan-sync.adoc b/docs/modules/ROOT/pages/wan-sync.adoc new file mode 100644 index 00000000..c7ec59c8 --- /dev/null +++ b/docs/modules/ROOT/pages/wan-sync.adoc @@ -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 +----