Repository navigation
docs: mark spec.running as deprecated in favor of runStrategy - #1040
Conversation
spec.running has been deprecated since KubeVirt v1.4.0 (kubevirt/kubevirt#12578): the API field documentation says so, and the VirtualMachine validating webhook returns a deprecation warning when a VM that sets it is created or updated. The Run Strategies page still introduces `Running` as the field that controls the VM and does not mention the deprecation. - run_strategies.md: introduce spec.runStrategy first, add a warning that spec.running is deprecated, how it maps to Always/Halted, and the warning text the API server returns. Fix a typo ("ith"). - architecture.md: the example VM was switched to `runStrategy: Halted` in kubevirt#849, but the text around it still talks about spec.running. Update the text, fix `virtctl start vm vm-cirros` (virtctl start takes exactly one argument, the VM name), and show `Run Strategy: Always` in the describe output after the VM is started. Co-Authored-By: Claude Opus 5.5 <[email protected]> Signed-off-by: YoungjuKim <[email protected]>
kubevirt-prow
Bot
added
dco-signoff: yes
|
Hi @fjvbn2003. Thanks for your PR. I'm waiting for a kubevirt member to verify that this patch is reasonable to test. If it is, they should reply with Regular contributors should join the org to skip this step. Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: jean-edouard The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
kubevirt-prow
Bot
added
the
approved
|
/cc @aburdenthehand Hi! This has an /approve from @jean-edouard and only needs an /lgtm to merge. Could you take a look when you have a moment? Thanks! |
|
/lgtm |
spec.runninghas been deprecated since KubeVirt v1.4.0 (kubevirt/kubevirt#12578, listed under "Deprecation" in the v1.4.0 release notes of this guide). The Run Strategies page still introducesRunningas the setting that controls the VM and never says that it is deprecated, so a reader who lands there keeps writingrunning: true.What the API does today (checked on a v1.9.0 cluster):
kubectl explain vm.spec.runningprintsDeprecated: VirtualMachineInstance field "Running" is now deprecated, please use RunStrategy instead.virtualmachine-validator.kubevirt.iowebhook is registered forCREATEandUPDATEofvirtualmachines, and its admitter returns the warningspec.running is deprecated, please use spec.runStrategy instead.wheneverspec.runningis set (vms-admitter.go).Changes:
docs/compute/run_strategies.md: introducespec.runStrategyfirst, then add a warning thatspec.runningis deprecated, how it maps toAlways/Halted, and the warning text the API server returns. Also fixes a typo ("ith").docs/architecture/architecture.md: the example VM was switched torunStrategy: Haltedin Change spec.running refs to runStrategy #849, but the text around it still saysspec.running. This updates that text, fixesvirtctl start vm vm-cirros(virtctl starttakes exactly one argument, the VM name: start.go), and showsRun Strategy: Alwaysin thekubectl describeoutput, becausevirtctl starton aHaltedVM setsrunStrategytoAlways(lifecycle.go).#923 and #927 covered the same deprecation together with an unrelated tolerations change and were closed as stale before review. This PR only covers the deprecation.
This change was drafted with AI assistance and reviewed by me.
🤖 Generated with Claude Code