Skip to content

Commit 4f01d87

Browse files
aimurphyaimurphy
authored
DOC-5183, DOC-5170, DOC-5192 Astra Migration Toolkit, Migration index page, more Sideloader integration and clean up (#195)
* copyedits and remove redundant page * attempt to create an index page * minimize redundant content and add sideloader phase 2 * shorten index intro and expand supported versions * nav and index touchups * migration path table * use emojis until icon macro supported * table column widths * Apply suggestions from code review * use icons from common * address disconnect between 4 tools * subdirectory path * fix attribute * resolve dsbulk migrator discrepancy * address some redundant links * nav adjustment and missing page * peer review * addressing a customer question about scb * multi-node migration warnings * cant to cannot * attributes for shields, repos, scb
1 parent e4b19ec commit 4f01d87

39 files changed

+904
-660
lines changed

‎antora.yml

Lines changed: 32 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,37 +8,52 @@ nav:
88

99
asciidoc:
1010
attributes:
11+
#General attributes
1112
company: 'DataStax'
12-
product: 'Zero Downtime Migration'
13-
product-short: 'ZDM'
14-
product-proxy: 'ZDM Proxy'
15-
product-utility: 'ZDM Utility'
16-
product-automation: 'ZDM Proxy Automation'
17-
product-demo: 'ZDM Demo Client'
18-
dsbulk-migrator: 'DSBulk Migrator'
19-
dsbulk-loader: 'DSBulk Loader'
13+
support-url: 'https://support.datastax.com'
14+
#Other product attributes
15+
cass-reg: 'Apache Cassandra(R)'
2016
cass: 'Apache Cassandra'
2117
cass-short: 'Cassandra'
22-
cass-reg: 'Apache Cassandra(R)'
23-
cass-migrator: 'Cassandra Data Migrator'
24-
cass-migrator-short: 'CDM'
2518
dse: 'DataStax Enterprise (DSE)'
2619
dse-short: 'DSE'
2720
hcd: 'Hyper-Converged Database (HCD)'
2821
hcd-short: 'HCD'
22+
mc: 'Mission Control (MC)'
23+
mc-short: 'MC'
24+
mc-brief: 'Mission Control'
25+
#Astra DB attributes
2926
astra-db: 'Astra DB'
3027
astra: 'Astra'
31-
data-api: 'Data API'
3228
db-serverless: 'Serverless (Non-Vector)'
3329
db-serverless-vector: 'Serverless (Vector)'
3430
astra-ui: 'Astra Portal'
3531
astra-url: 'https://astra.datastax.com'
3632
astra-ui-link: '{astra-url}[{astra-ui}^]'
33+
scb: 'Secure Connect Bundle (SCB)'
34+
scb-short: 'SCB'
35+
scb-brief: 'Secure Connect Bundle'
36+
#Sideloader has a specific name in this repo. It is not identical to the one in the Serverless repo.
3737
sstable-sideloader: '{astra-db} Sideloader'
38+
#devops api attributes
3839
devops-api: 'DevOps API'
3940
devops-api-ref-url: 'xref:astra-api-docs:ROOT:attachment$devops-api/index.html'
40-
support-url: 'https://support.datastax.com'
41-
mc: 'Mission Control (MC)'
42-
mc-short: 'MC'
43-
44-
#TODO: Bring SCB attributes
41+
#data api attributes
42+
data-api: 'Data API'
43+
#Migration docs attributes
44+
product: 'Zero Downtime Migration'
45+
product-short: 'ZDM'
46+
product-proxy: 'ZDM Proxy'
47+
product-proxy-repo: 'https://github.com/datastax/zdm-proxy'
48+
product-utility: 'ZDM Utility'
49+
product-automation: 'ZDM Proxy Automation'
50+
product-automation-repo: 'https://github.com/datastax/zdm-proxy-automation'
51+
product-automation-shield: 'image:https://img.shields.io/github/v/release/datastax/zdm-proxy-automation?label=latest[alt="Latest zdm-proxy-automation release on GitHub",link="{product-automation-repo}/releases"]'
52+
product-demo: 'ZDM Demo Client'
53+
dsbulk-migrator: 'DSBulk Migrator'
54+
dsbulk-migrator-repo: 'https://github.com/datastax/dsbulk-migrator'
55+
dsbulk-loader: 'DSBulk Loader'
56+
cass-migrator: 'Cassandra Data Migrator'
57+
cass-migrator-short: 'CDM'
58+
cass-migrator-repo: 'https://github.com/datastax/cassandra-data-migrator'
59+
cass-migrator-shield: 'image:https://img.shields.io/github/v/release/datastax/cassandra-data-migrator?label=latest[alt="Latest cassandra-data-migrator release on GitHub",link="{cass-migrator-repo}/packages"]'

‎modules/ROOT/nav.adoc

Lines changed: 49 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,54 @@
1+
.Get started
2+
* xref:ROOT:components.adoc[]
3+
* xref:ROOT:zdm-proxy-migration-paths.adoc[]
4+
* Product-specific migration paths
5+
** xref:ROOT:astra-migration-paths.adoc[]
6+
** {dse-short} 6.9
7+
*** xref:6.9@dse:tooling:migration-path-dse.adoc[{dse-short} 6.9 migration tools]
8+
*** xref:6.9@dse:managing:operations/migrate-data.adoc[Migrate data to {dse-short} 6.9]
9+
** {dse-short} 6.8
10+
*** xref:6.8@dse:tooling:migration-path-dse.adoc[{dse-short} 6.8 migration tools]
11+
*** xref:6.8@dse:managing:operations/migrate-data.adoc[Migrate data to {dse-short} 6.8]
12+
** {dse-short} 5.1
13+
*** xref:5.1@dse:managing:operations/migrate-data.adoc[Migrate data to {dse-short} 5.1]
14+
** {mc-brief} migrations
15+
*** xref:mission-control:migrate:oss-cass-to-mission-control.adoc[Migrate {cass-short} clusters to {mc-short}]
16+
*** xref:mission-control:migrate:dse-to-mission-control.adoc[Migrate {dse-short} clusters to {mc-short}]
17+
118
.{product}
2-
* xref:introduction.adoc[]
3-
* xref:components.adoc[]
19+
* xref:ROOT:introduction.adoc[]
420
* Planning
5-
** xref:preliminary-steps.adoc[]
6-
** xref:feasibility-checklists.adoc[]
7-
** xref:deployment-infrastructure.adoc[]
8-
** xref:create-target.adoc[]
9-
** xref:rollback.adoc[]
21+
** xref:ROOT:feasibility-checklists.adoc[]
22+
** xref:ROOT:deployment-infrastructure.adoc[]
23+
** xref:ROOT:create-target.adoc[]
24+
** xref:ROOT:rollback.adoc[]
1025
* Phase 1
11-
** xref:phase1.adoc[]
12-
** xref:setup-ansible-playbooks.adoc[]
13-
** xref:deploy-proxy-monitoring.adoc[]
14-
** xref:tls.adoc[]
15-
** xref:connect-clients-to-proxy.adoc[]
16-
** xref:metrics.adoc[]
17-
** xref:manage-proxy-instances.adoc[]
26+
** xref:ROOT:phase1.adoc[]
27+
** xref:ROOT:setup-ansible-playbooks.adoc[]
28+
** xref:ROOT:deploy-proxy-monitoring.adoc[]
29+
** xref:ROOT:tls.adoc[]
30+
** xref:ROOT:connect-clients-to-proxy.adoc[]
31+
** xref:ROOT:metrics.adoc[]
32+
** xref:ROOT:manage-proxy-instances.adoc[]
1833
* Phase 2
19-
** xref:migrate-and-validate-data.adoc[]
20-
** xref:cassandra-data-migrator.adoc[{cass-migrator}]
21-
** xref:dsbulk-migrator.adoc[{dsbulk-migrator}]
34+
** xref:ROOT:migrate-and-validate-data.adoc[]
35+
** xref:sideloader:sideloader-zdm.adoc[]
36+
** xref:ROOT:cassandra-data-migrator.adoc[]
37+
** xref:ROOT:dsbulk-migrator.adoc[]
2238
* Phase 3
23-
** xref:enable-async-dual-reads.adoc[]
39+
** xref:ROOT:enable-async-dual-reads.adoc[]
2440
* Phase 4
25-
** xref:change-read-routing.adoc[]
41+
** xref:ROOT:change-read-routing.adoc[]
2642
* Phase 5
27-
** xref:connect-clients-to-target.adoc[]
43+
** xref:ROOT:connect-clients-to-target.adoc[]
2844
* References
29-
** xref:troubleshooting-tips.adoc[]
30-
** xref:troubleshooting-scenarios.adoc[]
31-
** xref:contributions.adoc[]
32-
** xref:faqs.adoc[]
33-
** xref:glossary.adoc[]
34-
** https://github.com/datastax/zdm-proxy/releases[{product-proxy} release notes]
35-
** https://github.com/datastax/zdm-proxy-automation/releases[{product-automation} release notes]
36-
37-
.{cass-migrator}
38-
* xref:cdm-overview.adoc[{cass-migrator}]
39-
* https://github.com/datastax/cassandra-data-migrator/releases[{cass-migrator-short} release notes]
40-
41-
.{dsbulk-loader}
42-
* xref:dsbulk:overview:dsbulk-about.adoc[{dsbulk-loader}]
43-
* xref:dsbulk:installing:install.adoc[Installing {dsbulk-loader}]
44-
* Loading and unloading data
45-
** xref:dsbulk:getting-started:simple-load.adoc[Loading data without a configuration file]
46-
** xref:dsbulk:getting-started:simple-unload.adoc[Unloading data without a configuration file]
47-
** xref:dsbulk:developing:loading-unloading-vector-data.adoc[Loading and unloading vector data]
48-
** xref:dsbulk:reference:load.adoc[Loading data examples]
49-
** xref:dsbulk:reference:unload.adoc[Unloading data examples]
50-
* xref:dsbulk:reference:dsbulk-cmd.adoc#escaping-and-quoting-command-line-arguments[Escaping and quoting command line arguments]
51-
* https://github.com/datastax/dsbulk/releases[{dsbulk-loader} release notes]
45+
** xref:ROOT:troubleshooting-tips.adoc[]
46+
** xref:ROOT:troubleshooting-scenarios.adoc[]
47+
** xref:ROOT:contributions.adoc[]
48+
** xref:ROOT:faqs.adoc[]
49+
** xref:ROOT:glossary.adoc[]
50+
** {product-proxy-repo}/releases[{product-proxy} release notes]
51+
** {product-automation-repo}/releases[{product-automation} release notes]
5252
5353
.{sstable-sideloader}
5454
* xref:sideloader:sideloader-overview.adoc[]
@@ -58,18 +58,9 @@
5858
* xref:sideloader:cleanup-sideloader.adoc[]
5959
* xref:sideloader:troubleshoot-sideloader.adoc[]
6060
61-
.Product-specific migration paths
62-
* {astra-db}
63-
** xref:astra-db-serverless:databases:migration-path-serverless.adoc[]
64-
* {dse}
65-
** {dse-short} 6.9
66-
*** xref:6.9@dse:tooling:migration-path-dse.adoc[{dse-short} 6.9 migration tools]
67-
*** xref:6.9@dse:managing:operations/migrate-data.adoc[Migrate data to {dse-short} 6.9]
68-
** {dse-short} 6.8
69-
*** xref:6.8@dse:tooling:migration-path-dse.adoc[{dse-short} 6.8 migration tools]
70-
*** xref:6.8@dse:managing:operations/migrate-data.adoc[Migrate data to {dse-short} 6.8]
71-
** {dse-short} 5.1
72-
*** xref:5.1@dse:managing:operations/migrate-data.adoc[Migrate data to {dse-short} 5.1]
73-
* {mc}
74-
** xref:mission-control:migrate:oss-cass-to-mission-control.adoc[Migrate {cass-short} clusters to {mc-short}]
75-
** xref:mission-control:migrate:dse-to-mission-control.adoc[[Migrate {cass-short} clusters to {dse-short}]
61+
.{cass-migrator}
62+
* xref:ROOT:cdm-overview.adoc[]
63+
* {cass-migrator-repo}/releases[{cass-migrator-short} release notes]
64+
65+
.{dsbulk-migrator}
66+
* xref:ROOT:dsbulk-migrator-overview.adoc[]

‎modules/ROOT/pages/astra-migration-paths.adoc

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
= {astra} Migration Toolkit
2+
:description: Learn which migration tools are compatible with your origin cluster.
3+
4+
The {astra} Migration Toolkit includes all xref:ROOT:components.adoc[{company} migration tools] that are designed to help you migrate your data to {astra-db}.
5+
6+
== Migration tool compatibility
7+
8+
Use the following table to learn which tools are compatible with your current database provider or service:
9+
10+
[cols="2,1,1,1,1"]
11+
|===
12+
|Origin |{sstable-sideloader} |{cass-migrator} |{product-proxy} |{dsbulk-migrator}/{dsbulk-loader}
13+
14+
|Aiven for {cass-short}
15+
|✅
16+
|✅
17+
|✅
18+
|✅
19+
20+
|Amazon Keyspaces
21+
|❌
22+
|✅
23+
|✅
24+
|✅
25+
26+
|{cass-reg} OSS 3.11 or later
27+
|✅
28+
|✅
29+
|✅
30+
|✅
31+
32+
|{cass-reg} OSS 3.10 or earlier
33+
|❌
34+
|✅
35+
|✅
36+
|✅
37+
38+
|Azure Cosmos DB ({cass-short} API)
39+
|❌
40+
|✅
41+
|✅
42+
|✅
43+
44+
|Azure Managed Instance for {cass}
45+
|✅
46+
|✅
47+
|✅
48+
|✅
49+
50+
|{dse-short} 5.1 or later
51+
|✅
52+
|✅
53+
|✅
54+
|✅
55+
56+
|{dse-short} 5.0 or earlier
57+
|❌
58+
|✅
59+
|✅
60+
|✅
61+
62+
|Instaclustr Managed {cass-short}
63+
|✅
64+
|✅
65+
|✅
66+
|✅
67+
68+
|K8ssandra (self-managed)
69+
|✅
70+
|✅
71+
|✅
72+
|✅
73+
74+
|Scylla Cloud
75+
|❌
76+
|✅
77+
|✅
78+
|✅
79+
80+
|Scylla OSS or Enterprise
81+
|❌
82+
|✅
83+
|✅
84+
|✅
85+
86+
|Yugabyte Aeon (YCQL)
87+
|❌
88+
|✅
89+
|✅
90+
|✅
91+
92+
|Yugabyte OSS or Anywhere
93+
|❌
94+
|✅
95+
|✅
96+
|✅
97+
98+
|===
99+
100+
== Get support for your migration
101+
102+
If you have questions about migrating from a specific source to {astra-db}, contact your {company} account representative, {support-url}[{company} Support], or an https://www.datastax.com/products/datastax-astra/migration-toolkit[{astra} Migration Toolkit expert].
103+
104+
== See also
105+
106+
* xref:astra-db-serverless:databases:migration-path-serverless.adoc[Migrate to {astra-db}]

0 commit comments

Comments
 (0)