docs(deployment): operator runbook (BLEU-836)#17
Open
brunota20 wants to merge 1 commit into
Open
Conversation
New docs/deployment.md aimed at operators (not module authors). Branched from dev/m3-base — independent of the shepherd-sdk stack so reviewers can land it without unblocking #12–#16. Covers: - What an operator runs: nexum-engine + engine.toml + .wasm artefacts + state_dir. - engine.toml reference: every section / field with the invariants ws/wss vs http/https on `[chains.<id>]`, fuel + memory caps on `[engine.limits]`, and a forward note that `[[modules]]` lands with the BLEU-818 supervisor PR (today's flow is positional CLI args). - Building .wasm artefacts: `rustup target add wasm32-wasip2` plus the cargo build command + size sanity check. - Local runs: the canonical `cargo run -p nexum-engine -- <wasm> <module.toml>` invocation + RUST_LOG hints. - Docker: sketched Dockerfile pointing at the proper BLEU-X18 milestone. - Observability: RUST_LOG patterns, /metrics endpoint (forward reference to BLEU-X14), suggested Grafana panels. - Backups: redb WAL guarantees + how the per-module keccak prefix lets partial restores stay clean. - Troubleshooting table mapping the five most common dispatches to their likely cause + fix. - Cross-links to the SDK overview, tutorial (BLEU-848), and ADRs 0001 / 0003 / 0005. No code changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
New `docs/deployment.md` aimed at operators (not module authors). Branched from `dev/m3-base` directly — independent of the shepherd-sdk stack (#12–#16) so reviewers can land it in parallel.
Sections
No code changes. Branches independently from `dev/m3-base`.
Linear: BLEU-836.