Skip to content

docs(validator): compute-requirements table + turnkey install with auto-update#38

Merged
echobt merged 1 commit into
mainfrom
mission/compute-plane
Jul 7, 2026
Merged

docs(validator): compute-requirements table + turnkey install with auto-update#38
echobt merged 1 commit into
mainfrom
mission/compute-plane

Conversation

@echobt

@echobt echobt commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Follow-up docs work on mission/compute-plane after PR #37 was merged to main
(branch fast-forwarded to origin/main 9965a601). Updates the validator guide
docs/validator/README.md to (1) add an authoritative Compute Requirements
table and (2) document the existing turnkey installer as the automatic
one-command install with auto-update.

Compute Requirements table

Validator profile Compute
Submit-only / simple validator (no challenge execution) 2 vCPU, 4 GB RAM
Validator running the base (agent-challenge) evaluation 8 vCPU, 32 GB RAM
PRISM challenge No additional compute required

PRISM adds no compute because heavy GPU evaluation is delegated to
miner-funded worker agents
(the worker plane); the validator only does light
verification + probabilistic replay audits. The existing
"What are the minimum requirements?" FAQ now points at this authoritative table
instead of contradicting it.

Automatic install + auto-update

Documents deploy/swarm/install-swarm.sh (not reinvented):

  • dry-run by default; --apply executes; every destructive step behind its
    own flag; installs Docker (ensure_docker), uv (ensure_uv), and Swarm on
    a blank host.
  • --validator-node brings up base validator agent as an auto-updatable
    base-validator-agent Swarm service plus a node-local base-supervisor whose
    image-updater digest-pins it on every new base-validator-runtime:latest
    digest (this is the auto-update).
  • --install-supervisor enables the base-supervisor.service systemd unit
    (image-updater 60s; optional self-update via
    SUPERVISOR_SELF_UPDATE_MANIFEST_URL).
  • concrete dry-run-then---apply quick-start with required env
    (VALIDATOR_MASTER_URL, VALIDATOR_BROKER_TOKEN, wallet hotkey) and how
    VALIDATOR_CAPABILITIES selects agent-challenge (cpu) vs delegated PRISM.

Auto-update is described via the base-supervisor image-updater only (no
watchtower introduced as a current capability in the guide prose).

Verification

  • bash deploy/swarm/install-swarm.sh --help — flags/env listed.
  • Non-destructive --validator-node dry-run (docker stub reporting an
    inactive swarm; no --apply, nothing installed): renders the node-local
    supervisor config (validator_agent_target_enabled: true, watching
    base-validator-runtime:latest) and the docker service create base-validator-agent ... plan matching the docs.
  • Full base gate green: ruff check, ruff format --check, mypy src tests
    clean; pytest --cov=base --cov-fail-under=80 → 1737 passed, coverage 89.03%.
    Doc-consistency tests referencing the validator guide pass
    (test_validator_install_docs.py, test_config_template_security.py,
    test_docker_compose_deploy.py).

Draft (do not reuse merged #37).

Summary by CodeRabbit

  • Documentation
    • Updated the validator guide to reflect a Docker Swarm setup and clarify that Kubernetes is not part of the workflow.
    • Added clearer compute sizing guidance for submit-only and base evaluation setups, including capacity recommendations.
    • Expanded the one-command install instructions with a safer dry-run flow and optional apply step.
    • Documented automatic runtime updates and an optional self-update setting.
    • Added a quick-start path for validator-node setup, including required environment variables and capability selection guidance.

…h auto-update

Add an authoritative Compute Requirements table to the validator guide
(submit-only 2 vCPU/4 GB; base agent-challenge 8 vCPU/32 GB; PRISM needs no
extra compute because GPU eval is delegated to the miner-funded worker plane)
and reconcile the minimum-requirements FAQ to point at it.

Document deploy/swarm/install-swarm.sh as the automatic one-command install:
dry-run by default (--apply executes), --validator-node brings up an
auto-updatable base-validator-agent Swarm service plus a node-local
base-supervisor image-updater (the auto-update), --install-supervisor enables
the systemd control-plane unit. Include a dry-run-then-apply quick-start with
required env and VALIDATOR_CAPABILITIES cpu vs delegated-PRISM selection.
@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 0c605cf3-c883-427a-9c7d-c283ee72e75b

📥 Commits

Reviewing files that changed from the base of the PR and between 9965a60 and 2f7361f.

📒 Files selected for processing (1)
  • docs/validator/README.md

📝 Walkthrough

Walkthrough

Updates the validator README to describe a Docker Swarm-based validator guide, adding compute sizing guidance, a dry-run-by-default automatic install flow with auto-update mechanism, a validator-node quick start section, and revised minimum requirements wording.

Changes

Validator documentation update

Layer / File(s) Summary
Validator guide rewrite and compute requirements
docs/validator/README.md
Replaces submitter-focused intro with Docker Swarm validator guide, adds compute sizing table and PRISM delegation notes, expands automatic install with dry-run/apply mode and auto-update flow, adds validator-node quick start with required env vars and capability guidance, and updates minimum requirements section to reference the new sizing table.

Estimated code review effort: 2 (Simple) | ~10 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch mission/compute-plane

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@echobt echobt marked this pull request as ready for review July 7, 2026 23:38
@echobt echobt merged commit 1daf070 into main Jul 7, 2026
25 checks passed
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