Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Increase LN disk recommendation to 100GB and bridge/full RAM to 16GB #1564

Merged
merged 3 commits into from
May 8, 2024

Conversation

Wondertan
Copy link
Member

@Wondertan Wondertan commented May 7, 2024

It's supposed to be temporary to give us some buffer until the sample and header pruning is finished. Afterward, we can revert and even decrease to ~5GB with pruning milestones finished.

Summary by CodeRabbit

  • Documentation
    • Updated the minimum required SSD storage for a light node from 50 GB to 100 GB.
    • Updated the minimum recommended memory requirement for bridge and full-storage nodes to 16 GB RAM.

It's supposed to be temporary, so give us some buffer until the sample and header pruning is finished. Afterward, we can revert and even decrease to ~5GB with pruning milestones finished
@Wondertan Wondertan self-assigned this May 7, 2024
Copy link
Contributor

coderabbitai bot commented May 7, 2024

Important

Auto Review Skipped

Review was skipped due to path filters

Files ignored due to path filters (1)
  • public/img/node-requirements.jpg is excluded by !**/*.jpg

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent updates involve increasing the minimum SSD storage requirement for light nodes to 100 GB and updating the minimum recommended memory requirement for bridge and full-storage nodes to 16 GB RAM. These changes aim to enhance the performance and stability of the nodes under varying resource constraints.

Changes

File Path Change Summary
nodes/light-node.md Updated SSD storage requirement from 50 GB to 100 GB
nodes/bridge-node.md Updated minimum recommended memory from 4 GB to 16 GB RAM
nodes/full-storage-node.md Updated minimum recommended memory from 4 GB to 16 GB RAM

🐇✨
In the land of code and node,
A rabbit hopped down the storage road.
"Make room, make room!" it cheerily cried,
"For bytes and bits need space to abide!"
Now with a hundred gigs to play,
Our nodes will hum a brighter day.
🌟📀

Possibly related issues

  • Consensus-Full-Nodes - resources usage issue celestia-app#2935: This update aligns with the objective of addressing crashing issues in consensus-full-nodes due to insufficient RAM. By increasing the minimum RAM requirement for nodes, stability is prioritized over sync speed, potentially mitigating the problem outlined in this issue.

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
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>.
    • 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 show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

Copy link
Contributor

github-actions bot commented May 7, 2024

PR Preview Action v1.4.7
Preview removed because the pull request was closed.
2024-05-08 15:15 UTC

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Out of diff range and nitpick comments (2)
nodes/light-node.md (2)

Line range hint 84-84: Consider adding a comma after "machine" for better readability.

- ...required to be open on your machine.  To start the light node with a connection to a v...
+ ...required to be open on your machine, to start the light node with a connection to a v...

Line range hint 182-182: Consider rephrasing to avoid wordiness.

- In order to run a light node using a custom key:
+ To run a light node with a custom key:
Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 60356e5 and 45d6e48.
Files selected for processing (1)
  • nodes/light-node.md (1 hunks)
Additional Context Used
LanguageTool (2)
nodes/light-node.md (2)

Near line 84: Possible missing comma found.
Context: ...equired to be open on your machine. To start the light node with a connection to a v...


Near line 182: Consider a shorter alternative to avoid wordiness.
Context: ...: run the light node with a custom key In order to run a light node using a custom key: 1...

Additional comments not posted (1)
nodes/light-node.md (1)

32-32: Updated disk storage requirement to 100 GB SSD Storage.

@jcstein
Copy link
Member

jcstein commented May 7, 2024

TODO

  • revise diagram to say 100GB
  • revise diagram to say 16GB for RAM for bridge/full

@jcstein jcstein changed the title Increase LN disk recommendation to 100GB docs: Increase LN disk recommendation to 100GB and bridge/full RAM to 16GB May 7, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Out of diff range and nitpick comments (6)
nodes/full-storage-node.md (5)

Line range hint 36-36: Fix the unpaired markdown link symbol.

- You can follow [the tutorial for setting up your dependencies
+ You can follow [the tutorial for setting up your dependencies]

Line range hint 40-40: Fix the unpaired markdown link symbol.

- You can follow [the tutorial for installing `celestia-node`
+ You can follow [the tutorial for installing `celestia-node`]

Line range hint 92-92: Fix the unpaired markdown link symbol.

- [the `cel-key` instructions](../../developers/celestia-node-key
+ [the `cel-key` instructions](../../developers/celestia-node-key)

Line range hint 123-123: Consider rephrasing to avoid wordiness.

- In order to run a full storage node using a custom key:
+ To run a full storage node using a custom key:

Line range hint 159-159: Consider rephrasing to avoid wordiness.

- In order to gracefully stop the full storage node, use `Control + C` in the
+ To gracefully stop the full storage node, use `Control + C` in the
nodes/bridge-node.md (1)

Line range hint 167-167: Consider rephrasing to avoid wordiness.

- In order to run a bridge node using a custom key:
+ To run a bridge node using a custom key:
Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 45d6e48 and 824a536.
Files selected for processing (2)
  • nodes/bridge-node.md (1 hunks)
  • nodes/full-storage-node.md (1 hunks)
Additional Context Used
LanguageTool (6)
nodes/bridge-node.md (1)

Near line 167: Consider a shorter alternative to avoid wordiness.
Context: ... run the bridge node with a custom key In order to run a bridge node using a custom key: ...

nodes/full-storage-node.md (5)

Near line 36: Unpaired symbol: ‘]’ seems to be missing
Context: ... Setup the dependencies You can follow [the tutorial for setting up your depende...


Near line 40: Unpaired symbol: ‘]’ seems to be missing
Context: ...# Install celestia-node You can follow [the tutorial for installing `celestia-no...


Near line 92: Unpaired symbol: ‘]’ seems to be missing
Context: ...ate your key for your node by following [the cel-key instructions](../../develo...


Near line 123: Consider a shorter alternative to avoid wordiness.
Context: ...he full storage node with a custom key In order to run a full storage node using a custom ...


Near line 159: Consider a shorter alternative to avoid wordiness.
Context: ... node. ### Stop the full storage node In order to gracefully stop the full storage node, ...

Additional comments not posted (2)
nodes/full-storage-node.md (1)

25-25: Memory requirement updated to 16 GB RAM.

nodes/bridge-node.md (1)

50-50: Memory requirement updated to 16 GB RAM.

@jcstein jcstein merged commit 9115722 into main May 8, 2024
4 checks passed
@jcstein jcstein deleted the Wondertan-patch-1 branch May 8, 2024 15:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants