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
Add interactive graphic showing zdm migration phases in one presentat… (#147)
* Add interactive graphic showing zdm migration phases in one presentation with user navigation
* minor edit
* remove the word Interactive from the unified daigram's section title
* Updates to unified graphic section (drop 'Interactive') and tweak in Interactive Lab section
* rm redundant purple phases graphic and combine sections
* minor edit
* Inc Eric's edit
Co-authored-by: Eric Schneider <[email protected]>
* Inc Eric's edit
Co-authored-by: Eric Schneider <[email protected]>
* Inc Eric's edit
Co-authored-by: Eric Schneider <[email protected]>
* Inc Eric's edit
Co-authored-by: Eric Schneider <[email protected]>
* Inc Eric's edit
Co-authored-by: Eric Schneider <[email protected]>
* Inc Eric's edit
Co-authored-by: Eric Schneider <[email protected]>
* Inc Eric's edit
Co-authored-by: Eric Schneider <[email protected]>
* Inc Eric's edit
Co-authored-by: Eric Schneider <[email protected]>
* Inc Eric's edit
Co-authored-by: Eric Schneider <[email protected]>
* Inc Eric's edits to improve Alt text, but use image: instead of image:: for best graphic rendering
* Inc Eric's latest comments
* add quotes for phase 4 topic image alt text
---------
Co-authored-by: Eric Schneider <[email protected]>
Copy file name to clipboardExpand all lines: docs-src/zdm-core/modules/migrate/pages/introduction.adoc
+48-24Lines changed: 48 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,46 +47,70 @@ For additional terms, see the xref:glossary.adoc[glossary].
47
47
An important migration prerequisite is that you already have the matching schema on Target. A CQL statement that your client application sends to {zdm-proxy} must be able to succeed on both Origin and Target clusters. This means that any keyspace that your client application uses must exist on both Origin and Target with the same name. Table names must also match. For more, see xref:feasibility-checklists.adoc#_schemakeyspace_compatibility[Schema/keyspace compatibility].
48
48
====
49
49
50
-
Your migration project occurs through a sequence of phases, which matches the structure of this ZDM documentation.
51
-
52
-
image::{imagesprefix}migration-all-phases.png[Migration phases from start to finish.]
53
-
54
-
Before we walk through illustrations of each phase, let's look at a pre-migration, high-level view. At this point, your client applications are performing read/write operations with an existing CQL-compatible database. That is, Apache Cassandra, DSE, or Astra DB.
55
-
56
-
image::{imagesprefix}pre-migration0ra.png[Diagram shows existing CQL-compatible environment before migration starts.]
57
-
58
-
Before your migration begins, you'll need to satisfy prerequisites, prepare your environment, and set up the recommended infrastructure.
50
+
[.swiper]
51
+
====
52
+
[.slide]
53
+
--
54
+
.Walk through the illustrated migration phases
55
+
To get acquainted with the migration phases from start to finish, click the **Start** button below.
59
56
60
-
=== Phase 1: Deploy ZDM Proxy and connect client applications
57
+
image:migration-introduction9.png["Introductory page prompts you to click the Start button to begin the graphical presentation."]
58
+
--
61
59
62
-
Let's look at Phase 1 of the migration. We'll deploy the ZDM Proxy instances and connect client applications to the proxies. This step activates the dual-write logic. Writes will be "bifurcated" (sent to both Origin and Target), while reads will be executed on Origin only.
60
+
[.slide]
61
+
--
62
+
.Phase 0: Before your migration starts
63
+
Let's look at a pre-migration, high-level view. At this point, your client applications are performing read/write operations with an existing CQL-compatible database. That is, Apache Cassandra, DSE, or Astra DB.
63
64
64
-
image::{imagesprefix}migration-phase1ra.png[Phase 1 diagram shows deployed ZDM Proxy instances, client app connections to proxies, and Target is setup.]
65
+
image:pre-migration0ra9.png["Illustrates a pre-migration environment, as summarized in the text. Back and Next buttons are available for navigation within the graphic."]
66
+
--
65
67
66
-
=== Phase 2: Migrate data
68
+
[.slide]
69
+
--
70
+
.Phase 1: Deploy ZDM Proxy and connect client applications
71
+
In this first phase, deploy the ZDM Proxy instances and connect client applications to the proxies. This phase activates the dual-write logic. Writes are bifurcated (sent to both Origin and Target), while reads are executed on Origin only.
67
72
68
-
In this phase, we migrate existing data using {cstar-data-migrator} and/or {dsbulk-migrator}. Validate that the migrated data is correct, while continuing to perform dual writes.
73
+
image:migration-phase1ra9.png["Illustrates migration Phase 1, as summarized in the text. Back and Next buttons are available for navigation within the graphic."]
74
+
--
69
75
70
-
image::{imagesprefix}migration-phase2ra.png[Phase 2 diagram shows using tools to migrate data from Origin to Target.]
76
+
[.slide]
77
+
--
78
+
.Phase 2: Migrate data
79
+
In this phase, migrate existing data using Cassandra Data Migrator and/or DSBulk Migrator. Validate that the migrated data is correct, while continuing to perform dual writes.
71
80
72
-
=== Phase 3: Async dual reads
81
+
image:migration-phase2ra9.png["Illustrates migration Phase 2, as summarized in the text. Back and Next buttons are available for navigation within the graphic."]
82
+
--
73
83
84
+
[.slide]
85
+
--
86
+
.Phase 3: Enable asynchronous dual reads
74
87
In this phase, you can optionally enable asynchronous dual reads. The idea is to test performance and verify that Target can handle your application's live request load before cutting over from Origin to Target.
75
88
76
-
image::{imagesprefix}migration-phase3ra.png[Phase 3 diagram shows optional step enabling async dual reads to test performance of Target.]
89
+
image:migration-phase3ra9.png["Illustrates migration Phase 3, as summarized in the text. Back and Next buttons are available for navigation within the graphic."]
90
+
--
77
91
78
-
=== Phase 4: Route reads to Target
92
+
[.slide]
93
+
--
94
+
.Phase 4: Route reads to Target
95
+
In this phase, read routing on the ZDM Proxy is switched to Target so that all reads are executed on it, while writes are still sent to both clusters. In other words, Target becomes the primary cluster.
79
96
80
-
In this phase, the read routing on the {zdm-proxy} is switched to Target so that all reads are executed on it, while writes are still sent to both clusters. In other words, Target becomes the primary cluster.
97
+
image:migration-phase4ra9.png["Illustrates migration Phase 4, as summarized in the text. Back and Next buttons are available for navigation within the graphic."]
98
+
--
81
99
82
-
image::{imagesprefix}migration-phase4ra.png[Phase 4 diagram shows read routing on ZDM Proxy was switched to Target.]
100
+
[.slide]
101
+
--
102
+
.Phase 5: Connect directly to Target
103
+
In this phase, move your client applications off the ZDM Proxy and connect the apps directly to Target. Once that happens, the migration is complete.
83
104
84
-
=== Phase 5: Connect directly to Target
85
-
86
-
In this phase, you'll move your client applications off the {zdm-proxy} and connect the apps directly to Target. Once that happens, the migration is complete.
105
+
image:migration-phase5ra9.png["Illustrates migration Phase 5, as summarized in the text. Back and Restart buttons are available for navigation within the graphic."]
106
+
--
107
+
====
87
108
88
-
image::{imagesprefix}migration-phase5ra.png[Phase 5 diagram shows apps no longer using proxy and instead connected directly to Target.]
89
109
110
+
[TIP]
111
+
====
112
+
For details on each phase, continue reading the comprehensive topics in this guide. Also check out the {zdm-product} Interactive Lab.
113
+
====
90
114
91
115
== A fun way to learn: {zdm-product} Interactive Lab
Copy file name to clipboardExpand all lines: docs-src/zdm-core/modules/migrate/partials/interactive-lab.adoc
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,8 @@
1
+
Now that you've seen a conceptual overview of the process, let's put what you learned into practice.
2
+
1
3
We've built a complementary learning resource that is a companion to this comprehensive ZDM documentation. It's the {zdm-product} Interactive Lab, available for you here:
0 commit comments