rustfs/docs

Documentation

Use the focused indexes rather than treating this directory as an unordered collection:

• Architecture knowledge base
• Testing references

Operations

• Candidate release pipeline: frozen inputs, staged acceptance, immutable publication and recovery.

• Sampled local batch CPU diagnostics — default-off request-correlated allocation and worker wall/CPU diagnosis.

• Retained MRF responsibilities — unknown bucket identities, bounded probes, and unreadable checkpoint recovery.

• Read-only BTF declaration inspection — bounded prototypes and scalar member layouts, explicit void handling, and independent native references.

• Internode HTTP streaming transport — protocol selection, pooled connection isolation, and distributed read validation.

• Persisted config compatibility — ignored MinIO settings, bounded diagnostics, alias retention, and safe resets.

• Table maintenance periodic queueing — opt-in scheduling, limits, worker handoff, and recovery.

• S3 Tables catalog lifecycle — disablement, fenced empty-table cleanup, and registration-cache boundaries.

For PUT cleanup admission, blocking-pool isolation, and optional CPU affinity, see PUT cleanup isolation.

• External certificate issuance and TLS rotation — publication, native reload, trust separation and failure handling.

• Architecture guard troubleshooting — diagnose repository guard failures.

• Logging governance — broad event audits, migrations, and guardrail changes.

• Multipart upload memory diagnosis — allocator attribution, Docker reproduction and sustained upload checks.

For the logical per-operation io_uring read cap, see io_uring read chunk size.

For bounded local read-backend startup and cancellation, see io_uring backend initialization.

For legacy protection assessment and bounded protected copies, see Object integrity inventory, audit, and migration.

For encrypted listing compatibility and older stored fingerprints, see Encrypted object ETags.

For durable hard quota accounting, node-outage behavior, and fence protocol upgrades, see Durable hard quotas.

Operational runbooks live under operations/. Replication operators should start with:

Runbook	Use it for
Site replication operations	Health fields, pending operations, outage recovery, re-pair admission, IAM/SSE boundaries, and upgrades.
Replication target check	Validating an S3 destination and version fidelity before enabling replication.
Replication object size limits	Multipart routing, large-object limits, and retry characteristics.
Replication outbound transport	Integrity headers, generic target behavior, and transport knobs.

For the erasure-coded cluster lifecycle (planning, parity and EC:0, expansion, rebalance, decommission, heal, drive replacement, restart recovery, and the rc CLI mapping), start with Cluster and erasure-coding lifecycle operations.

For concurrent bucket creation and deletion, see Bucket operation admission.

For persisted administrator bucket tasks and bucket recreation, see Bucket heal recovery.

For interrupted object deletions and returning drives, see Delete transaction recovery.

For disk replacement across VM restarts and schema 5/6 maintenance migration, see Replacement generation recovery.

For historical GET timeouts during PUT or Heal, see Object lock contention diagnostics.

Other runbooks remain grouped by filename in operations/; architecture pages link to the relevant runbook where a cross-boundary procedure is required.

For storage dashboards, see Storage metrics and observer selection: drive ownership, snapshot freshness, counter queries, and rolling upgrades.

For per-bucket capacity and object counts, see Bucket usage metrics: OTLP export, cluster deduplication, accounting semantics, and scanner freshness.

For optional shard commitments, see Independent shard integrity rollout: activation, legacy repair results, multipart mode changes, and rollback limits.

For crates.io publication of workspace crates, see Workspace Cargo Publish: dependency ordering, dry-run, publish, and failure handling.