docs: add two more cases to the troubleshooting guide#2005
docs: add two more cases to the troubleshooting guide#2005jcstein merged 4 commits intocelestiaorg:mainfrom
Conversation
Signed-off-by: Long Zhang <gluckzhang@gmail.com>
Signed-off-by: Long Zhang <gluckzhang@gmail.com>
WalkthroughThis update enhances the Celestia node troubleshooting guide by adding two new sections. The first section addresses the "no space left on device" error on ext4 file systems, providing explanations and solutions including enabling the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Node
participant Filesystem
participant Systemd
User->Node: Starts Celestia node
Node->Filesystem: Writes data to ext4
Filesystem-->>Node: Error: "no space left on device"
User->Filesystem: Enable large_dir or migrate to XFS/ZFS
User->Systemd: Starts bridge node service
Systemd->Node: Launch with --keyring.backend file
Node-->>Systemd: Prompts for passphrase repeatedly
Systemd-->>User: Error: "too many failed passphrase attempts"
User->Node: Switch backend to test or update config
Node->User: Node starts successfully
Possibly related PRs
Suggested reviewers
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
how-to-guides/celestia-node-troubleshooting.md (1)
357-378: Minor grammar and punctuation improvements in the "too many failed passphrase attempts" section
- Add a comma after “Usually” for readability.
- Insert a comma before “which” in the sentence about the default keyring backend.
Proposed diff:
@@ line 364 - ERROR module/state state/keyring.go:23 can't get key: `my_celes_key` from the keystore: too many failed passphrase attempts - Usually a bridge node wallet does not need to be funded unless you plan to do `PayForBlob` through it. + ERROR module/state state/keyring.go:23 can't get key: `my_celes_key` from the keystore: too many failed passphrase attempts + Usually, a bridge node wallet does not need to be funded unless you plan to do `PayForBlob` through it. @@ line 365 - We suggest using the default keyring backend (`test`) in this case which does not require a passphrase. + We suggest using the default keyring backend (`test`) in this case, which does not require a passphrase.🧰 Tools
🪛 LanguageTool
[typographical] ~364-~364: Consider adding a comma after ‘Usually’ for more clarity.
Context: ...oo many failed passphrase attempts ``` Usually a bridge node wallet does not need to b...(RB_LY_COMMA)
[uncategorized] ~365-~365: A comma might be missing here.
Context: ...efault keyring backend (test) in this case which does not require a passphrase. I...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
how-to-guides/celestia-node-troubleshooting.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
how-to-guides/celestia-node-troubleshooting.md
[uncategorized] ~323-~323: You might be missing the article “the” here.
Context: ...ou may also observe similar errors from tar command when extracting a snapshot ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[typographical] ~364-~364: Consider adding a comma after ‘Usually’ for more clarity.
Context: ...oo many failed passphrase attempts ``` Usually a bridge node wallet does not need to b...
(RB_LY_COMMA)
[uncategorized] ~365-~365: A comma might be missing here.
Context: ...efault keyring backend (test) in this case which does not require a passphrase. I...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
🪛 markdownlint-cli2 (0.17.2)
how-to-guides/celestia-node-troubleshooting.md
327-327: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
353-353: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
it turns out that yarn lint:md will check all the .md files and it can contain lots of errors. I guess that's why the git hooks are disabled for now. Signed-off-by: Long Zhang <gluckzhang@gmail.com>
Signed-off-by: Long Zhang <gluckzhang@gmail.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
how-to-guides/celestia-node-troubleshooting.md (1)
364-373: Improve grammar and normalize TOML snippet indentation
- Add a comma after "Usually" and after "case" to improve readability.
- Align the
[State]TOML block so that its keys are not indented under the header.@@ 364,365 - Usually a bridge node wallet does not need to be funded unless you plan to do `PayForBlob` through it. We suggest using the default keyring backend (`test`) in this case which does not require a passphrase. + Usually, a bridge node wallet does not need to be funded unless you plan to do `PayForBlob` through it. We suggest using the default keyring backend (`test`) in this case, which does not require a passphrase. @@ 371-373 - [State] - DefaultKeyName = "my_celes_key" - DefaultBackendName = "test" + [State] + DefaultKeyName = "my_celes_key" + DefaultBackendName = "test"🧰 Tools
🪛 LanguageTool
[typographical] ~364-~364: Consider adding a comma after ‘Usually’ for more clarity.
Context: ...oo many failed passphrase attempts ``` Usually a bridge node wallet does not need to b...(RB_LY_COMMA)
[uncategorized] ~365-~365: A comma might be missing here.
Context: ...efault keyring backend (test) in this case which does not require a passphrase. I...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
how-to-guides/celestia-node-troubleshooting.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
how-to-guides/celestia-node-troubleshooting.md
[typographical] ~364-~364: Consider adding a comma after ‘Usually’ for more clarity.
Context: ...oo many failed passphrase attempts ``` Usually a bridge node wallet does not need to b...
(RB_LY_COMMA)
[uncategorized] ~365-~365: A comma might be missing here.
Context: ...efault keyring backend (test) in this case which does not require a passphrase. I...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
🪛 markdownlint-cli2 (0.17.2)
how-to-guides/celestia-node-troubleshooting.md
327-327: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
| #### Option 1: enable the large_dir feature for ext4 | ||
|
|
||
| :::tip NOTE | ||
| If the Node Store is on the same partition as the OS, it is recommended to take Option 2. | ||
| ::: | ||
|
|
||
| 1. Stop the node |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Adjust heading levels for Option sections
The subheadings #### Option 1: ... and #### Option 2: ... skip an h3 level under the h2 "Error: ..." section. Update them to h3 (###) to maintain proper Markdown hierarchy and satisfy MD001.
- #### Option 1: enable the large_dir feature for ext4
+ ### Option 1: enable the large_dir feature for ext4
- #### Option 2: migrate to XFS/ZFS file system
+ ### Option 2: migrate to XFS/ZFS file system📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| #### Option 1: enable the large_dir feature for ext4 | |
| :::tip NOTE | |
| If the Node Store is on the same partition as the OS, it is recommended to take Option 2. | |
| ::: | |
| 1. Stop the node | |
| ### Option 1: enable the large_dir feature for ext4 | |
| :::tip NOTE | |
| If the Node Store is on the same partition as the OS, it is recommended to take Option 2. | |
| ::: | |
| 1. Stop the node | |
| ### Option 2: migrate to XFS/ZFS file system |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
327-327: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
|
thank you @gluckzhang ! |
2 participants
Overview
When trying to set up a bridge node for the Mocha testnet, we encountered some errors related to
celestia-nodeand no guidance was found in the current documentation.We found or confirmed the solutions via Discord and it can be helpful to also add such information to the documentation.
Summary by CodeRabbit