Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Pausing Work

A pause stops new claims. It does not stop in-flight jobs. These jobs can complete while the queue is paused.

ScopeFunctionEffect
QueuesetQueuePausedEvery pool stops claiming from that queue.
PoolsetWorkerPausedOne pool stops claiming. Other pools continue.
JobsuspendJob, resumeJobOne job stays invisible until it is resumed.
SubtreepauseChildren, resumeChildrenEvery claimable job below a job, at any depth.

pauseChildren does not suspend in-flight jobs or jobs that have a delay or backoff. resumeChildren keeps a finalizer suspended if its children are still queued. Arbiter resumes the finalizer after its children finish.

LISTEN/NOTIFY sends a pause notification to running pools. Without a listener, each pool reads the pause state at its next worker heartbeat. This can take one workerHeartbeatInterval. See Wakeups.

The REST API and admin UI provide the same controls. An operator can pause work without a deployment.