Skip to content

Conversation

@kadinsayani
Copy link
Member

@kadinsayani kadinsayani commented Dec 2, 2024

Resolves #13307

This PR adds developer documentation outlining the VM live migration process.

@kadinsayani kadinsayani force-pushed the 13307-vm-live-migration-dev-docs branch 5 times, most recently from 7097b26 to ebfb411 Compare December 3, 2024 00:36
@kadinsayani kadinsayani force-pushed the 13307-vm-live-migration-dev-docs branch from ebfb411 to b267ee6 Compare December 3, 2024 21:59
@github-actions github-actions bot added the Documentation Documentation needs updating label Dec 3, 2024
@kadinsayani kadinsayani force-pushed the 13307-vm-live-migration-dev-docs branch 4 times, most recently from 00ecdc6 to 3399871 Compare December 3, 2024 22:52
@kadinsayani
Copy link
Member Author

@tomponline any additional sections you'd like to see here before I request reviews, or perhaps more detail in a particular section?

@kadinsayani kadinsayani marked this pull request as ready for review December 4, 2024 18:25
@kadinsayani kadinsayani changed the title WIP: Documentation: VM Live Migration Developer Documentation Documentation: VM Live Migration Developer Documentation Dec 4, 2024
@kadinsayani kadinsayani requested a review from minaelee December 6, 2024 01:33
@kadinsayani kadinsayani force-pushed the 13307-vm-live-migration-dev-docs branch 4 times, most recently from 6f81d29 to b1f6cb8 Compare December 6, 2024 17:11
@kadinsayani
Copy link
Member Author

The tests should pass once #14600 is merged.

@minaelee
Copy link
Contributor

minaelee commented Dec 6, 2024

The tests should pass once #14600 is merged.

As I mentioned in that PR, the fix implemented there causes other issues.

I assume this is the test failure you're wanting to fix:

WARNING: reference/vm-live-migration-internals: 404 Client Error: Not Found for url: https://discuss.linuxcontainers.org/t/50734.json [canonical-sphinx-extensions.linktext]

where you want to direct to the Ubuntu discourse article and not a LinuxContainers one.

That should be fixed by using the ubuntu prefix:

discourse: ubuntu:50734

in line 2 of vm-live-migration-internals.md in this PR, without need of #14600

Furthermore, to make sure that we don't rely on fetching the page title at build, which can cause the build to fail if the Ubuntu Discourse is down, add the title statically. The related-links extension we use requires replacing spaces in the title with  , so that will look like this:

discourse:ubuntu:[Online VM live-migration (QEMU to QEMU)](50734)

@minaelee
Copy link
Contributor

minaelee commented Dec 6, 2024

Per conversation with @kadinsayani, I understand that the intent of #14600 is to update the discourse links so that the Ubuntu one is the default (and eventually only) discourse used for related links. If it is merged as the default, you wouldn't need to use discourse:ubuntu and could use just discourse: instead.

However, you'd at least want to use the static title, for the build failure reasons I mentioned:

discourse:[Online VM live-migration (QEMU to QEMU)](50734)

If we aren't migrating all the lxc links to ubuntu at this time/not switching the default discourse, then you will need to specify discourse:ubuntu.

@kadinsayani kadinsayani force-pushed the 13307-vm-live-migration-dev-docs branch from b1f6cb8 to 6c87be3 Compare December 9, 2024 14:52
@kadinsayani kadinsayani force-pushed the 13307-vm-live-migration-dev-docs branch from 9c50463 to 54c1042 Compare December 9, 2024 15:18
@kadinsayani kadinsayani force-pushed the 13307-vm-live-migration-dev-docs branch from 54c1042 to 45be09d Compare December 9, 2024 20:36
@kadinsayani
Copy link
Member Author

Thanks for all your feedback @simondeziel!

I'm going to reword the steps to make things more clear.

@kadinsayani kadinsayani force-pushed the 13307-vm-live-migration-dev-docs branch 2 times, most recently from 62915dd to 586bc7c Compare December 10, 2024 14:29
@kadinsayani kadinsayani changed the title Documentation: VM Live Migration Developer Documentation Documentation: VM live migration developer documentation Dec 10, 2024
@kadinsayani kadinsayani changed the title Documentation: VM live migration developer documentation Documentation: VM live migration internals documentation Dec 10, 2024
@kadinsayani kadinsayani force-pushed the 13307-vm-live-migration-dev-docs branch 9 times, most recently from ce55e0b to dd603d5 Compare December 10, 2024 18:17
@kadinsayani kadinsayani force-pushed the 13307-vm-live-migration-dev-docs branch from dd603d5 to fa0ff72 Compare December 10, 2024 18:39
@kadinsayani kadinsayani force-pushed the 13307-vm-live-migration-dev-docs branch from fa0ff72 to 2b77167 Compare December 10, 2024 19:01
Copy link
Member

@tomponline tomponline left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM thanks!

@tomponline tomponline merged commit 5232ded into canonical:main Dec 11, 2024
24 checks passed
@kadinsayani kadinsayani deleted the 13307-vm-live-migration-dev-docs branch December 11, 2024 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Documentation needs updating

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document internal VM live migration process

4 participants