-
Notifications
You must be signed in to change notification settings - Fork 1
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
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
= {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 stays active and unchanged while you setup 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 doesn't support tuples in {dse-short} versions 6.8.4 and earlier. | ||
aimurphy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Data validation tools can catch these inconsistencies as missing or mismatched data, but you will still need to have a plan to resolve the inconsistencies. | ||
aimurphy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
For example, you might need to modify your applications to use a different data type, or you might need to perform additional post-migration writes to populate lost data. | ||
aimurphy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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 setup your {hcd-short} clusters before you can enable the {product-proxy}. | ||
aimurphy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
For information about installing and configuring {hcd-short}, see the xref:1.2@hcd: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.2@hcd: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@hcd:migrate:dse-68-to-hcd-12.adoc[In-place upgrade from {dse-short} 6.8 to {hcd-short} 1.2] |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.