DOC-4238, DOC-4510 Sideloader GA prep, Relaunch function, begin migration docs cleanup #194

aimurphy · 2025-03-31T21:47:23Z

Direct changes for Sideloader GA

Prepare for Sideloader GA (DOC-4238):

Bring Astra DB Sideloader docs from astra-vector-docs repo.
Separate the content into multiple pages. The first page is "About Sideloader" and you can see the other pages below that on the nav. Unless otherwise noted, the Astra DB sideloader content is the same, aside from the multi-page layout.
Add a small troubleshooting page, including the relaunch functionality (DOC-4510) and the current manual restart option.
Refresh the prerequisites and add some new ones. The PCU prerequisite and pricing information are under "Target Astra DB database requirements".
Refresh the ZDM Phase 2 page, and add sideloader as one of the options for Phase 2 of ZDM. I will probably edit this again in the future.
Add Astra DB Sideloader to the migration tools list on the migration docs index page. This is specifically for Astra DB and different from the DSE Sideloader. Note that this page will get more updates in a future PR.

General migration doc cleanup

Begin general cleanup of the migration docs:

Clean up redundant CDM content - The same partials were used on cdm-overview.adoc + cdm-steps.adoc and cassandra-data-migrator.adoc. There was no difference between the instructions aside from being on two pages vs one page. Now, the content is all on cassandra-data-migrator.adoc, and cdm-overview.adoc just includes the entire body of cassandra-data-migrator.adoc.
Remove CDM parameters content that was supposed to be removed in DOC-4573
Remove redundant partials (small amounts of content, content that was used only once, content that was commented out)
Remove unnecessary usage of ifdef and {imageprefix}
Replace outdated release notes page with links to GitHub repos for ZDM proxy, ZDM automation, and CDM.
Add links to migration content in other docsets (until we can do a more formal alignment).

The following pages will receive further edits in future PRs. They don't need a detailed review at this time:

Start to rewrite the ZDM introduction page and the doc set's index page
Start to rewrite create-target.adoc and connect-clients-to-target.adoc
Start to rewrite troubleshooting tips, and removed the redundant parent troubleshooting page that had no unique content.

⚠️ Dependent PRs

This PR is dependent on:

The PCU PRs:
- https://github.com/riptano/astra-vector-docs/pull/892
- https://github.com/riptano/datastax-docs-site/pull/260
- The PCU PRs must be merged before or with the sideloader GA PRs
- ⚠️ Once merged, fix the PCU links in prepare-sideloader.adoc in this PR.
Serverless sideloader PR: https://github.com/riptano/astra-vector-docs/pull/894
- This is a smaller PR that modifies Astra DB Serverless by removing the sideloader content, adding a release note, and adding some other minor text regarding Sideloader.
- ⚠️ Update date in release note
Unhide sideloader PR: https://github.com/riptano/datastax-docs-site/pull/265
- Also unhide in algolia at merge time

plpesvc-ds · 2025-03-31T22:03:12Z

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

DOC-4238, DOC-4510 Sideloader GA prep, Relaunch function, begin migration docs cleanup #194 (this pull request)
https://github.com/riptano/astra-vector-docs/pull/894

Deploying draft.
Deploy successful! View draft

plpesvc-ds · 2025-03-31T22:27:24Z

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

DOC-4238, DOC-4510 Sideloader GA prep, Relaunch function, begin migration docs cleanup #194 (this pull request)
https://github.com/riptano/astra-vector-docs/pull/894

Deploying draft.
Deploy successful! View draft

plpesvc-ds · 2025-03-31T22:48:19Z

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

DOC-4238, DOC-4510 Sideloader GA prep, Relaunch function, begin migration docs cleanup #194 (this pull request)
https://github.com/riptano/astra-vector-docs/pull/894

Deploying draft.
Deploy successful! View draft

modules/sideloader/pages/prepare-sideloader.adoc

plpesvc-ds · 2025-04-01T15:24:17Z

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

DOC-4238, DOC-4510 Sideloader GA prep, Relaunch function, begin migration docs cleanup #194 (this pull request)
https://github.com/riptano/astra-vector-docs/pull/894

Deploying draft.
Deploy successful! View draft

plpesvc-ds · 2025-04-01T22:17:47Z

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

DOC-4238, DOC-4510 Sideloader GA prep, Relaunch function, begin migration docs cleanup #194 (this pull request)
https://github.com/riptano/astra-vector-docs/pull/894

Deploying draft.
Deploy successful! View draft

plpesvc-ds · 2025-04-01T22:33:23Z

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

DOC-4238, DOC-4510 Sideloader GA prep, Relaunch function, begin migration docs cleanup #194 (this pull request)
https://github.com/riptano/astra-vector-docs/pull/894

Deploying draft.
Deploy successful! View draft

plpesvc-ds · 2025-04-03T21:05:00Z

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

DOC-4238, DOC-4510 Sideloader GA prep, Relaunch function, begin migration docs cleanup #194 (this pull request)
https://github.com/riptano/astra-vector-docs/pull/894

Deploying draft.
Deploy successful! View draft

alicel

submitting my comments so far

