Skip to content

Update VM lifecycle and node assignment docs: deprecate spec.running, document tolerations live update #927

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update VM lifecycle and node assignment docs: deprecate spec.running, document tolerations live update #927

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions docs/compute/node_assignment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,10 +169,13 @@ VirtualMachineInstance until the current instance of the VirtualMachineInstance

## Live update

When the [VM rollout strategy](../user_workloads/vm_rollout_strategies.md) is set to `LiveUpdate`, changes to a VM's
node selector or affinities will dynamically propagate to the VMI (unless the `RestartRequired` condition is set).
Changes to tolerations will not dynamically propagate, and will trigger a `RestartRequired` condition if changed on a
running VM.

Copy link
Contributor

@iholder101 iholder101 Oct 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: redundant newline

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).

**Current behavior:**
Copy link
Contributor

@iholder101 iholder101 Oct 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove this line. Everything in this document tries to explain the current behavior :)

- 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.

Comment on lines +176 to +177
Copy link
Contributor

@iholder101 iholder101 Oct 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can remove this as it's already mentioned above.

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

Modifications of the node selector / affinities will only take effect on next [migration](live_migration.md), the change
alone will not trigger one.
9 changes: 9 additions & 0 deletions docs/compute/run_strategies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Run Strategies
#
> **⚠️ Deprecation Notice:**
>
> 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.
Comment on lines +2 to +5
Copy link
Contributor

@iholder101 iholder101 Oct 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's nice, but IMO it would be better to simply document only run strategies below, then add a small section in the end explaining that there used to be a spec.running field, but that it's not recommended and should be avoided. WDYT?


## Overview

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

> **Best Practice:**
> - Use `spec.runStrategy` for all new and existing VirtualMachines.
> - Do **not** use `spec.running`—it is deprecated and will be removed in future releases.
> - Defining both fields is invalid and will be rejected.

### Virtctl

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