docs(validator): compute-requirements table + turnkey install with auto-update#38
Merged
Conversation
…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.
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughUpdates 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. ChangesValidator documentation update
Estimated code review effort: 2 (Simple) | ~10 minutes ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
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
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
Follow-up docs work on
mission/compute-planeafter PR #37 was merged tomain(branch fast-forwarded to
origin/main9965a601). Updates the validator guidedocs/validator/README.mdto (1) add an authoritative Compute Requirementstable and (2) document the existing turnkey installer as the automatic
one-command install with auto-update.
Compute Requirements table
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):--applyexecutes; every destructive step behind itsown flag; installs Docker (
ensure_docker),uv(ensure_uv), and Swarm ona blank host.
--validator-nodebrings upbase validator agentas an auto-updatablebase-validator-agentSwarm service plus a node-local base-supervisor whoseimage-updater digest-pins it on every new
base-validator-runtime:latestdigest (this is the auto-update).
--install-supervisorenables thebase-supervisor.servicesystemd unit(image-updater 60s; optional self-update via
SUPERVISOR_SELF_UPDATE_MANIFEST_URL).--applyquick-start with required env(
VALIDATOR_MASTER_URL,VALIDATOR_BROKER_TOKEN, wallet hotkey) and howVALIDATOR_CAPABILITIESselects agent-challenge (cpu) vs delegated PRISM.Auto-update is described via the base-supervisor image-updater only (no
watchtowerintroduced as a current capability in the guide prose).Verification
bash deploy/swarm/install-swarm.sh --help— flags/env listed.--validator-nodedry-run (docker stub reporting aninactive swarm; no
--apply, nothing installed): renders the node-localsupervisor config (
validator_agent_target_enabled: true, watchingbase-validator-runtime:latest) and thedocker service create base-validator-agent ...plan matching the docs.ruff check,ruff format --check,mypy src testsclean;
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