Skip to content

docs: an operations guide - #100

Merged
cristiangirlea merged 2 commits into
mainfrom
docs/operations-guide
Oct 26, 2026
Merged

cristiangirlea merged 2 commits into
mainfrom
docs/operations-guide

Conversation

@cristiangirlea

Copy link
Copy Markdown
Owner

Fixes #80.

A single document an operator runs the service from: deployment topologies (a sidecar, a shared worker behind TLS with per-client tokens, N instances behind a balancer with the rule that a job is answered only by the instance that holds it, the published images), sizing from the measured tables (one child against the 1536 MiB limit, the admission ceiling of capacity per retention, the connection budget, the drain deadline, the request limits), state (what a state directory keeps and what a restart reports), token layout and rotation, upgrades with a drain, monitoring (liveness versus readiness, the metrics to graph and alert on, the log schema), a failure-mode table, and the versioning and support policy. Every figure comes from docs/testing.md and every setting from the code.

Files: docs/operations.md (new), README.md (one link), AGENTS.md (the guide listed), CHANGELOG.md.

Checks on this head: the full deterministic sequence passed on the first commit (docs only; the second commit changes prose). Review: independent review by Codex (gpt-6.1-sol) against the code and the measured tables; its eight corrections (retention counted from completion, rotation without a no-refusal promise, model loading at child start rather than first job, the recorded versus computed throughput, unreleased wording, protocol compatibility limited to shared capabilities, graceful drain versus SIGKILL, best-effort logging) are in the second commit. Noted for the release PR: docs/testing.md line 93 still describes the earlier first-job model loading.

@cristiangirlea
cristiangirlea merged commit fdda0ba into main Oct 26, 2026
9 checks passed
@cristiangirlea
cristiangirlea deleted the docs/operations-guide branch October 26, 2026 11:55
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.

docs: an operations guide with topologies, sizing, state, tokens, upgrades, monitoring, failure modes and the support policy

1 participant