Skip to content

DOC-3299: document the VM state StorageClass for persistent EFI and TPM - #12186

Merged
Linus-SpectroCloud merged 8 commits into
masterfrom
doc-3299-vm-state-storage-class
Oct 12, 2026
Merged

Linus-SpectroCloud merged 8 commits into
masterfrom
doc-3299-vm-state-storage-class

Conversation

@Linus-SpectroCloud

@Linus-SpectroCloud Linus-SpectroCloud commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

✅ Pull Request Checklist

Before submitting your PR for review, please complete this checklist to ensure quality.

Checklist

  • The PR description in the Describe the Change section explains what changed and
    provides any additional context.
  • A Jira ticket is provided in the Jira Tickets section AND in the PR title. If this PR has
    no corresponding Jira ticket, then please indicate so in this section.
  • Preview links are for all affected pages are provided in the Changed Pages. If this PR
    makes no user-facing changes, please indicate so in this section.
  • Conduct a self-review for your pages using your preview links. Verify grammar, clarity, and accuracy.
  • Check formatting for your pages
    • Verify indentations, admonitions, and tables (if applicable).
    • Verify all images display.
  • Ensure all Vale comments are resolved.
    • If required, raise a PR to modify the
      Vale accept list.
      This can be done later, but leave a note if required.
  • All CI jobs have completed successfully.
  • Add Backport labels if the change should be reflected in previous versions. If required, remember to add the
    auto-backport label, as well as the backport-version-** labels.
  • Outside review: Does this PR require review outside of Docs? If yes, tag the appropriate reviewer (for
    example, Engineering, Product, etc.)
  • Add the notify-slack label once this checklist has been completed. The team will be notified and review your PR.

Good job! 👏👏👏


📝 Describe the Change

Documents what a VM with persistent firmware state needs on VMO 4.10.x: the VMPersistentState feature gate and a StorageClass that supports Filesystem.

  • Create a VM: Persistent EFI Variables and Persistent TPM State require the VMPersistentState gate. Without it, the wizard greys out both options and shows "Requires the VMPersistentState feature gate". The page then lists KubeVirt's StorageClass lookup order (vmStateStorageClass, the is-default-virt-class annotation, the cluster default). Secure Boot alone needs neither. The TPM row now uses the UI labels TPM Device and Persistent TPM State.
  • Upgrade the VMO Pack: a new post-upgrade task adds VMPersistentState on clusters upgraded from 4.9.x. Two new Parameter Mapping rows cover additionalFeatureGates and vmStateStorageClass. VMO Manager keeps the existing KubeVirt resource's gates and StorageClass when it takes over, and the 4.9.x values leave VMPersistentState commented out, so upgraded clusters don't have it.

Abirami confirmed the upgrade behavior and both ways to enable the gate: uncomment it in the 4.9.x values before the upgrade, or add it on the KubeVirt Configuration page after. The rest is verified against the VMO 4.10 source, the 4.9.9 pack values, and KubeVirt v1.8.4.


💻 Changed Pages


🎫 Jira Tickets

VMs with persistent EFI variables or a persistent TPM need vmStateStorageClass or a default StorageClass. In VMO pack 4.10.x, VMO Manager owns the KubeVirt resource, so set the value in the 4.9.x values before upgrading or edit it on the KubeVirt Configuration page afterward.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Linus-SpectroCloud Linus-SpectroCloud added auto-backport Enable backport backport-version-4-10 Backport change to version 4.10 labels Oct 9, 2026
@netlify

netlify Bot commented Oct 9, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit d5de18b
🔍 Latest deploy log https://app.netlify.com/projects/docs-spectrocloud/deploys/6acce21a6044010de5e56d9c
😎 Deploy Preview https://deploy-preview-12186--docs-spectrocloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@Linus-SpectroCloud Linus-SpectroCloud self-assigned this Oct 9, 2026
@Linus-SpectroCloud
Linus-SpectroCloud marked this pull request as ready for review October 12, 2026 12:19
@Linus-SpectroCloud
Linus-SpectroCloud requested a review from a team as a code owner October 12, 2026 12:19
@Linus-SpectroCloud Linus-SpectroCloud added the notify-slack Send notification to slack channel of PR ready for review label Oct 12, 2026
@github-actions

Copy link
Copy Markdown
Contributor

✅ Slack reviewers notified at 2026-10-12T12:20:56Z \n

@github-actions

Copy link
Copy Markdown
Contributor

✅ CI checks passed for commit 4b8cc8d.

@Linus-SpectroCloud
Linus-SpectroCloud enabled auto-merge (squash) October 12, 2026 13:18
@github-actions

Copy link
Copy Markdown
Contributor

✅ CI checks passed for commit 07f8647.

@github-actions

Copy link
Copy Markdown
Contributor

✅ CI checks passed for commit 8e185ac.

@Linus-SpectroCloud
Linus-SpectroCloud merged commit 27236f5 into master Oct 12, 2026
21 checks passed
@Linus-SpectroCloud
Linus-SpectroCloud deleted the doc-3299-vm-state-storage-class branch October 12, 2026 13:54
@vault-token-factory-spectrocloud

Copy link
Copy Markdown
Contributor

💚 All backports created successfully

Status Branch Result
✅ version-4-10

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

vault-token-factory-spectrocloud Bot added a commit that referenced this pull request Oct 12, 2026
…PM (#12186) (#12209)

* DOC-3299: document the VM state StorageClass for persistent EFI and TPM

VMs with persistent EFI variables or a persistent TPM need vmStateStorageClass or a default StorageClass. In VMO pack 4.10.x, VMO Manager owns the KubeVirt resource, so set the value in the 4.9.x values before upgrading or edit it on the KubeVirt Configuration page afterward.



* DOC-3299: apply verified VM state StorageClass behavior and review fixes

* DOC-3299: document the VMPersistentState gate for persistent EFI and TPM

---------



(cherry picked from commit 27236f5)

Co-authored-by: Linus Bourque <linus@spectrocloud.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: Ben Radstone <56587332+benradstone@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto-backport Enable backport backport-version-4-10 Backport change to version 4.10 notify-slack Send notification to slack channel of PR ready for review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants