docs: extra step to remove application.db

[rootulp]

Closes #1721

Summary by CodeRabbit

• New Features

  • Enhanced instructions for resolving consensus node errors during network upgrades.
  • Added optional backup steps for validator keys and important files in validator node upgrade instructions.

• Documentation

  • Improved clarity with step-by-step troubleshooting guidance for consensus node preparation.
  • Structured upgrade process for validator nodes to ensure smoother upgrades and reduce synchronization issues.

[coderabbitai]

Walkthrough

The changes enhance the documentation for upgrading consensus and validator nodes in the Celestia network. They provide clearer, step-by-step instructions for troubleshooting consensus node errors and emphasize the importance of backing up critical files before upgrades. The revisions specifically address the removal of the application.db file, which was not previously included in the reset-state command, ensuring users have comprehensive guidance for a smoother upgrade process.

Changes

File	Change Summary
nodes/consensus-node.md	Enhanced instructions for resolving consensus node errors during network upgrades with detailed steps.
nodes/validator-node.md	Added optional backup steps for validator keys and priv_validator_state.json in upgrade instructions.

Assessment against linked issues

Objective	Addressed	Explanation
celestia-appd tendermint reset-state does not remove application.db (#1721)	✅

Possibly related PRs

• docs: Lemongrass hardfork #1641: Changes related to the Lemongrass hardfork, relevant for consensus node upgrade instructions.
• docs: update consensus-node page  #1662: Updates to nodes/validator-node.md with similar upgrade instructions.
• docs: clarify no cosmovisor #1663: Clarification that Cosmovisor is not required for upgrading consensus nodes.
• docs: sync mode table #1664: Introduction of a sync mode table that complements upgrade instructions.
• docs: arabica upgrade height #1666: Specification of upgrade heights for the Arabica network, relevant to upgrade instructions.
• docs: v2 upgrade height for mainnet beta #1695: Update of the upgrade height for the mainnet beta, directly related to upgrade instructions.

Suggested labels

documentation

Poem

🐇 In the land of Celestia bright,
Upgrades now shine with clearer light.
Back up your keys, don't let them stray,
Follow the steps, and you'll be okay!
With application.db gone, you'll see,
A smoother path to harmony! 🌟

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9510b6d and 7f85678.

Files selected for processing (2)

• nodes/consensus-node.md (1 hunks)
• nodes/validator-node.md (1 hunks)

Additional context used

LanguageTool

nodes/consensus-node.md

[uncategorized] ~436-~436: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...etwork has upgraded to a new app version but your consensus node was not prepared fo...

(COMMA_COMPOUND_SENTENCE_2)

Additional comments not posted (2)

nodes/validator-node.md (1)

259-265: LGTM!

The added steps provide a clear and structured approach for users to upgrade their validator nodes. Backing up important data, removing databases, and restarting with the appropriate upgrade height parameter are crucial for ensuring a smooth upgrade process and maintaining the stability of the Celestia network.

These steps address the issue raised in #1721 by guiding users to manually remove the application.db file after executing the reset-state command, which helps prevent potential confusion and ensures a complete reset of the application state.

The inclusion of these optional steps in the documentation will greatly benefit node operators and contribute to a more seamless upgrade experience across the network.

nodes/consensus-node.md (1)

436-441: Excellent addition to the troubleshooting section!

The instructions provided are clear, concise, and cover the necessary steps to resolve the +2/3 committed an invalid block: wrong Block.Header.Version error that can occur during network upgrades. Following these steps will ensure that the consensus node is properly prepared for the upgrade and can continue to participate in the network.

It's crucial for node operators to be aware of network upgrades and take the appropriate actions to update their nodes. Failing to do so can lead to consensus failures and prevent the node from syncing with the network.

Tools

LanguageTool

[uncategorized] ~436-~436: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...etwork has upgraded to a new app version but your consensus node was not prepared fo...

(COMMA_COMPOUND_SENTENCE_2)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  -- I pushed a fix in commit <commit_id>, please review it.
  -- Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  -- @coderabbitai generate unit testing code for this file.
  -- @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  -- @coderabbitai generate interesting stats about this repository and render them as a table.
  -- @coderabbitai read src/utils.ts and generate unit testing code.
  -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  -- @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.