Skip to content

DOC-5330 - HCD migration toolkit page #207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* xref:ROOT:zdm-proxy-migration-paths.adoc[]
* xref:ROOT:astra-migration-paths.adoc[]
* xref:ROOT:dse-migration-paths.adoc[]
//* xref:ROOT:hcd-migration-paths.adoc[]
* xref:ROOT:hcd-migration-paths.adoc[]
* xref:ROOT:mc-migration-paths.adoc[]

.{product}
Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/dse-migration-paths.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The following information provides guidance on migrations _to_ {dse-short}.

Generally, {company} recommends migrating to the latest version of {dse-short}, unless you have a compatibility issue that requires an interim migration to an earlier version before upgrading.

//TODO: Resolve duplication and replace these at the source with one summary page that points to here.
//TODO: Resolve DSE topic duplication and replace these at the source with one summary page that points to here.

* {dse-short} 6.9
+
Expand All @@ -44,7 +44,7 @@ Migrate data from {dse-short}::
+
--
When migrating _from_ {dse-short} to another {cass-short}-based database, follow the migration guidance for your target database to determine cluster compatibility, migration options, and recommendations.
For example, for {astra-db}, see xref:ROOT:astra-migration-paths.adoc[].
For example, for {astra-db}, see xref:ROOT:astra-migration-paths.adoc[], and for {hcd-short}, see xref:ROOT:hcd-migration-paths.adoc[].

If your target database isn't directly compatible with a migration from {dse-short}, you might need to take interim steps to prepare your data for migration, such as upgrading your {dse-short} version or modifying the data in your existing database to be compatible with the target database.
--
Expand Down
80 changes: 80 additions & 0 deletions modules/ROOT/pages/hcd-migration-paths.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
= {hcd-short} migration toolkit
:description: Learn which migration tools you can use to migrate data to {hcd-short}.

The {hcd} migration toolkit includes the xref:ROOT:components.adoc[{company} migration tools] that you can use to migrate your data to {hcd-short} from another {cass-reg}-based database, such as {astra-db}, {cass-short}, or {dse-short}.

Whenever possible, {company} strongly recommends using the {product} ({product-short}) tools to orchestrate ongoing read/write traffic when you migrate to {hcd-short}.

[#zdm-to-hcd]
== Zero-downtime migrations to {hcd-short}

The {product} ({product-short}) tools allow you to standup your new {hcd-short} clusters independently of your existing {dse-short} clusters.
Then, {product-proxy} orchestrates live traffic and synchronizes ongoing writes while you migrate data to your new clusters using any {product-short}-compatible data migration and validation tool.
Finally, you can use {product-proxy} to simulate the live workload on your new clusters before permanently switching your traffic over.

{product-proxy} and {product-automation} provide the safest upgrade approach with blue-green deployment capabilities that eliminate time pressure and ensure optimal availability and operational safety.
You can rollback up to the last stage of the migration if necessary.

By orchestrating independent clusters with the {product-short} tools, you can specify your ideal {hcd-short} configuration settings that you otherwise wouldn't be able to change during an in-place cluster upgrade.
Incompatibilities in cluster configuration don't disrupt the migration because your existing cluster remains active and unchanged while you set up the new cluster and migrate your data.

=== Data validation with {product-short}

The {product-short} tools don't migrate your data.
During the {product-short} process, you use a xref:ROOT:migrate-and-validate-data.adoc[data migration tool] to rewrite the data from your existing cluster to your new cluster.

{company} recommends that you do the following:

* Choose a data migration tool that also includes strong validation capabilities, such as [{cass-migrator} ({cass-migrator-short})].
* Be aware of incompatible data types that can fail to migrate from your old cluster.
//For example, {hcd-short} 1.2.3 doesn't support tuples in {dse-short} versions 6.8.4 and earlier.

Data validation tools can identify inconsistencies as missing or mismatched data, but you still need to have a plan to resolve them.
For example, you might need to modify your applications to use a different data type or perform additional post-migration writes to populate lost data.

It is crucial that you fully validate and test your new cluster before switching your traffic over to it.

{product-proxy} is ideal for supporting this transition because it allows both clusters to remain in place until you are completely certain you are ready to switch to the new cluster.
Additionally, your old cluster remains untouched and available for rollback or reversion if necessary.

=== Get started with {product-short} and {hcd-short}

For information about clusters that are eligible for {product} to {hcd-short}, see xref:ROOT:zdm-proxy-migration-paths.adoc[].

To begin your {product} to {hcd-short}, go to xref:ROOT:introduction.adoc[].

You must set up your {hcd-short} clusters before you can enable the {product-proxy}.
For information about installing and configuring {hcd-short}, see the xref:1.1@hyper-converged-database:get-started:get-started-hcd.adoc[{hcd-short} documentation].

== Migrate your code

After migrating your data to {hcd-short}, your applications can connect exclusively to your new databases.

If you are already using a compatible {cass-short} driver, you can modify the driver connection string to connect to the new or upgraded databases.

[IMPORTANT]
====
Your {cass-short} driver version must be compatible with {hcd-short}.

If you are using an early driver version or a {dse-short}-only driver, you must upgrade to a driver version that is compatible with {hcd-short}.

For more information, see xref:datastax-drivers:compatibility:driver-matrix.adoc[].
====

For some migrations, changing the connection string might be the only change you need to make to your code.
However, you might want to update your code to take advantage of features and improvements available in your new database platform or a newer driver version.

For example, {hcd-short} includes an {astra} {data-api} server that you can use for application development with your {hcd-short} databases, including vector search and hybrid search capabilities.
It provides several client libraries and direct access over HTTP.

For more information about connecting to {hcd-short} databases, see the xref:1.1@hyper-converged-database:get-started:get-started-hcd.adoc[{hcd-short} documentation].

== Get support for your migration

If you have questions about your {hcd-short} migration, contact your {company} account representative or {support-url}[{company} Support].

== See also

* xref:ROOT:mc-migration-paths.adoc[]
//* xref:1.2@hyper-converged-database:migrate:dse-68-to-hcd-12.adoc[In-place upgrade from {dse-short} 6.8 to {hcd-short} 1.2.3]
//* xref:1.1@hyper-converged-database:migrate:dse-51-to-hcd-11.adoc[In-place upgrade from {dse-short} 5.1 to {hcd-short} 1.1]
4 changes: 2 additions & 2 deletions modules/ROOT/pages/mc-migration-paths.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ Additionally, {mc} isn't applicable to {astra-db}, which has its own interface f
Cluster migration moves your entire cluster from one infrastructure to another, including its data.
**It is meant as an infrastructure migration only, not a database software migration.**

If you are migrating both your infrastructure _and_ your database software, create your new cluster in {mc}, and then migrate your data from your old cluster directly to the new cluster on {mc}.
If you are migrating both your infrastructure _and_ your database software, create your new cluster in {mc}, and then use xref:ROOT:components.adoc[{company} migration tools] to migrate your data from your old cluster directly to the new cluster on {mc}.

For information about migrating your infrastructure to {mc}, see the following:
For information about migrating your infrastructure _only_ to {mc}, see the following:

* xref:mission-control:migrate:oss-cass-to-mission-control.adoc[Migrate {cass-short} clusters to {mc}]
* xref:mission-control:migrate:dse-to-mission-control.adoc[Migrate {dse-short} and other {cass-short}-based clusters to {mc}]