Skip to content

Commit 39f9e77

Browse files
committed
Update VM lifecycle and node assignment docs: deprecate spec.running, document tolerations live update
Signed-off-by: Vinay Pepakayala <[email protected]>
1 parent cddff7b commit 39f9e77

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

docs/compute/node_assignment.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -169,10 +169,13 @@ VirtualMachineInstance until the current instance of the VirtualMachineInstance
169169

170170
## Live update
171171

172-
When the [VM rollout strategy](../user_workloads/vm_rollout_strategies.md) is set to `LiveUpdate`, changes to a VM's
173-
node selector or affinities will dynamically propagate to the VMI (unless the `RestartRequired` condition is set).
174-
Changes to tolerations will not dynamically propagate, and will trigger a `RestartRequired` condition if changed on a
175-
running VM.
172+
173+
When the [VM rollout strategy](../user_workloads/vm_rollout_strategies.md) is set to `LiveUpdate`, changes to a VM's node selector, affinities, and tolerations will dynamically propagate to the VMI (unless the `RestartRequired` condition is set).
174+
175+
**Current behavior:**
176+
- Changes to tolerations are now supported for live update and will be applied to the running VMI without requiring a restart, as long as the `RestartRequired` condition is not set.
177+
178+
Modifications of the node selector / affinities / tolerations will only take effect on next [migration](live_migration.md); the change alone will not trigger one.
176179

177180
Modifications of the node selector / affinities will only take effect on next [migration](live_migration.md), the change
178181
alone will not trigger one.

docs/compute/run_strategies.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
# Run Strategies
2+
#
3+
> **⚠️ Deprecation Notice:**
4+
>
5+
> The `spec.running` field is **deprecated** and should no longer be used to control VirtualMachine lifecycle. Use `spec.runStrategy` instead. Defining both `runStrategy` and `running` is **not allowed** and will be rejected by the API server. Always prefer `spec.runStrategy` for new and existing VirtualMachines.
26
37
## Overview
48

@@ -52,6 +56,11 @@ RunStrategies defined:
5256
they can be contradictory. The API server will reject VirtualMachine
5357
resources that define both.
5458

59+
> **Best Practice:**
60+
> - Use `spec.runStrategy` for all new and existing VirtualMachines.
61+
> - Do **not** use `spec.running`—it is deprecated and will be removed in future releases.
62+
> - Defining both fields is invalid and will be rejected.
63+
5564
### Virtctl
5665

5766
The `start`, `stop` and `restart` methods of virtctl will invoke their

0 commit comments

Comments
 (0)