Skip to content

docs(website): tighten container runner intro paragraph#5416

Merged
abcxff merged 1 commit into
mainfrom
stack/docs-website-tighten-container-runner-intro-paragraph-nkroqkku
Jul 15, 2026
Merged

docs(website): tighten container runner intro paragraph#5416
abcxff merged 1 commit into
mainfrom
stack/docs-website-tighten-container-runner-intro-paragraph-nkroqkku

Conversation

@abcxff

@abcxff abcxff commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

No description provided.

@abcxff

abcxff commented Jul 15, 2026

Copy link
Copy Markdown
Contributor Author

Stack for rivet-dev/rivet

Get stack: forklift get 5416
Push local edits: forklift submit
Merge when ready: forklift merge 5416

change nkroqkku

@railway-app
railway-app Bot temporarily deployed to rivet-frontend / rivet-pr-5416 July 15, 2026 21:10 Destroyed
@claude

claude Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Review

Small, low-risk doc tightening. One accuracy concern with the new wording:

Potential inaccuracy: "batch jobs like FFmpeg transcoding"

The new intro says the container runner is for "non-RivetKit workloads such as Unity or Godot dedicated game servers and batch jobs like FFmpeg transcoding." This doesn't match how the runner actually works:

  • container-runner/src/child.rs::wait_until_ready polls the child's TCP port and only reports the actor "ready" once the child accepts a connection, failing (and killing the child) if it doesn't within readiness_timeout_secs (default 30s, per the Configuration table further down this same doc).
  • actor.rs explicitly documents this as "readiness (so the actor is never reported ready before the child listens)."
  • The whole model (see "How It Works" section below) is built around proxying gateway HTTP/WebSocket traffic to a listening child server, not running a one-shot CLI process to completion.

A typical ffmpeg invocation doesn't bind an HTTP port, so as described it would hit the readiness timeout and fail to start rather than running as a "batch job." Unless there's a documented pattern for wrapping one-shot processes with a stub HTTP listener (not covered anywhere in this doc or the README), the FFmpeg example contradicts the rest of the page and could mislead readers into attempting an unsupported use case.

Suggest either dropping the FFmpeg/batch-job example or, if one-shot batch workloads are actually supported (e.g. via some wrapper pattern), briefly noting how readiness works for that case.

Everything else

  • The details trimmed from the intro (child-process-per-actor, gateway proxying, request-concurrency-per-container) are still covered in "How It Works" and "Deploy" below, so no information is lost.
  • No code, tests, or other docs are touched — scope is appropriately minimal for a copy tightening PR.

@railway-app

railway-app Bot commented Jul 15, 2026

Copy link
Copy Markdown

🚅 Deployed to the rivet-pr-5416 environment in rivet-frontend

Service Status Web Updated (UTC)
website 😴 Sleeping (View Logs) Web Jul 15, 2026 at 9:23 pm
frontend-cloud 😴 Sleeping (View Logs) Web Jul 15, 2026 at 9:18 pm
kitchen-sink 😴 Sleeping (View Logs) Web Jul 15, 2026 at 9:18 pm
frontend-inspector 😴 Sleeping (View Logs) Web Jul 15, 2026 at 9:16 pm
ladle ✅ Success (View Logs) Web Jul 15, 2026 at 9:12 pm
mcp-hub ✅ Success (View Logs) Web Jul 15, 2026 at 9:11 pm

@abcxff
abcxff merged commit 77b0c94 into main Jul 15, 2026
14 of 17 checks passed
@abcxff
abcxff deleted the stack/docs-website-tighten-container-runner-intro-paragraph-nkroqkku branch July 15, 2026 22:38
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