Skip to content

docs(self-host): use the latest control plane image and fix guide details - #173

Merged
NathanFlurry merged 1 commit into
mainfrom
self-host-sanity
Nov 4, 2026
Merged

NathanFlurry merged 1 commit into
mainfrom
self-host-sanity

Conversation

@NathanFlurry

@NathanFlurry NathanFlurry commented Nov 4, 2026 •

Copy link
Copy Markdown
Member

Sanity check of every self-host guide (control plane and nodes) against the released 3.0.1 engine and RivetKit.

Changes

  • Drop the pinned-version wording from the upgrade, VM, custom platform and checklist pages. The guides run rivetdev/engine:latest, so an upgrade is a pull on every instance, not a tag change.
  • Show the real /health response, including its architecture field and the current version.
  • Docker Compose: drop the verification note, state the disk floor the control plane enforces at startup, note the short window after /health in which API calls return depot.overloaded, and show how to list the connected nodes.
  • Storage: document the exact free-space reserve (10% of the disk, at least 4 GiB) that blocks startup, note that the in-memory backend cannot be combined with storage.log_directory, and soften the replica rebuild time.
  • Kubernetes: show the message kubectl rollout status prints for a new StatefulSet.
  • Nodes: verify a deployment by listing the pool's nodes.
  • Remove the node Metadata reference page: registry.routes.metadata() throws in this release.

Testing

  • Ran the Docker Compose quickstart against rivetdev/engine (3.0.1 at the time) with both the config file and the environment-variable form used by the Railway and Render guides. /health answers, PUT /pools/default returns the documented body, and GET /pools/default/nodes and GET /actors work.
  • Started the hello-world RivetKit 3.0.1 app as a node with RIVET_ENDPOINT=http://default:<token>@localhost:6420, confirmed it appears in the node listing, and called the counter actor through the control plane.
  • Checked every documented config key, port, default, and API shape against the engine source at v3.0.1.
  • pnpm check:sitemap passes and the site builds.

🤖 Generated with Claude Code

@railway-app

railway-app Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

🚅 Deployed to the website-pr-173 environment in rivet-website

Service Status Web Updated
website 🕒 Building (View Logs) Web Nov 4, 2026 at 5:11 am UTC

@railway-app
railway-app Bot temporarily deployed to rivet-website / website-pr-173 November 4, 2026 01:02 Destroyed
@NathanFlurry NathanFlurry changed the title docs(self-host): pin the 3.0.1 control plane image and fix guide details docs(self-host): use the latest control plane image and fix guide details Nov 4, 2026
@railway-app
railway-app Bot temporarily deployed to rivet-website / website-pr-173 November 4, 2026 04:58 Destroyed
@railway-app
railway-app Bot temporarily deployed to rivet-website / website-pr-173 November 4, 2026 05:11 Destroyed
@NathanFlurry
NathanFlurry marked this pull request as ready for review November 4, 2026 05:11
@NathanFlurry
NathanFlurry merged commit 6417f2d into main Nov 4, 2026
1 of 3 checks passed

This branch was successfully deployed

No deployments
rivet-website / website-pr-173 — 161d2cb5 Deployed Nov 4, 2026 by railway-app[bot]
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.

1 participant