Update instance types and preferences documentation for lifecycle changes #929
Conversation
…nges - Add deprecation notices for PreferredUseEFi and PreferredUseSecureBoot fields (v1.5.0) - Document PreferredEfi as the preferred replacement for EFI configuration - Update ControllerRevision automatic upgrade behavior (v1.3.0) - Note that manual revisionName removal is no longer required in most cases - Update examples to use current best practices with PreferredEfi - Add cross-reference in virtual_hardware.md for preference-based EFI configuration Fixes: kubevirt#921 Co-Authored-By: Claude <[email protected]> Signed-off-by: Andrew Burden <[email protected]>
kubevirt-bot
added
the
dco-signoff: yes
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
@0xFelix |
| !!! Note | ||
| As of v1.3.0, ControllerRevisions containing instance types and preferences are automatically upgraded to their latest available version when the VirtualMachine owning them is resynced by virt-controller. Manual removal of `revisionName` is no longer required for most use cases. | ||
|
|
||
| For KubeVirt versions prior to v1.3.0, users can opt in to moving to a newer generation of an instance type or preference by removing the referenced `revisionName` from the appropriate matcher within the `VirtualMachine` object. This will result in fresh `ControllerRevisions` being captured and used. |
There was a problem hiding this comment.
It is important to distinguish between generation and version here. ControllerVersions can be updated to the latest version, but the generation (i.e., the content) should remain unchanged. If revisionName is cleared manually, a new generation is captured and stored in a CR with the latest version. Automatic updates of a CR's version do not change its contents.
| ``` | ||
|
|
||
| In order for this change to be picked up within the `VirtualMachine`, we need to stop the running `VirtualMachine` and clear the `revisionName` referenced by the `InstancetypeMatcher`: | ||
| !!! Note |
There was a problem hiding this comment.
Not correct, the valid way to pickup changes to the contents of an instancetype/preference is to clear the revisionName (i.e. what was said before).
3 participants
What this PR does / why we need it:
Fixes: #921
Special notes for your reviewer:
Created with Claude, from an issue that was created by a different Claude agent, from a list of inconsistencies generated from a comparison of the user-guide and the release notes.
Reviewed by human me prior to PR to pick up formatting, style, and redundancy issues.
Release note: