Skip to navigation

Operator Status, State, Stage, and Condition Definitions

View as Markdown

This document provides concise definitions for the status, state, stage, and condition concepts used throughout the NodeWright operator to track package operations and node lifecycle management.

Key Relationships

  • Status reflects the overall health and progress of nodes and the NodeWright resource

  • State tracks the execution status of individual package operations

  • Stage defines the specific lifecycle phase a package is currently in

  • A node’s Status is derived from the collective States of its packages

  • Stages progress sequentially, with State indicating success/failure at each stage

  • All stages except for interrupts include validation checks that must succeed for progression

Usage in Operations

  • Monitoring: Use Status for high-level health checks and dashboards
  • Debugging: Examine State and Stage for detailed package-level troubleshooting
  • Automation: State transitions trigger the next appropriate Stage in the lifecycle
  • Scheduling: Status values like blocked and paused control operation scheduling and dependencies

Status

Scope: Applied to the overall NodeWright resource and individual nodes
Purpose: High-level operational status indicating the current condition

StatusDefinition
completeAll operations have finished successfully
blockedOperations are prevented from proceeding due to taint toleration issues or the nodewright.nvidia.com/ignore label. A node blocked this way reports blocked even while ordering would otherwise hold it at waiting, and returns to waiting once the taint or label is removed
waitingQueued for execution but not yet started
disabledExecution is disabled but will continue for other NodeWrights
pausedExecution is paused for this and all other NodeWrights supposed to be executed after this one
in_progressCurrently executing operations
erroringA stage failed, because its Job ran out of retries or timed out, or a drain timed out. An attempt that fails and is still being retried shows only on the package’s State (below), so a package whose retry succeeds never marks the node erroring. A failing interrupt’s node reads in_progress until the interrupt fails again with its container’s restart count at JOB_BACKOFF_LIMIT, or, for a reboot, whose restarts are never counted, until its Job’s deadline; see A failing interrupt
unknownStatus cannot be determined or is uninitialized

Conditions

NodeWright publishes Kubernetes conditions on .status.conditions. The Ready condition is the standard user-facing summary for kubectl wait --for=condition=Ready, while other condition types report specific operator states that can coexist with Ready.

Ready Condition

Ready is a boolean projection of the NodeWright’s multivalued .status.status field:

.status.statusReady.statusReady.reasonMeaning
completeTrueNodesConvergedAll targeted nodes have completed successfully
in_progressFalseProgressingWork is actively running on at least one node
blockedFalseBlockedProgress is blocked, such as by taint toleration or ignored nodes
erroringFalseErroringOne or more nodes are failing
pausedFalsePausedProcessing is paused by annotation
waitingFalseWaitingNodes are waiting for ordering or batch admission
disabledFalseDisabledProcessing is disabled by annotation
unknownFalseUnknownThe operator cannot yet determine a stable state

.status.status remains the canonical rollout summary used by the operator’s scheduling and state machine. Ready exists to expose that state in Kubernetes condition form for standard tooling, while .status.nodeStatus remains the authoritative per-node source of truth.

Ready Condition Message

The Ready.message field summarizes node progress by status:

  • It always starts with <complete>/<total> nodes complete.
  • It appends one segment for each non-empty node-status bucket, such as <count> in progress, <count> blocked, or <count> erroring.
  • When a bucket has a short node list, the node names are included in sorted order: 2 blocked (node-a, node-b).
  • When a bucket exceeds the message cap, the node names are dropped and the segment becomes (list truncated; see controller logs).

Example for a small rollout:

1/3 nodes complete (node-a), 1 in progress (node-b), 1 blocked (node-c)

Example for a large rollout:

0/800 nodes complete, 800 in progress (list truncated; see controller logs)

The truncation cap exists to keep condition payloads bounded for etcd object size and watch bandwidth. When truncation happens, the controller logs the full per-status node lists at Info, and .status.nodeStatus still contains the complete per-node view.

Other Condition Types

The operator also sets additional condition types that may be useful for troubleshooting:

  • Blocked: rollout progress is blocked on one or more nodes. Reasons include:
    • NonInterruptPodsRunning: node drain is held because pods matching spec.podNonInterruptLabels are still running or pending on selected nodes. A held node keeps its slot in the compartment’s current batch, and can read waiting or in_progress depending on what has already run on it (see interrupt-flow.md)
    • DependencyUninstalled: a package that still has work to do depends on a package that is being or has been uninstalled. A dependent that is itself being uninstalled, by uninstall.apply or by the NodeWright’s deletion with uninstall.enabled, is not reported
  • TaintNotTolerable: selected nodes are skipped because their taints are not tolerated by the NodeWright
  • NodesIgnored: selected nodes are skipped because they have the ignore label set
  • ApplyPackage: the controller is applying a package to a node
  • DeploymentPolicyNotFound: the referenced DeploymentPolicy is missing at reconcile time
  • ImagePullFailed: one or more package pods have been unable to pull their image (ErrImagePull/ImagePullBackOff) for more than 2 minutes, measured from the pod’s creation, from the last init container that finished, or from the end of the container’s previous run when it restarts and pulls again. The message names the nodes (past 10 the list is logged by the controller instead) and the package and container of the first node’s failing pod, the lowest package name when several fail; the kubelet’s pull error is in the Warning event emitted when the condition first appears, since it changes on every retry. The kubelet keeps retrying the pull, so this is deliberately not a package State or node Status: a package or node reads in_progress throughout, and the condition clears by itself once no pod is waiting on a failed pull. If the pull never recovers, the stage’s deadline (stageTimeout) fails it and marks the node erroring. With stageTimeout: 0, or no stageTimeout and JOB_STAGE_TIMEOUT set to 0, there is no deadline: the node stays in_progress and this condition is the only signal
  • DrainBlocked: one or more selected nodes have a drain that cannot currently make progress. Reasons: PodDisruptionBudget, UnmanagedPod, EmptyDirData, or MultipleCauses when more than one kind of blocker is present. Independent of Blocked — a NodeWright can be both dependency-blocked and drain-blocked at once.

These conditions complement, rather than replace, .status.status and Ready.

Legacy Prefixed Condition Types

Canonical condition types are now the bare names above, such as Ready and TaintNotTolerable. During the one-release deprecation window, the operator also mirrors them to the legacy prefixed condition types for backward compatibility:

  • Ready continues to be emitted as nodewright.nvidia.com/Ready
  • the rollout-transition summary also remains available as nodewright.nvidia.com/Transition
  • other bare condition types continue to be mirrored as nodewright.nvidia.com/<Type>

New consumers should read the canonical bare condition types now. Existing consumers of the prefixed condition types should migrate during the deprecation window.

State

Scope: Applied to individual packages within a node
Purpose: Current execution state of a specific package operation

StateDefinition
completePackage operation has finished successfully
in_progressPackage is actively running (pod has started)
skippedPackage/stage was intentionally bypassed in the lifecycle
erroringPackage operation is experiencing failures. While the stage still has retries left this is in-flight evidence and clears on its own if an attempt succeeds; once the retry budget (JOB_BACKOFF_LIMIT) is spent the stage is timed out here and will not retry until a package rerun/reset, a change to what the stage’s Job runs (the package’s version, image, containerSHA, agentImageOverride, env or resources, but for an interrupt only version or agentImageOverride), or a config change while the package is erroring at config, interrupt or post-interrupt, or the failed Job’s TTL expiry. An interrupt stage’s budget is its container’s restart count, which also counts restarts that were not failures, and a reboot interrupt has none, so it times out only at its Job’s deadline; see A failing interrupt
unknownPackage state cannot be determined or is uninitialized

Stage

Scope: Applied to individual packages
Purpose: Indicates which phase of the package installation/management process is currently executing

StageDefinition
uninstall & uninstall-checkRemoval of the package
uninstall-interruptExecution of the package’s interrupt after its uninstall, for a package with an interrupt
upgrade & upgrade-checkPackage version update operations
apply & apply-checkInitial installation/deployment of the package
config & config-checkConfiguration and setup operations
interruptExecution of interrupt operations (e.g., reboots, service restarts)
post-interrupt & post-interrupt-checkOperations that run after interrupt completion

NOTE: All stages except for interrupts include validation checks that must succeed for progression

Stage Flow

The typical stage progression depends on whether the package has interrupts:

Without Interrupts:

apply → config
upgrade → config
uninstall

With Interrupts:

When a package requires an interrupt, the node is first cordoned and drained before package operations begin:

cordon → wait → drain → apply → config → interrupt → post-interrupt
cordon → wait → drain → upgrade (if upgrading) → config → interrupt → post-interrupt
cordon → wait → drain → uninstall → uninstall-interrupt

Note: The cordon, wait, and drain phases ensure that workloads are safely removed from the node before any package operations that require interrupts (such as reboots or kernel module changes) are executed.

NodeWright Status Fields

The NodeWright resource’s .status object includes fields that track batch rollout state. Two fields are particularly relevant for batch stickiness and node ordering:

FieldDefinition
NodePriorityTracks which nodes are in the current active batch. A node stays in NodePriority from the time it is selected for a batch until it completes all packages. Ignored nodes and nodes with untolerated taints keep their entries for resumption but are excluded from selection. Eligible batch members finish before new nodes are selected.
NodeOrderOffsetCumulative count of nodes removed from NodePriority. Combined with a node’s position in the sorted NodePriority map, this produces the monotonic SKYHOOK_NODE_ORDER value injected into package pods.

Both fields are persisted in the CRD and survive controller restarts. They are cleared by kubectl nodewright reset; kubectl nodewright deployment-policy reset keeps them.