Documentation

Availability

Start with Availability modes to configure none or dc. The binary also accepts ha, but the current release has no network layout that reaches both its public peer routes and private Raft routes through the one address each roster member carries. Treat HA procedures as design material until that peer plane has one deployable endpoint model.

Release status

OperationStatus in this releaseScope or deployment gap
Local operation with mode = "none"ShippedNo distributed routes, listener, workers, or ownership state
Primary-to-replica metadata and blob replicationShippeddc uses the public server named by each member address
Same-datacenter placement receiptsShipped with limitsResponses do not bind the serving node; object stores use node receipts; filesystem parent-directory sync failures are ignored
Replica heartbeat, liveness, and group readinessShippedThese report the static DC roster; they do not elect or promote a writer
Derived-view read frontierShippedReplica page application advances the registered view frontiers before reads pass them
Filesystem copy, placement reconciliation, and reclamationHA components shipTheir jobs require a nonzero ownership term; DC supplies zero and HA has no supported peer layout
Public topology, placement, operation, analytics, health, and readiness viewsShippedThe generated OpenAPI document lists public distributed operations
Private listener statusShippeddc can expose status; ha requires the listener for Raft
Private listener commands and transfers in dcUnavailable by designDC runs no ownership consensus, so mutations return 503 Service Unavailable
Voting membership, home assignment, and planned transferHA components shipThe handlers and consensus code exist, but the split peer planes prevent a supported multi-node HA deployment
Automatic failed-home selection and transferDesignNo runtime worker calls the failover policy or submits the transfer after liveness marks a member dead
PyPI ingress records and local publicationShippedUploads publish at the local or assigned HA home; no transport sends an admitted intent from another datacenter to that home
PyPI write acknowledgementsShipped with limitsThe request path checks DC receipts; the crash-recovery finalizer can record published from local placement without calling the acknowledgement resolver
OCI write acknowledgementsNot integratedOCI mutation paths do not call the distributed acknowledgement resolver
Visibility projection replicationDesignThe minter, envelope, projection, and snapshot types have no production caller
Version negotiation and rollout preflightDesignThe policy functions have no startup, command, or HTTP integration

Private control and peer-replication routes do not appear in peryx openapi or /api-docs/openapi.json; those schemas describe the public server. Each page below labels a procedure that depends on design-only wiring.

On this page