Skip to content

docs(container-runner): sync deploy docs with runner source #5557

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
abcxff wants to merge 1 commit into
base: stack/fix-container-runner-read-cgroup-v1-memory-usage-on-gen1-gvisor-qyxytrml
Choose a base branch
from
Open

docs(container-runner): sync deploy docs with runner source #5557

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions website/src/content/docs/deploy/container-runner.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,9 @@ All flags can also be set through environment variables:
| `--actor-name` | `RIVET_ACTOR_NAME` | `game` | Actor name this runner serves. |
| `--runner-version` | `RIVET_RUNNER_VERSION` | `1` | Version reported to the engine, used to drain old runners on deploy. |
| `--base-path` | `RIVET_SERVERLESS_BASE_PATH` | `/api/rivet` | Base path the engine calls for serverless start. |
| `--stop-grace-secs` | `RIVET_STOP_GRACE_SECS` | `25` | `SIGTERM` to `SIGKILL` grace period when stopping the child. Capped to a few seconds when the platform itself is reclaiming the instance, so shutdown fits inside the platform's own kill window. |
| `--stop-grace-secs` | `RIVET_STOP_GRACE_SECS` | `10` | `SIGTERM` to `SIGKILL` grace period when stopping the child. Capped to a fraction of the platform's SIGTERM budget when the platform itself is reclaiming the instance, so shutdown fits inside the platform's own kill window. |
| `--readiness-timeout-secs` | `RIVET_READINESS_TIMEOUT_SECS` | `30` | How long to wait for the child's port to open before failing the start. |
| — | `RIVET_SIGTERM_BUDGET_SECS` | `10` | How long the platform gives the container between `SIGTERM` and `SIGKILL`. The signal-path shutdown splits this budget across the engine drain, the child stop grace, and a straggler sweep, so keep it in sync with the platform's actual kill window. |

### Per-Actor Input

Expand All @@ -89,11 +90,12 @@ The actor's `input` payload can override the launch spec per actor. All fields a
{
"command": ["./GameServer", "-batchmode"],
"args": ["-extra-flag"],
"env": { "MATCH_MODE": "ranked" }
"env": { "MATCH_MODE": "ranked" },
"port": 7770
}
```

`command` replaces the entrypoint command template, `args` are appended to it, and `env` adds environment variables for the child.
`command` replaces the entrypoint command template, `args` are appended to it, `env` adds environment variables for the child, and `port` overrides the child's listen port (exported to the child as `PORT`), falling back to `--child-port` when omitted.

## Source and Examples

Expand Down
Loading