Repository navigation
docs: add What Happens During a Migration for Talos Director - #858
sterlingkoch wants to merge 2 commits into
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
📋 Automated documentation review
|
| @@ -0,0 +1,120 @@ | |||
| --- | |||
There was a problem hiding this comment.
i think this doc is headed like a feature article rather than documentation, and might be difficult to search and find things. other headings i suggest are:
Before anything is copied --> Requirements
The stages --> Conversion stages
What each cutover mode does to the source --> Cutover modes
If something goes wrong --> Failure handling and rollback
Other ways in --> Other migration methods
|
|
||
| [Migrate from VMware](/director/compute/migrate-from-vmware) walks through the wizard. This page explains what the conversion engine does once you click **Convert**: where the work runs, what each stage changes, what each cutover mode means for the source VM, and what happens if something goes wrong in the middle. | ||
|
|
||
| ## Planning a migration |
There was a problem hiding this comment.
this makes it seem like this section is describing how to plan a migration. would this be a better heading "Converting VMs in waves."
|
these are what claude said, are the code red reviews on this pr, what do you think of them: These four could cause real harm if they're wrong. Everything else is clarity or polish. 1. Downtime is understated. The Note and the mode table say the outage is shutdown, final delta, and first boot. The diagram puts Converting and Customizing inside the outage too, and a full 2. Cancel and rollback promise more than they deliver. "The source VM is left as the engine found it" can't hold if you cancel after cutover, because the source is already shut down and VMware Tools are gone. "Rolling back means powering it on again" also skips that the source no longer has Tools. Rollback is what people rely on when things go wrong, so it has to be accurate. 3. The force window may mean a hard power-off. "The engine proceeds anyway" sounds harmless. If it actually forces the source off, the final delta comes from a VM that wasn't shut down cleanly, which is a data-consistency risk for databases and similar workloads. Readers need to know before they pick a force window. 4. A warm job without VDDK may not actually be warm. If vCenter's standard export can't do changed-block deltas, a "scheduled" or "automatic" job without VDDK is effectively a full copy. The mode table would then promise a short outage that doesn't happen. All four need an engineer to confirm before you rewrite anything, since I can't check them against the source. The wording of each fix depends on the answer. |
…n engine Warm cutover requires VDDK, the source is hard powered off after a grace period, conversion and customization fall inside the outage, and VMware Tools is removed from the converted copy rather than the source. Adopts the review's section headings. Signed-off-by: Sterling Koch <sterling.koch@siderolabs.com>
3fb549b to
5c7ad7d
Compare
|
claude said there are some contradictions here:
The last one is about the source VM, so it’s technically consistent, but readers will trip over it. Also, the wizard page has no option for “if you asked for it”. Is it a field in Configure?
|
What
A new explanation page, What Happens During a Migration, under Compute.
Why
Migrate from VMware is the console how-to. Someone planning a migration also needs to know where a conversion runs, what each stage changes, what each cutover mode does to the source VM, and what happens when something fails. That is explanation, so it gets its own page rather than growing the how-to.
Change
public/director/compute/what-happens-during-a-migration.mdx: planning in waves, where the conversion runs, prerequisites (including the VDDK fallback), the stages with a Mermaid diagram and status table, cutover modes, failure handling, and the other import paths (OVF, existing disk images, cross-cluster, cross-instance).director.yaml, and the regenerateddocs.json.Testing
make style-check-changed-local,npx mint broken-links, andnpx mint dev, with the diagram checked in light and dark mode.