modules/sideloader/pages/sideloader-overview.adoc

modules/sideloader/pages/prepare-sideloader.adoc

modules/sideloader/pages/troubleshoot-sideloader.adoc

plpesvc-ds · 2025-04-07T19:44:54Z

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

DOC-4238, DOC-4510 Sideloader GA prep, Relaunch function, begin migration docs cleanup #194 (this pull request)
https://github.com/riptano/astra-vector-docs/pull/894

Deploying draft.
Deploy successful! View draft

plpesvc-ds · 2025-04-07T19:51:17Z

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

DOC-4238, DOC-4510 Sideloader GA prep, Relaunch function, begin migration docs cleanup #194 (this pull request)
https://github.com/riptano/astra-vector-docs/pull/894

Deploying draft.
Deploy successful! View draft

plpesvc-ds · 2025-04-07T20:26:19Z

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

DOC-4238, DOC-4510 Sideloader GA prep, Relaunch function, begin migration docs cleanup #194 (this pull request)
https://github.com/riptano/astra-vector-docs/pull/894

Deploying draft.
Deploy successful! View draft

plpesvc-ds · 2025-04-07T20:57:59Z

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

DOC-4238, DOC-4510 Sideloader GA prep, Relaunch function, begin migration docs cleanup #194 (this pull request)
https://github.com/riptano/astra-vector-docs/pull/894

Deploying draft.
Deploy successful! View draft

aimurphy · 2025-04-07T21:00:30Z

modules/sideloader/pages/prepare-sideloader.adoc

+--
+Because {sstable-sideloader} operations are typically short-term, resource-intensive events, you can create a flexible capacity PCU group exclusively to support your target database during the migration.
+
+//After PCU PR merge: xref:astra-db-serverless:administration:create-pcu.adoc#flexible-capacity[create a flexible capacity PCU group]


Edit link before merge (1)

aimurphy · 2025-04-07T21:00:42Z

modules/sideloader/pages/prepare-sideloader.adoc

+--
+If you plan to keep your target database in a PCU group after the migration, you can create a committed capacity PCU group for your target database.
+
+//After PCU PR merge: xref:astra-db-serverless:administration:create-pcu.adoc#committed-capacity[create a committed capacity PCU group]


Edit link before merge (2)

plpesvc-ds · 2025-04-07T21:16:42Z

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

DOC-4238, DOC-4510 Sideloader GA prep, Relaunch function, begin migration docs cleanup #194 (this pull request)
https://github.com/riptano/astra-vector-docs/pull/894

Deploying draft.
Deploy successful! View draft

plpesvc-ds · 2025-04-07T21:21:38Z

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

DOC-4238, DOC-4510 Sideloader GA prep, Relaunch function, begin migration docs cleanup #194 (this pull request)
https://github.com/riptano/astra-vector-docs/pull/894

Deploying draft.
Deploy successful! View draft

plpesvc-ds · 2025-04-07T21:43:28Z

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

DOC-4238, DOC-4510 Sideloader GA prep, Relaunch function, begin migration docs cleanup #194 (this pull request)
https://github.com/riptano/astra-vector-docs/pull/894

Deploying draft.
Deploy successful! View draft

aimurphy · 2025-04-07T22:20:51Z

modules/sideloader/pages/prepare-sideloader.adoc

+== Command line knowledge requirements
+
+Due to the nature of the {sstable-sideloader} process and the tools involved, you need to be familiar with using the command line, including the following:
+
+* Installing and using CLI tools
+* Issuing curl commands
+* Basic scripting
+* Modifying example command to your environment
+* Security best practices
+
+[IMPORTANT]
+====
+The {sstable-sideloader} process uses authentication credentials to write to the migration directory and your database.
+
+Make sure you understand how to securely store and use sensitive credentials when working on the command line.
+====


Eric suggested moving this to the top of the page

aimurphy added 9 commits March 28, 2025 09:33

initial move

78bff33

initial cleanup and integration

cbe2730

clean and revise cdm instructions

f1e2a58

address redundant partials

631f314

sideloader images

8f77169

delete unnecessary stuff

ec2d9f0

remove conf properties as per doc-4573

d2c873b

break up sideloader pages

7d818f1

minor adjustments

fb12935

aimurphy self-assigned this Mar 31, 2025

This comment was marked as resolved.

Sign in to view

comment temporarily broken link

0107cac

remove dsbulk loader from phase 2 nav

4beeb90

use page-alias to redirect

33def88

DomCouldwell reviewed Apr 1, 2025

View reviewed changes

modules/sideloader/pages/prepare-sideloader.adoc Outdated Show resolved Hide resolved

troubleshooting and pricing

b0362eb

troubleshooting and release notes

d07c52d

TODO

d695266

sme review 3-apr-25

095c163

alicel reviewed Apr 4, 2025

View reviewed changes

modules/sideloader/pages/sideloader-overview.adoc Outdated Show resolved Hide resolved

modules/sideloader/pages/prepare-sideloader.adoc Outdated Show resolved Hide resolved

modules/sideloader/pages/prepare-sideloader.adoc Outdated Show resolved Hide resolved

