Document KVM VM metadata handling in unmanage process#595
Document KVM VM metadata handling in unmanage process#595pavanaravapalli wants to merge 2 commits intoapache:4.22from
Conversation
Added a warning about KVM VM metadata preservation when unmanaged.
|
Correct me if I'm wrong, I think it may be phrased a bit shorter: I specifically omitted the 4.22 version because the documentation is also versioned if I am not mistaken. So the older documentation versions will not contain this line. |
It's marked for 4.22.0 milestone Last time when i checked this PR apache/cloudstack#11061. How ever this Doc PR goes to main branch. |
|
@pavanaravapalli @phsm, I think it does not hurt to leave the version in as a lot of people will read the “latest” documentation without caring to select a specific version. If otherwise fine, I’m merging. |
There was a problem hiding this comment.
Sorry, mistakently approved this. @pavanaravapalli can you please check my comment.
| - The Instance must be a VMware Instance (as of CloudStack 4.19, it's also possible to unmanage a KVM-based Instances) | ||
|
|
||
| .. warning:: | ||
| Starting with the 4.22.0 release, when a KVM VM is unmanaged, its infrastructure metadata (zone, pod, cluster, and host) in the libvirt VM XML is preserved. |
There was a problem hiding this comment.
This information is already document in this PR https://github.com/apache/cloudstack-documentation/pull/562/files
is this something else ?
There was a problem hiding this comment.
This is different from https://github.com/apache/cloudstack-documentation/pull/562/files.
It focuses on retaining CloudStack metadata on libvirt XML even after the VM resource is unmanaged from ACS.
@pavanaravapalli @phsm the PR apache/cloudstack#11061 is merged after 4.22.0 release (earlier it was part of 4.22.0 milestone, but not merged before the release), so the doc PR should target 4.22 (as this should go with 4.22.1 release notes later, and also merged forward to main). cc @DaanHoogland |
@sureshanaparti |
@pavanaravapalli correct, version should be 4.22.1. no need of separate PR. |
| - The Instance must be a VMware Instance (as of CloudStack 4.19, it's also possible to unmanage a KVM-based Instances) | ||
|
|
||
| .. warning:: | ||
| Starting with the 4.22.0 release, when a KVM VM is unmanaged, its infrastructure metadata (zone, pod, cluster, and host) in the libvirt VM XML is preserved. |
There was a problem hiding this comment.
| Starting with the 4.22.0 release, when a KVM VM is unmanaged, its infrastructure metadata (zone, pod, cluster, and host) in the libvirt VM XML is preserved. | |
| Starting with the 4.22.1 release, when a KVM instance is unmanaged, the infrastructure metadata (zone, pod, cluster, and host details) is preserved in the libvirt VM XML. |
Note: if any change in the retaining behavior, mainly clearing the metadata while unmanaging instance is handled before 4.22.1, this warning message is not needed and has to be reverted. cc @DaanHoogland
There was a problem hiding this comment.
@sureshanaparti
Suresh, prior to 4.22.1, the preserved libvirt XML behavior was meant to support non-transient domains required for unmanaged VMs. During that process, no CloudStack metadata was stored — it only started being preserved after the libvirt metadata enhancement. I think this is worth mentioning in the release notes. Please correct me if I’m mistaken.
There was a problem hiding this comment.
@sureshanaparti
Changes applied as suggested — ready for review.
There was a problem hiding this comment.
@sureshanaparti Suresh, prior to 4.22.1, the preserved libvirt XML behavior was meant to support non-transient domains required for unmanaged VMs. During that process, no CloudStack metadata was stored — it only started being preserved after the libvirt metadata enhancement. I think this is worth mentioning in the release notes. Please correct me if I’m mistaken.
fine, we can mention that. I'm making a point that if any PR addresses the cleanup of the libvirt metadata in 4.22.1 itself, this note in the doc has to revisited.
6 participants
Added a warning about KVM VM metadata preservation when unmanaged.
From the enhancement PR apache/cloudstack#11061, as per discussion concluded to explicitly call out the VM behavior for unmanaged KVM VMs regarding the retention of libvirt metadata.
This PR adds a note to the documentation warning users that CloudStack does not cleanup the libvirt metadata for unamanged VMs, leaving it for user's choice.
📚 Documentation preview 📚: https://cloudstack-documentation--595.org.readthedocs.build/en/595/