docs: view reset procedure guide#1086
Conversation
WalkthroughA new section on resetting node instances was added to the node operator guide, detailing when and how to perform a reset while preserving node identity and configuration. The node upgrade guide’s migration section was expanded with concrete instructions for handling network forks, referencing the new reset procedure and clarifying recovery steps. Changes
Estimated code review effort1 (~5 minutes) Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Time Submission Status
|
MicBun
force-pushed
the
resetGuideGenesis
branch
from
c8fedb2 to
bfd786e
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
docs/node-upgrade-guide.md (1)
110-123: markdownlint ⌗MD004 – use consistent unordered-list marker
The rest of the document uses*but this block switches to-. Fixing keeps the linter green.-**Prerequisites:** -- Check official announcements for specific migration instructions -- Ensure you have the latest `truf-node-operator` repository (`git pull`) +**Prerequisites:** +* Check official announcements for specific migration instructions +* Ensure you have the latest `truf-node-operator` repository (`git pull`) … -**What's Preserved During Network Forks:** -- Node identity (nodekey) and validator status -- All custom configuration settings -- Chain ID continuity -- Historical data up to the fork point +**What's Preserved During Network Forks:** +* Node identity (nodekey) and validator status +* All custom configuration settings +* Chain ID continuity +* Historical data up to the fork point
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/node-operator-guide.md(3 hunks)docs/node-upgrade-guide.md(1 hunks)
🪛 markdownlint-cli2 (0.17.2)
docs/node-upgrade-guide.md
111-111: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
112-112: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
119-119: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
120-120: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
121-121: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
122-122: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/node-upgrade-guide.md
111-111: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
112-112: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
119-119: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
120-120: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
121-121: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
122-122: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: acceptance-test
🔇 Additional comments (1)
docs/node-operator-guide.md (1)
781-789: Consider also backing up validator signing keys
The procedure states that validator status is preserved, yet onlynodekey.jsonis backed up. If the validator signing key (priv_validator_key.jsonor similar) resides elsewhere, the node may lose signing capability. Add a note (or command) to back this up where applicable.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
docs/node-operator-guide.md (1)
805-815: Make the backup directory timestamped & reuse a variable
Using the same literal path (backup-reset) on every reset silently overwrites any previous backup and loses history. A one-liner variable also sidesteps the classic “date evaluated twice” issue flagged in earlier reviews.-# Create backup directory -mkdir -p ~/truf-node-operator/backup-reset - -# Backup nodekey to preserve node identity -cp ~/truf-node-operator/my-node-config/nodekey.json ~/truf-node-operator/backup-reset/ - -# Backup config.toml if you want to preserve custom settings (optional) -cp ~/truf-node-operator/my-node-config/config.toml ~/truf-node-operator/backup-reset/ +# Create a timestamped backup directory and reuse it consistently +BACKUP_DIR=~/truf-node-operator/backup.$(date +%Y%m%d_%H%M%S) +mkdir -p "$BACKUP_DIR" + +# Backup nodekey to preserve node identity +cp ~/truf-node-operator/my-node-config/nodekey.json "$BACKUP_DIR"/ + +# Backup config.toml if it exists (optional) +[ -f ~/truf-node-operator/my-node-config/config.toml ] && \ + cp ~/truf-node-operator/my-node-config/config.toml "$BACKUP_DIR"/
🧹 Nitpick comments (1)
docs/node-operator-guide.md (1)
845-858: Path inconsistency:~/nodelikely wrong for most operators
Earlier sections clone the code into~/trufnetwork/node(or simply~/noderelative to the working dir at that moment). Hard-codingcd ~/nodebreaks for anyone who followed the default cloning steps from a different directory.- cd ~/node # assuming you cloned the node repository here, please adjust if different + cd ~/trufnetwork/node # adjust if you placed the repository elsewhereAlternatively, reference the same
$KWILD_SRCvariable or absolute path used in the build-from-source instructions to stay DRY.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/node-operator-guide.md(4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: acceptance-test
- GitHub Check: lint
🔇 Additional comments (1)
docs/node-operator-guide.md (1)
164-167:chmod +xaddition is spot-on
Explicitly marking the binary executable prevents the “permission denied” surprise on fresh installs.
|
merged immediately so it can be shared |
2 participants
Description
Related Problem
resolves: https://github.com/trufnetwork/truf-network/issues/802
How Has This Been Tested?
Let me try after network is up
Summary by CodeRabbit