mirror of https://github.com/rustfs/rustfs.git synced 2026-09-23 11:03:26 +00:00

Files

T

マルコメ 42dd76d3b2 ci(docker): sync the Docker Hub overview from README.md on release (#8034 )

Docker Hub's overview is a separate `full_description` field that
`docker push` never touches, so it had drifted into an 8 KB snapshot of
an old README.md that still linked to
https://docs.rustfs.com/introduction.html (now 404).

Add a `sync-dockerhub-description` job to docker.yml that runs after the
images are pushed and republishes README.md from the same commit via
peter-evans/dockerhub-description (pinned to v5.0.0). It reuses the
existing DOCKERHUB_USERNAME / DOCKERHUB_TOKEN credentials, so no new
secrets are needed. Relative links (docs/, CONTRIBUTING.md) are
rewritten to github.com URLs so they resolve on Docker Hub.

Docker Hub caps the field at 25,000 bytes and the action truncates to
fit with only a warning; README.md is at 22,879 bytes today. Read the
published overview back after the sync and fail the job if it hit the
cap, so a truncated overview cannot be published silently.

Fixes #7995

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
Co-authored-by: Hauser <housemecn@gmail.com>

2026-09-21 07:04:47 +08:00

architecture

docs(operations): add cluster and erasure-coding lifecycle runbook (#7998 )

2026-09-18 12:50:14 +08:00

operations

fix(tier): gate opaque version recovery cleanup (#8006 )

2026-09-18 21:54:03 +08:00

postmortems

fix(replication): send an integrity header on Object Lock PUTs (#7097 )

2026-09-03 20:26:44 +08:00

testing

ci(docker): sync the Docker Hub overview from README.md on release (#8034 )

2026-09-21 07:04:47 +08:00

README.md

docs(operations): add cluster and erasure-coding lifecycle runbook (#7998 )

2026-09-18 12:50:14 +08:00

README.md

Documentation

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

Operations

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 persisted administrator bucket tasks and bucket recreation, see Bucket heal 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 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.