docs: Add stateless migration quickstart tutorial#569
Conversation
Signed-off-by: M Sajid Mansoori <mmansoor@redhat.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughAdds a new quickstart doc for Crane stateless migration, covering setup, export, transform, apply, validate, instructions-file usage, and troubleshooting. ChangesStateless Migration Quickstart Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related issues
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/stateless-migration-quickstart.md`:
- Around line 185-195: The validation summary example is inconsistent with the
JSON report example, since the console snippet says 4 scanned while the report
shows 3 results and totalScanned: 3. Update the example output and any related
validation summary text in the stateless migration quickstart so the
scanned/compatible/incompatible counts match the report example consistently,
including the “Summary” and “Result” snippets tied to the validation flow.
- Around line 189-190: The quickstart sample output uses a different target
context label than the command example, so update the expected output in the
migration doc to use the same `${TARGET_CONTEXT}` value consistently. Locate the
sample log lines that show the live validation context and change the displayed
context name to match the target context used elsewhere in the doc, keeping the
naming aligned in the quickstart flow.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 585b7db4-7898-4132-93cb-ada07330d7d6
📒 Files selected for processing (1)
docs/stateless-migration-quickstart.md
Test Coverage ReportTotal: 46.9% Per-package coverage
Full function-level detailsPosted by CI |
b6b8f09 to
f5d5124
Compare
f5d5124 to
310487e
Compare
|
|
||
| In most pipelines, your custom stage is the last stage under `transform/`, so rendering that directory should show the manifests that will feed into the final apply output. | ||
|
|
||
| For a deeper explanation of stage ordering, stage structure, and multi-stage behavior, see [Multi-Stage Kustomize Transform Pipeline](./kustomize-multistage.md). |
|
|
||
| For a deeper explanation of stage ordering, stage structure, and multi-stage behavior, see [Multi-Stage Kustomize Transform Pipeline](./kustomize-multistage.md). | ||
|
|
||
| If a custom stage already contains edits, rerun with `--force` to regenerate: |
There was a problem hiding this comment.
Fixed with more clear info
Signed-off-by: M Sajid Mansoori <mmansoor@redhat.com>
Signed-off-by: M Sajid Mansoori <mmansoor@redhat.com>
Signed-off-by: M Sajid Mansoori <mmansoor@redhat.com>
Signed-off-by: M Sajid Mansoori <mmansoor@redhat.com>
There was a problem hiding this comment.
♻️ Duplicate comments (1)
docs/stateless-migration-quickstart.md (1)
207-208: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winKeep target context naming consistent in validation examples.
Line 207-208 uses
tgt, but the command and JSON example use${TARGET_CONTEXT}/tgt-cluster. Please align these to one value throughout the section.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/stateless-migration-quickstart.md` around lines 207 - 208, The validation example uses inconsistent target context names, mixing “tgt” with “${TARGET_CONTEXT}” and “tgt-cluster” across the section. Update the affected example in the migration quickstart so the command output, JSON example, and any referenced context value all use the same target context name consistently. Use the surrounding validation example text and the “Mode: live (context: …)” output as the anchors when making the edit.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Duplicate comments:
In `@docs/stateless-migration-quickstart.md`:
- Around line 207-208: The validation example uses inconsistent target context
names, mixing “tgt” with “${TARGET_CONTEXT}” and “tgt-cluster” across the
section. Update the affected example in the migration quickstart so the command
output, JSON example, and any referenced context value all use the same target
context name consistently. Use the surrounding validation example text and the
“Mode: live (context: …)” output as the anchors when making the edit.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 9b44a759-5c88-4ff8-8082-e2e07ab11566
📒 Files selected for processing (1)
docs/stateless-migration-quickstart.md
Signed-off-by: M Sajid Mansoori <mmansoor@redhat.com>
Signed-off-by: M Sajid Mansoori <mmansoor@redhat.com>
|
/rfr |
Summary by CodeRabbit