rustfs/docs/architecture/decommission-compatibility.md

Decommission Compatibility Scope

Use this when: you change pool decommission or rebalance behavior, its admin API shape, the persisted PoolMeta decommission fields, or how tier free versions move between pools. Source of truth: crates/ecstore/src/core/pools.rs (queue, recovery, cleanup predicates), crates/ecstore/src/services/rebalance/worker.rs (rebalance predicates), rustfs/src/admin/handlers/pools.rs plus the pools/* rows of rustfs/src/admin/route_policy.rs (admin surface), crates/ecstore/src/data_movement/ and crates/ecstore/src/set_disk/ (free-version movement).

Current Contract

RustFS supports queued multi-pool decommission start requests on multi-pool deployments. The admin handler accepts the MinIO-compatible request shape, including comma-separated pool targets. An empty target list is rejected; single-pool deployments reject decommission because there is no destination pool; on multi-pool deployments one or more valid target pools are accepted as a single queued operation.

Request Semantics

POST /v3/pools/decommission with comma-separated pool targets is a queue submission:

• validate all requested pool identifiers before mutating metadata;
• reject duplicate target pools in the same request;
• reject active or queued target pools;
• reject completed decommission targets, because completion means the pool can be removed from the deployment configuration;
• allow failed or canceled targets to be retried;
• persist queued metadata before starting workers;
• start only the local-leader prefix of the queue on the receiving node.

The local-leader-prefix rule keeps the active worker on the leader for the pool being moved while still allowing a request to contain later targets whose leaders are different nodes. Later queued targets are recovered or promoted by the leader that owns that target.

Start, cancel (POST /v3/pools/cancel), and clear (POST /v3/pools/clear) requests may arrive on any cluster node. When the target pool's first endpoint is remote, RustFS forwards the operation over the authenticated internode RPC channel to that endpoint; the receiving node still enforces the local-leader rule before mutating decommission state.

Persisted Metadata Shape

The queue is persisted in pool metadata and decoded with the rest of PoolMeta. Each pool entry can distinguish:

• active: at most one pool currently moving data;
• queued: validated pools waiting for the active entry to finish;
• completed: pools finished successfully;
• failed: pools whose worker reached terminal failure;
• canceled: pools canceled before or during execution.

Legacy metadata without queue fields decodes as a non-queued decommission entry, preserving restart behavior for already deployed clusters.

Serial Scheduling And Recovery

Only one queued entry may own a decommission worker at a time. Startup recovery:

• loads pool metadata before rebalance recovery;
• computes the resumable entries with resumable_decommission_queue_indices (crates/ecstore/src/core/pools.rs): every pool that has decommission state and is not terminal (complete, failed, or canceled). Terminal predecessors are skipped, not treated as barriers, so a queued pool behind a failed or canceled attempt is still resumable (test_resumable_decommission_queue_indices_skip_terminal_predecessors);
• starts workers only for the local-leader prefix of those entries; later queued pools stay out of worker scheduling until promotion while their state remains visible in admin status.

Promotion is persisted before worker execution. If cancellation is already requested immediately after promotion, RustFS persists a canceled terminal state instead of leaving the promoted pool active without a worker.

Cancel Semantics

Cancel separates active and queued behavior:

• canceling the active entry requests worker cancellation and persists terminal metadata;
• canceling a queued entry marks that entry canceled before it becomes active;
• failed or canceled terminal entries can be cleared explicitly (POST /v3/pools/clear) when the operator abandons the decommission attempt;
• peer reload failures during cancel are surfaced in status and logs.

Cancel requests can be accepted on non-leader nodes as remote cancel intent; the leader observes the pending cancel and applies it to the active worker.

Status Response Shape

GET /v3/pools/list and GET /v3/pools/status?pool=... expose per-pool machine-readable decommission state. The status field can report active, running, queued, complete, failed, or canceled.

When decommission metadata is present, decommissionInfo includes:

• queue and terminal flags: queued, complete, failed, canceled;
• progress counters: objectsDecommissioned, objectsDecommissionedFailed, bytesDecommissioned, and bytesDecommissionedFailed;
• current location: bucket, prefix, and object;
• queue/history lists: queuedBuckets and decommissionedBuckets;
• waitingReason: queued for queued entries and waiting_for_worker when metadata exists but no worker has started.

This makes queued pools and stalled metadata visible without requiring operators to inspect pool metadata files directly.

MinIO Divergence Decisions

Behavior that is close to MinIO but not byte-for-byte identical. Changing either decision requires an operator compatibility note and updated characterization tests.

Empty Delete Markers

MinIO decommission documentation states that empty delete markers (delete markers with no successor object versions) are not transitioned to another pool. RustFS follows that behavior for decommission when the bucket has no replication configuration: a lone remaining delete marker is cleanup-only metadata and is skipped. When replication is configured, RustFS keeps the delete marker eligible for movement so delete-marker replication and purge state are not lost.

Rebalance uses the same predicate as decommission (should_skip_decommission_delete_marker in crates/ecstore/src/core/pools.rs, should_skip_rebalance_delete_marker in crates/ecstore/src/services/rebalance/worker.rs), even though MinIO's public documentation calls out the decommission case more explicitly than the rebalance case.

Lifecycle-Expired Versions During Cleanup

MinIO decommission ignores versions already expired by lifecycle rules. RustFS applies the same rule to decommission and rebalance: a source entry is cleanup-complete when moved versions plus safely expired versions equal the total version count (should_cleanup_decommission_source_entry in crates/ecstore/src/core/pools.rs, should_cleanup_rebalance_source_entry in crates/ecstore/src/services/rebalance/worker.rs). Versions retained by object lock or pending replication are not counted as safely expired by the callers, so an entry with such versions is retained. Both predicates accept an entry whose versions are all lifecycle-expired (test_should_cleanup_decommission_source_entry_accepts_versions_only_safely_expired_by_lifecycle, test_should_cleanup_rebalance_source_entry_accepts_versions_only_expired_by_lifecycle).

Tier Free Versions During Decommission

A tier free version is an internal xl.meta record (rustfs_filemeta::FREE_VERSION, flagged XL_FLAG_FREE_VERSION) shaped like a delete marker. It is created by MetaObject::init_free_version when a version whose remote transition completed is deleted locally: the visible version is removed and the record keeps the remote-tier identity (tier, object name, version id, state, destination id) needed for an idempotent remote delete. Free versions are not user-visible versions; num_versions and all listing/GET paths exclude them.

Lifecycle And Consumers

Creation: a local delete that removes a version whose transition status is complete normally appends the record via MetaObject::delete_version → init_free_version (skipped only when skip_tier_free_version is set, as on data-movement copies). User-facing single and batch deletes always retain that historical owner when they actually remove a transitioned source; they do not create a tier journal, probe a fleet capability, or issue a peer mutation RPC. TransitionVersionState::Unknown and incomplete destination identities stay on the same conservative free-version path. Delete-marker creation on an Enabled bucket is unchanged and does not schedule remote deletion.

Recursive prefix/delete-all cannot preserve per-object markers across its physical directory purge, so it requires a v6 recoverable journal for every transitioned visible source plus a durable dispatch manifest for the whole operation. It fails closed before mutation on legacy metadata or on any existing hidden tier free-version under the prefix. Its internal streaming walk discovers logical keys, then exact-loads every key from its authoritative set in every pool, including free versions; the S3 listing merge is never treated as a complete physical-owner inventory. Tier-operation leases stay held from that preflight through journal prepare and physical deletion. Once physical deletion starts, any error is mutation-ambiguous: authorized/dispatched journals remain for recovery to commit owners only after all physical sets prove both the source and the exact free-version identity absent; uncertain owners are retained. If a retry discovers a later transitioned source after the manifest reached DispatchAuthorized, it replays only the manifest's immutable predecessor set, completes that operation, and leaves the newcomer for a successor dispatch. Operators may retry after the legacy free-version worker has durably completed remote and local cleanup. Journal-less internal deletes and older nodes keep their established marker behavior.

Consumption while the record exists: the background recovery loop started by init_background_expiry (spawned by spawn_tier_free_version_recovery_once, enabled by default) scans disks for pending records and re-enqueues them; the usage scanner does the same; the lifecycle worker then deletes the remote tier object idempotently and only afterwards removes the local record. Heal walks include free-version records in metadata healing. Transition planning, replication, restore, GET, listings, and usage aggregation never depend on them.

Decommission Handling

The exact decommission inventory loader (load_file_info_versions_exact via get_all_file_info_versions) keeps free-version records inline in versions. The migration loop handles them before lifecycle expiry and delete-marker shortcuts. It selects a target pool using the free-version-aware lookup, then writes the original free record to every target disk with the normal metadata write quorum. The free-version marker, local version id, transition identity, transition state, and destination id are preserved at the FileInfo/metadata boundary.

The source record is physically removed only after the target write quorum has committed and the source cleanup preflight still matches the exact inventory. If the lifecycle worker has already completed the remote delete and removed the source record before decommission acquires the source lock, decommission records that identity as already consumed and treats the missing source record as safe. If target capacity, metadata validation, lock fencing, or quorum fails, the source record remains and the entry records state = "free_version_retained" with reason tier_free_version_migration_failed; the worker retries the operation on a later pass. A target record with the same version id is accepted only when its free-version identity matches; a conflicting ordinary version or different free record is an overwrite error. This makes retries idempotent and prevents a free record from replacing a user-visible version.

TransitionVersionState::Unknown records are migrated unchanged rather than discarded; the lifecycle worker retains them if remote identity validation cannot make a delete request. Only an authorized recursive prefix/delete-all v6 transaction may use a per-source journal as the sole retry source; ordinary single/batch deletes never take that path, and a journal discovered alongside an older or fallback free-version never authorizes dropping the xl.meta record.

Remote-Tuple Publication Fence

Cross-pool capability v3 adds a commit-late publication contract for every path that can copy an existing transition tuple to a new physical owner. This capability version is independent of the tier-mutation RPC protocol version; a mixed fleet whose minimum cross-pool capability is below v3 cannot authorize journal-v6 remote deletion.

Data movement captures a non-cloneable, process-local source capability before copying, but it does not hold a namespace write lock or tier-operation lease while reading a large body or uploading multipart parts (NewMultipartUpload and UploadPart are staging only). Immediately before single-PUT rename, Multipart Complete, or a pure-remote/free-version metadata quorum write, the final consumer acquires the exact tier generation (when a remote tuple exists), then the fixed/source/target write domains in stable order. The fixed domain is used only for a real remote-tuple decommission publisher; an ordinary local object keeps the lighter source/target commit scope.

While that owned scope is held, the publisher re-reads the exact source pool and compares version, data directory, modification time, ETag, checksums, transition tuple, transition-version state, and destination identity. A missing or changed source, a changed or revoked tier generation, a bucket incarnation change, or a lost lock fails before target rename. The scope stays owned through rename quorum and the rename-tail guard handoff, so recovery-first ordering cannot delete the remote object and then let a stale restored-transitioned rebalance recreate its tuple, and publisher-first ordering makes recovery wait and rescan the newly committed owner.

Full cross-key S3 Copy is not an ownership-sharing operation: it materializes local data and strips transition, destination, transaction, and free-version keys. Same-key metadata/version-only updates preserve the protected state. Admin heal keeps the legacy nolock request field for wire compatibility but ignores it as lock authority; final heal writes enter the normal locked path. Restore likewise ignores ambient ObjectOptions.no_lock, acquires its own commit-late PUT/Complete lock, validates the restore operation id, and keeps an exact tier generation lease through the local commit.

Tier Mutation Protocol And Journal v6 Rollout

Tier edit/remove/clear reference proof uses the internal walk with include_free_versions = true, in addition to persisted journal and transition-transaction checks. Protocol v3 peer Prepare blocks new reference creators and drains existing tier-operation leases before this proof; protocol v4 preserves that state machine and adds a signed failure classification. Abort carries the canonical Prepare intent, so a peer can create an identity-bound Aborted tombstone even when Abort overtakes Prepare; a delayed matching Prepare then converges on Aborted instead of reinstalling the block, and a conflicting intent with the same mutation id fails closed. The tombstone stays durable until intent expiry plus the configured clock-skew allowance, including across reload and coordinator-record cleanup. After expiry, a missing-record replay of the original signed Prepare is rejected and cannot recreate a peer-only runtime fence. Abort checks an existing same-identity terminal record before consulting mutable current-config proof, and recovery reconstructs the original Prepared revision for Abort fanout.

A new server accepts both v3 and v4 requests and selects the matching canonical response proof. During a mixed rollout an older v3 server rejects a v4 request with an authenticated, byte-exact unsupported-version status before dispatch; the v4 coordinator treats only that exact rejection as definitely-not-installed, fails the admin mutation, and does not send the peer an incompatible Abort. There is deliberately no automatic v3 retry: Unimplemented, near-text, timeouts, missing or unknown failure classes, and other ambiguous outcomes still receive Abort and retain the coordinator retry record if Abort cannot be proven. Operators must pause and drain tier edit/remove/clear operations before starting a rolling upgrade, leave them disabled while any v3-only peer remains, and resume only after every topology member advertises the v4-capable release. Ordinary object I/O and free-version cleanup stay available; xl.meta is unchanged by a rejected mutation.

Sole-owner transactions use journal v6: v5-and-older readers reject and retain those records, so an old recovery worker cannot bypass the all-pool proof. Older nodes may keep creating fallback free-versions until the rollout is homogeneous. Do not downgrade every v6-aware recovery worker while any v6 record remains; drain the journal first or keep at least one v6-aware worker until cleanup converges.

Disposition Events

Free versions remain internal, so no S3-visible version or admin response field is added. The structured decommission_entry events are the operational status surface:

Outcome	state	reason
Record migrated to the target pool	free_version_migrated	tier_free_version_migrated
Record consumed by the lifecycle worker before migration	free_version_consumed	tier_free_version_already_consumed
Migration failed, source retained for retry	free_version_retained	tier_free_version_migration_failed

The entry also emits a disposition summary with migrated, consumed, retained, and total counts. The final decommission sweep uses the exact loader, counts free records still present, and emits one retained record/reason per unresolved free version before failing the sweep. The existing decommission item/failed counters still report the enclosing object migration result.

Regression Guards

Test names drift; locate the current guards instead of copying them:

rg -n 'fn [a-z_]*decommission[a-z_]*\(' crates/ecstore/src/core/pools.rs crates/ecstore/src/set_disk/mod.rs crates/ecstore/src/data_movement/mod.rs crates/ecstore/src/store/init.rs rustfs/src/admin/handlers/pools.rs rustfs/src/app/admin_usecase.rs
rg -n 'fn test_should_[a-z_]*rebalance[a-z_]*\(' crates/ecstore/src/services/rebalance/rebalance_unit_tests.rs