apache
Document KVM VM metadata handling in unmanage process
Added a warning about KVM VM metadata preservation when unmanaged.
From the enhancement PR https://github.com/apache/cloudstack/pull/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/
Correct me if I'm wrong, I think it may be phrased a bit shorter:
When a KVM VM is unmanaged, its metadata in the libvirt domain XML remains unchanged.
This information is left for the user’s discretion allowing them to either retain it or remove it themselves.
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.
Correct me if I'm wrong, I think it may be phrased a bit shorter:
When a KVM VM is unmanaged, its metadata in the libvirt domain XML remains unchanged. This information is left for the user’s discretion allowing them to either retain it or remove it themselves.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.
@phsm
It's marked for 4.22.0 milestone Last time when i checked this PR https://github.com/apache/cloudstack/pull/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.
Correct me if I'm wrong, I think it may be phrased a bit shorter:
When a KVM VM is unmanaged, its metadata in the libvirt domain XML remains unchanged. This information is left for the user’s discretion allowing them to either retain it or remove it themselves.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.
@phsm
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 the PR https://github.com/apache/cloudstack/pull/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
Correct me if I'm wrong, I think it may be phrased a bit shorter:
When a KVM VM is unmanaged, its metadata in the libvirt domain XML remains unchanged. This information is left for the user’s discretion allowing them to either retain it or remove it themselves.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.
@phsm 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 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 Should I update the version in the docs from 4.22.0 → 4.22.1? Will this get merged into both main and 4.22.1, or do I need to open separate PRs?
@sureshanaparti Should I update the version in the docs from 4.22.0 → 4.22.1? Will this get merged into both main and 4.22.1, or do I need to open separate PRs?
@pavanaravapalli correct, version should be 4.22.1. no need of separate PR.