Skip to content

docs: add Docker Swarm with the SwarmCLI chart to the README quickstart - #1

Closed
eldara-cruncher wants to merge 5 commits into
mainfrom
docs/readme-swarmcli-chart
Closed

eldara-cruncher wants to merge 5 commits into
mainfrom
docs/readme-swarmcli-chart

Conversation

@eldara-cruncher

@eldara-cruncher eldara-cruncher commented Oct 15, 2026 •

Copy link
Copy Markdown
Collaborator

Note: @mosonyi this is a draft PR into our fork for review. It links to the SwarmCLI chart guide from Eldara-Tech/docs.rustfs.com#1, so its base changes to upstream once that guide is live on docs.rustfs.com.

Related Issues

N/A

Summary of Changes

Adds a seventh option to the README quickstart, Docker Swarm with the SwarmCLI chart, in README.md and README_ZH.md. Like the Helm option, it points elsewhere rather than walking through the install. It links to the SwarmCLI chart guide on docs.rustfs.com (/en/ and /zh/, under Installation → Cloud Native) and to the open-source rustfs chart, which runs a single-node RustFS service. One sentence names what a reader gets from it: root credentials in Docker secrets with the default rustfsadmin keys refused, upgrades and rollbacks as versioned releases, and HTTPS through Traefik. It also says the chart's Console is off until enabled, because the generic "Accessing RustFS" section right below promises a Console on port 9001 with rustfsadmin credentials.

Disclosure: I'm involved with Eldara Tech, which maintains the chart and SwarmCLI. The new section says that both are maintained outside the RustFS project.

Verification

Tested commit: 8e42527, no local changes.

  • git diff --check: clean.
  • scripts/check_no_planning_docs.sh: passes.
  • Links: the chart and SwarmCLI links return 200. Both docs.rustfs.com links return 404 until the guide from docs.rustfs.com#1 is published.
  • Not run: Cargo formatting, builds and tests, which AGENTS.md skips for documentation-only changes.

Impact

Documentation only: README.md and README_ZH.md.

Additional Notes

The Option 5 and 6 headings in README_ZH.md use "(Option N)" rather than "(选项 N)", so Option 7 does too.

🤖 Generated with Claude Code

https://claude.ai/code/session_0187R25x4FVEZ8ox9wwLu3WV

Option 7 links to the Docker Swarm guide on docs.rustfs.com and to the
community rustfs chart, noting that Eldara Tech maintains both.
The docs guide moved from Container to Cloud Native as SwarmCLI Chart.
Secrets, versioned upgrades and rollbacks, Traefik HTTPS; and that its
Console is off and rustfsadmin refused, unlike Accessing RustFS below.
…ADME

It is maintained by Eldara Tech, which 'community' contradicted.
The chart guide now covers distributed, erasure-coded clusters as well
as a single-node service, so Option 7 no longer says single-node only.
@clangenb
clangenb force-pushed the docs/readme-swarmcli-chart branch 2 times, most recently from 9896871 to 4b3be74 Compare November 13, 2026 12:43
@clangenb clangenb closed this Nov 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants