Files
rustfs/docs/operations/replication-check.md
T
唐小鸭 ee73203791 fix(admin): probe replication-check mutations by the assigned version id
On a target that mints its own version ids the DeleteMarker and
VersionDelete phases of ?replication-check were skipped: they addressed
the source id, which such a target never had. The replication worker now
addresses the id the target assigned (the target-version ledger), and
the probe already holds that id from its own PUT, so run both phases
against it. VersionFidelity keeps failing with the mismatch code and the
target stays FAILED; the phases report whether ledger-addressed purges
work against this endpoint (rustfs/backlog#2340).
2026-09-07 16:08:55 +08:00

4.3 KiB

Replication target check

Use this when: you are about to call, automate, or debug GET /BUCKET?replication-check, or need to explain why a GET wrote and deleted objects on a replication target.

Source of truth: rustfs/src/admin/router.rs (REPLICATION_CHECK_PROBE_PREFIX, REPLICATION_CHECK_ERROR_MAX_BYTES, the replication-check route handler).

GET /BUCKET?replication-check is a signed S3 extension that validates every replication target referenced by a bucket replication configuration.

Active mutation warning

Despite using GET, this operation is not read-only. On each target it:

  1. writes an 8-byte object under .rustfs.sys/replication-check/<uuid>/<uuid> (REPLICATION_CHECK_PROBE_PREFIX);
  2. creates a replicated delete marker;
  3. permanently deletes the probe object version; and
  4. enumerates that exact probe key and attempts to delete every remaining object version and delete marker.

Obtain operator confirmation before sending the request. Probe keys use a reserved namespace and two independent random UUIDs. Before writing, the server verifies that no version or delete marker exists at the exact key, then uses an atomic If-None-Match: * write so it cannot overwrite a key created concurrently by an application.

Response contract

The route returns HTTP 200 with JSON after all configured targets have been checked. Status is FAILED when any target or cleanup phase failed; successful target results remain present when another target fails.

{
  "Status": "FAILED",
  "ActiveMutation": true,
  "MutationDescription": "Writes a probe object, creates a delete marker, deletes the probe version, and cleans up all probe artifacts on each target.",
  "ProbeNamespace": ".rustfs.sys/replication-check/",
  "Targets": [
    {
      "Arn": "arn:minio:replication::target",
      "Bucket": "replica",
      "Status": "FAILED",
      "Error": "probe cleanup failed: target delete object version check failed: AccessDenied",
      "Phases": {
        "Bucket": { "Status": "OK" },
        "Versioning": { "Status": "OK" },
        "ObjectLock": { "Status": "OK" },
        "Put": { "Status": "OK" },
        "VersionFidelity": { "Status": "OK" },
        "DeleteMarker": { "Status": "OK" },
        "VersionDelete": { "Status": "OK" },
        "Cleanup": {
          "Status": "FAILED",
          "Error": "target delete object version check failed: AccessDenied"
        }
      }
    }
  ]
}
Field Contract
Phases.*.Status OK, FAILED, or SKIPPED.
Error Single line, bounded to REPLICATION_CHECK_ERROR_MAX_BYTES (512 bytes); omits remote messages, endpoints, credentials, signatures, and authorization material.
Cleanup A cleanup failure is always explicit; it is never reported as a successful check.
Code Appears only on failures callers are expected to branch on (currently BucketRemoteTargetVersionMismatch). Go decoders ignore the unknown key.

VersionFidelity phase

VersionFidelity pins the version-identity contract on both write paths. The probe PUT carries a source version id (header plus ?versionId= query, the exact shape live replication uses) and the target must answer with the same id; a second probe repeats the check through CreateMultipartUpload -> UploadPart -> CompleteMultipartUpload, where the target fixes the version at initiate and only reports it on completion. A target can adopt PutObject ids and still mint its own for multipart; the failure message names the path that drifted.

A target that mints its own version ids never answers to the source version id. The phase therefore fails with "Code": "BucketRemoteTargetVersionMismatch" and the target result is FAILED. Replication to such a target still converges: the replication worker records the id the target assigned to each object version on the source (the target-version ledger, internal metadata key replication-target-version-<arn>) and addresses version deletes, tag and Object Lock updates through it. The DeleteMarker and VersionDelete phases probe exactly that path — they address the id the target assigned to the probe object, not the source id — so on a drifting target they report whether ledger-addressed purges work against this endpoint, and cleanup removes the probe via the same id. They are SKIPPED only when the probe Put itself failed or reported no version id.