Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
55 changes: 55 additions & 0 deletions docs/valkey/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Valkey Operations Handbook

Operational reference for Agent Substrate's persistence tier — the Valkey
cluster that stores actor and worker state, plus the in-process worker
cache that sits in front of it inside `ate-api-server`.

This handbook is for operators, on-call engineers, and contributors who
need to reason about the storage tier without first reading the code. It
is intentionally narrow: it covers what's deployed, how state moves
through it, and what to do when it breaks. It does not retell Valkey's
own documentation.

## Pages

- [`topology.md`](./topology.md) — what's deployed, how the pieces
fit together, and identity / TLS wiring.
- [`lifecycle.md`](./lifecycle.md) — the actor state machine
(including the CRASHED parking state), the lifecycle workflows
(Create, Resume, Suspend, Pause, Delete), the worker-cache
subscription model, and the per-worker scheduling eligibility
rules.
- [`operations.md`](./operations.md) — failure modes with inline
recovery for each, common admin operations (including coordinated
maintenance failovers and backup/restore), and the short list of
open operational risks.
- [`scaling_to_10m.md`](./scaling_to_10m.md) — the growth path from
a 10-actor pilot to the supported envelope of 10 million actors:
tiered requirements with graduation triggers, capacity math, the
durability contract, and the deployed-today vs. target
configuration ladder.

## Conventions

- Source citations use **path + symbol name** (e.g.
`cmd/ateapi/internal/store/store.go` (`Interface`)), never line
numbers. Line numbers drift on every refactor; symbol references
survive.
- Code examples assume `valkey-cli` is invoked with the full TLS flag
set; for brevity the pages use a `vcli` alias defined in
[`operations.md`](./operations.md).
- Diagrams are mermaid blocks; GitHub renders them inline.

## Updating

Update the handbook whenever you learn something new about how the
storage tier behaves — new failure modes, recovery steps that worked
(or didn't) during a real incident, configuration changes, surprising
behavior from upgrades. A handbook that captures the *why* of a past
decision is more valuable than one that perfectly describes the
current code, because the code is already self-describing.

Substantive changes belong in their own PR rather than folded into a
feature change, so the doc review gets focused attention. Trivial
touch-ups (renamed flag, updated path) can ride with the code change
that prompted them.
Loading
Loading