docs: add concurrent data migration procedure guide#2421
Open
ctron wants to merge 1 commit into
Open
Conversation
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideAdds a new AsciiDoc guide describing how to run concurrent data migrations against a copied production database, and wires it into the existing migration docs navigation. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- In the new concurrent data migration guide, consider cross-linking more explicitly to the existing
data.adocpage so readers can easily understand how the concurrent workflow builds on the baseline data migration concepts. - For the Kubernetes Job manifest example, it may help to clearly mark customizable fields (e.g., image name, namespace, resource requests/limits, secret names) so operators can better distinguish between required values and example placeholders.
- Where you describe single-runner vs multi-runner concurrency, consider calling out any ordering or idempotency assumptions of individual migrations so users understand when parallel execution is safe and when it is not.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In the new concurrent data migration guide, consider cross-linking more explicitly to the existing `data.adoc` page so readers can easily understand how the concurrent workflow builds on the baseline data migration concepts.
- For the Kubernetes Job manifest example, it may help to clearly mark customizable fields (e.g., image name, namespace, resource requests/limits, secret names) so operators can better distinguish between required values and example placeholders.
- Where you describe single-runner vs multi-runner concurrency, consider calling out any ordering or idempotency assumptions of individual migrations so users understand when parallel execution is safe and when it is not.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
3 tasks
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2421 +/- ##
==========================================
+ Coverage 71.30% 71.33% +0.02%
==========================================
Files 450 450
Lines 27164 27191 +27
Branches 27164 27191 +27
==========================================
+ Hits 19370 19397 +27
+ Misses 6663 6656 -7
- Partials 1131 1138 +7 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Add a step-by-step guide for running data migrations with concurrency, including environment variables, single/multi-runner examples, and a full Kubernetes Job manifest covering the complete workflow. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
fad5c6d to
9fbd3c1
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
MIGRATION_DATA_SKIP)data.adocand the new guide innav.adocTest plan
migration/src/data/mod.rs(Optionsstruct)trustd/src/db.rsmigration/src/lib.rs🤖 Generated with Claude Code
Summary by Sourcery
Add documentation for running concurrent data migrations and link it into the migration docs navigation.
Documentation: