Skip to main content
Version: v5.7.0

opschain admin server site quiesce

Included from Basic tier

Durably drains every server node carrying the named site identity (the site config key / OPSCHAIN_SITE): each matching node leaves readiness (its load balancer routes around it), stops offering jobs, hands its scheduler shards, leadership and membership back, and detaches its in-flight run drives for the other site's peers to adopt. The whole site's servers are then safe to kill and roll together — kill -9 included, every run being resumable from the store.

The site's workload keeps flowing while its servers are down: the site's runners fail over to the next server in their ordered list and park on the surviving site, and that site's servers claim the quiesced site's location-pinned steps on its behalf — placement rules still decide which runners execute them, so nothing runs anywhere it is not allowed to (opschain docs dispatch).

The posture is durable and converges every matching node within seconds — including nodes that were down when the verb ran: a binary of the site booted under the posture comes up HELD (healthy, inspectable, taking no work) until opschain admin server site resume <site>. Quiescing an already-held site is idempotent: the original posture row (and its recorded actor) stands. Each quiesce and resume is audited (info:server:site_quiesced / info:server:site_resumed events carrying the site and the acting principal).

The verb targets the site whose SERVERS carry the identity; it does not touch runners, other sites' servers, or the estate's dispatch posture.

Flags​

FlagMeaning
--server <url>Server base URL (default: the active context / OPSCHAIN_SERVER). Send it through a SURVIVING site's address.
--auth-token <token>Admin bearer token override (default: your opschain login session, then $OPSCHAIN_ADMIN_TOKEN, then the token stored by opschain admin login).

Exit codes​

CodeMeaning
0Site quiesced (or already held).
1Request failed or the token was rejected.
2Usage error — no site, or no server/credential resolvable.

Examples​

opschain admin server site quiesce dc2
opschain admin server site list

See also​

  • opschain docs cli/admin-server-site-resume — the explicit resume.
  • opschain docs cli/admin-server-node-quiesce — one node instead of a site.