alicel reviewed Apr 4, 2025

View reviewed changes

modules/sideloader/pages/troubleshoot-sideloader.adoc Show resolved Hide resolved

modules/sideloader/pages/troubleshoot-sideloader.adoc Outdated Show resolved Hide resolved

modules/sideloader/pages/troubleshoot-sideloader.adoc Outdated Show resolved Hide resolved

add dse and mc links

331740d

cleanup timer

c6a7c22

SME review

c3e5027

test mc link

ff42e36

This comment was marked as resolved.

Sign in to view

link and pcu prereq

41d7144

aimurphy commented Apr 7, 2025

View reviewed changes

aimurphy added 2 commits April 7, 2025 14:14

redefine sstable-sideloader attribute

8990d03

a to an

85aedd0

tweak prerequisites

bdf7180

aimurphy commented Apr 7, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC-4238, DOC-4510 Sideloader GA prep, Relaunch function, begin migration docs cleanup #194

DOC-4238, DOC-4510 Sideloader GA prep, Relaunch function, begin migration docs cleanup #194

aimurphy commented Mar 31, 2025 •

edited

Loading

This comment was marked as resolved.

plpesvc-ds commented Mar 31, 2025 •

edited

Loading

plpesvc-ds commented Mar 31, 2025 •

edited

Loading

plpesvc-ds commented Mar 31, 2025 •

edited

Loading

plpesvc-ds commented Apr 1, 2025 •

edited

Loading

plpesvc-ds commented Apr 1, 2025 •

edited

Loading

plpesvc-ds commented Apr 1, 2025 •

edited

Loading

plpesvc-ds commented Apr 3, 2025 •

edited

Loading

alicel left a comment

plpesvc-ds commented Apr 7, 2025 •

edited

Loading

plpesvc-ds commented Apr 7, 2025 •

edited

Loading

plpesvc-ds commented Apr 7, 2025 •

edited

Loading

This comment was marked as resolved.

plpesvc-ds commented Apr 7, 2025 •

edited

Loading

aimurphy Apr 7, 2025

aimurphy Apr 7, 2025

plpesvc-ds commented Apr 7, 2025 •

edited

Loading

plpesvc-ds commented Apr 7, 2025 •

edited

Loading

plpesvc-ds commented Apr 7, 2025 •

edited

Loading

aimurphy Apr 7, 2025

DOC-4238, DOC-4510 Sideloader GA prep, Relaunch function, begin migration docs cleanup #194

Are you sure you want to change the base?

DOC-4238, DOC-4510 Sideloader GA prep, Relaunch function, begin migration docs cleanup #194

Conversation

aimurphy commented Mar 31, 2025 • edited Loading

Direct changes for Sideloader GA

General migration doc cleanup

⚠️ Dependent PRs

This comment was marked as resolved.

plpesvc-ds commented Mar 31, 2025 • edited Loading

plpesvc-ds commented Mar 31, 2025 • edited Loading

plpesvc-ds commented Mar 31, 2025 • edited Loading

plpesvc-ds commented Apr 1, 2025 • edited Loading

plpesvc-ds commented Apr 1, 2025 • edited Loading

plpesvc-ds commented Apr 1, 2025 • edited Loading

plpesvc-ds commented Apr 3, 2025 • edited Loading

alicel left a comment

Choose a reason for hiding this comment

plpesvc-ds commented Apr 7, 2025 • edited Loading

plpesvc-ds commented Apr 7, 2025 • edited Loading

plpesvc-ds commented Apr 7, 2025 • edited Loading

This comment was marked as resolved.

plpesvc-ds commented Apr 7, 2025 • edited Loading

aimurphy Apr 7, 2025

Choose a reason for hiding this comment

aimurphy Apr 7, 2025

Choose a reason for hiding this comment

plpesvc-ds commented Apr 7, 2025 • edited Loading

plpesvc-ds commented Apr 7, 2025 • edited Loading

plpesvc-ds commented Apr 7, 2025 • edited Loading

aimurphy Apr 7, 2025

Choose a reason for hiding this comment

aimurphy commented Mar 31, 2025 •

edited

Loading

plpesvc-ds commented Mar 31, 2025 •

edited

Loading

plpesvc-ds commented Mar 31, 2025 •

edited

Loading

plpesvc-ds commented Mar 31, 2025 •

edited

Loading

plpesvc-ds commented Apr 1, 2025 •

edited

Loading

plpesvc-ds commented Apr 1, 2025 •

edited

Loading

plpesvc-ds commented Apr 1, 2025 •

edited

Loading

plpesvc-ds commented Apr 3, 2025 •

edited

Loading

plpesvc-ds commented Apr 7, 2025 •

edited

Loading

plpesvc-ds commented Apr 7, 2025 •

edited

Loading

plpesvc-ds commented Apr 7, 2025 •

edited

Loading

plpesvc-ds commented Apr 7, 2025 •

edited

Loading

plpesvc-ds commented Apr 7, 2025 •

edited

Loading

plpesvc-ds commented Apr 7, 2025 •

edited

Loading

plpesvc-ds commented Apr 7, 2025 •

edited

Loading