Skip to content

Commit 8df1d5b

Browse files
Maksim Davydovmaksaska
authored andcommitted
* removed redundant options * updated doc
1 parent 2567347 commit 8df1d5b

File tree

1 file changed

+21
-31
lines changed

1 file changed

+21
-31
lines changed

docs/_docs/extensions-and-integrations/change-data-capture-extensions.adoc

Lines changed: 21 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -553,7 +553,7 @@ The former strategy implies that only one cluster would be activly used for data
553553

554554
The latter approach allows users to use both cluster simultaneously, meanwhile the CDC clients transfer the updates between them. For that strategy to work, the user should configure conflict resolver.
555555

556-
* To make strategies work you have two independent tools to configure:
556+
* To make things work you have two independent tools to configure:
557557

558558
** Thin/Thick clients for connection to destination clusters - responsible for 'put' opertaions on the destination cluster.
559559

@@ -571,7 +571,7 @@ The script will use predefined configuration '.xml' files from '../examples/conf
571571

572572
NOTE: Use `--help` to explore the manager capabilities
573573

574-
NOTE: Please, enable `ignite-rest-http` and `ignite-json` to be able to run `cdc-start-up.sh` with `--check`.
574+
NOTE: Please, enable `ignite-rest-http` and `ignite-json` to be able to run `cdc-start-up.sh` with `--check-cdc`.
575575

576576
Examples for reference:
577577

@@ -600,9 +600,9 @@ NOTE: All properties files are preconfigured to work out of the box.
600600

601601
** There are 5 options you can specify CDC client mode from. Take a look at `--help` command output to learn about them.
602602

603-
** You can optionaly activate both clusters at CDC client start-up with `--activate-cluster`. You need this for steady data replication. You can also use `control.sh` capabilities to activate clusters manually.
603+
** You can optionaly activate both clusters at CDC client start-up with `--activate-cluster`. You need this for data persistance at source and destination clusters. You can also use `control.sh` capabilities to activate clusters manually.
604604

605-
NOTE: Start both clusters (as in previous example with Ignite nodes) before starting CDC client
605+
NOTE: Start both clusters (as in previous example with Ignite nodes) before starting CDC client.
606606

607607
Here is an example on how to start Active-Passive inter-cluster communication with 2 separate nodes and one thin CDC client for Ignite-to-Ignite replication from cluster 1 to cluster 2 (Run the commands independently):
608608
```
@@ -611,6 +611,16 @@ Here is an example on how to start Active-Passive inter-cluster communication wi
611611
./cdc-start-up.sh --cdc-client --ignite-to-ignite-thin --activate-cluster ../examples/config/cdc-start-up/cluster-1
612612
```
613613

614+
NOTE: Make sure clusters fully started up before starting CDC client.
615+
616+
Here is an example on how to start Active-Active inter-cluster communication with 2 separate nodes and 2 CDC clients (thick) for Ignite-to-Ignite replication (Run the commands independently):
617+
```
618+
./cdc-start-up.sh --ignite ../examples/config/cdc-start-up/cluster-1
619+
./cdc-start-up.sh --ignite ../examples/config/cdc-start-up/cluster-2
620+
./cdc-start-up.sh --cdc-client --ignite-to-ignite --activate-cluster ../examples/config/cdc-start-up/cluster-1
621+
./cdc-start-up.sh --cdc-client --ignite-to-ignite ../examples/config/cdc-start-up/cluster-2
622+
```
623+
614624
NOTE: To start CDC with Kafka you need to start topics beforehand.
615625

616626
We use the following topics naming for our examples:
@@ -629,26 +639,12 @@ We use the following topics naming for our examples:
629639
./kafka-topics.sh --create --partitions 1 --replication-factor 1 --topic metadata_from_dc2 --bootstrap-server localhost:9092
630640
```
631641

632-
* Start a whole replication system with specified strategy and properties for both clusters:
633-
634-
** Use `--active-active` for Active-Active replication and `--active-passive` for Active-Passive replication.
635-
636-
** You should provide properties files paths for both cluster nodes in the end of the command
637-
638-
** By default, this script uses Ignite clients (thick) for replication. You can optionally use `--with-kafka` to transfer data through Kafka, and `--thin` to use thin clients for connections to the destination clusters.
639-
640-
NOTE: There is no need to preactivate clusters, as the script will do it for you.
641-
642-
To repeat the replication example from the previous point, you can use the following:
643-
644-
```
645-
./cdc-start-up.sh --active-passive --thin ../examples/config/cdc-start-up/cluster-1 ../examples/config/cdc-start-up/cluster-2
646-
```
647-
648-
Active-Active with thin clients and Kafka as data transport:
649-
642+
Here is an example on how to start Active-Passive inter-cluster communication with 2 separate nodes and 2 CDC clients for replication with Kafka from cluster 1 to cluster 2 (Run the commands independently):
650643
```
651-
./cdc-start-up.sh --active-active --with-kafka --thin ../examples/config/cdc-start-up/cluster-1 ../examples/config/cdc-start-up/cluster-2
644+
./cdc-start-up.sh --ignite ../examples/config/cdc-start-up/cluster-1
645+
./cdc-start-up.sh --ignite ../examples/config/cdc-start-up/cluster-2
646+
./cdc-start-up.sh --cdc-client --ignite-to-kafka --activate-cluster ../examples/config/cdc-start-up/cluster-1
647+
./cdc-start-up.sh --cdc-client --kafka-to-ignite-thin ../examples/config/cdc-start-up/cluster-2
652648
```
653649

654650
* You can check CDC replication with `--check-cdc`. Use it in parallel with Active-Passive/Active-Active replication. To start CDC check for proposed entry:
@@ -658,13 +654,7 @@ Active-Active with thin clients and Kafka as data transport:
658654

659655
The command basically puts the entry to the chosen cluster and shows the difference between the two clusters until the data fully transfered.
660656

661-
NOTE: To use it with Active-Passive, push entries only in the Active part of the CDC inter-cluster system. See the example below
662-
663-
```
664-
./cdc-start-up.sh --active-passive ../examples/config/cdc-start-up/cluster-1 ../examples/config/cdc-start-up/cluster-2
665-
```
666-
667-
`cluster-1` is an active part since its properties' directory goes first in the command. In this case there is no reason to push data to the second cluster during the check step, as the data is not replicated from the second cluster.
657+
NOTE: To use it with Active-Passive, push entries only in the Active part of the CDC inter-cluster system.
668658

669659
NOTE: Try to play with version value to see how the conflict resolver works. We propose the following sequence of operations with Active-Active:
670660

@@ -674,4 +664,4 @@ NOTE: Try to play with version value to see how the conflict resolver works. We
674664
./cdc-start-up.sh --check-cdc --key 11006 --value 3 --version 3 --cluster 1
675665
./cdc-start-up.sh --check-cdc --key 11006 --value 2 --version 2 --cluster 2
676666
```
677-
This sequence simulates the case when the first cluster receives outdated value from the second. In our case the data will not be replicated in the last command and the check would fail after 20 tries.
667+
This sequence simulates the case when the first cluster receives outdated value from the second. In our case the data will not be replicated in the last command and the check would fail after 20 tries.

0 commit comments

Comments
 (0)