docs: simplify and correct Node Operators procedures - #235
Closed
pgarciagon wants to merge 11 commits into
Closed
Conversation
✅ Deploy Preview for koinos-documentation ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Author
|
Superseded by draft PR #238, which consolidates Node Operators, Architecture, Resources, and the complete four-chapter baseline report for a single review and merge into dev. The original branch and commits remain available; no content was discarded. |
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
Reworks Node Operators into clear procedures for operating the official
koinos/koinosDocker Compose deployment directly. It targets Ubuntu production servers, keeps platform scope explicit, and does not introduce documentation-owned helper scripts or operator tooling.This revision also simplifies the operator language and restores concise information that was useful in the published documentation without restoring stale tables, historical burn amounts, or unsafe quick starts.
What changed
Connected peerscount, never the node's ownMy address;/opt/koinosand/opt/koinos-nextby using the explicit Compose project namekoinos;multiaddrinformation;Safety preserved
--profile allquick start;Upstream comparison
Reviewed against:
docs.koinos.io/validators/section;masterbranch;koinos/koinos@821674672e699bf56e94d7c0e8bce122e83d1482for Compose profiles, configuration, environment variables, services, and command behavior.Validation evidence
Passed locally on 2026-07-25:
node --check scripts/verify-node-operator-commands.mjs;npm run node-commands:verify: 90 command blocks and 455 assertions, including negative fixtures for own-address-only peer logs, increasing restart counts, restart-loop state, missing UFW confirmation, and activation/rollback Compose paths;npm run examples:verify: 50 documentation examples and 50 manifest entries;npm run examples:syntax: 22 JavaScript files;npm run examples:test: 23 tests passed;npm run examples:start: 7 projects;npm run examples:smoke: 7 projects;npm run docs:links;git diff --check.Every page changed in this revision was reviewed locally at 1440×900 and 390×844. All 11 pages rendered with visible headings, readable 16 px mobile body text, no document-level horizontal overflow, no broken images, and no browser console errors. Long command lines and wide tables remained horizontally scrollable inside their own containers.
The MkDocs build still reports the two documented pre-existing warnings outside this scope: the missing
exchanges/jsonrpc.mdnav target and the missinginteracting/koilib.mdlink fromdocs/index.md.Checks that require a real synchronized node, recovery SSH path, public firewall, DNS, TLS certificate, or irreversible transaction remain explicit operator/test-server checks; CI does not claim to have executed those against production infrastructure.
PR state
This PR intentionally remains open as a draft targeting
dev.