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: change node requirements #1868

Merged
merged 4 commits into from
Feb 10, 2025
Merged

docs: change node requirements #1868

merged 4 commits into from
Feb 10, 2025

Conversation

jcstein
Copy link
Member

@jcstein jcstein commented Jan 17, 2025

Overview

Updates node requirements to:

DA Layer
------------
24G Memory 
6 vCPUs
5 TiB Storage 
Cons
------------
24G Memory 
8 vCPUs
3 TiB Storage 

Resolves #1883

Summary by CodeRabbit

  • Documentation
    • Updated hardware requirements for all Celestia node types:
      • Removed specific minimum hardware requirements and replaced them with a reference link to recommended specifications.
      • Increased RAM for Bridge and Full storage nodes from 16 GB to 64 GB.
      • Increased CPU cores for Bridge node from 6 to 8 cores and for Full storage node from Quad-core to 8 cores.
      • Increased disk storage for both nodes from 2 TB NVME to 5 TiB NVME.
      • Increased RAM for Consensus nodes from 16 GB to 24 GB and 64 GB, with disk storage increased to 3 TiB and 6 TiB NVME.
    • Simplified documentation by consolidating hardware specifications into a single resource.

Copy link
Contributor

coderabbitai bot commented Jan 17, 2025

Walkthrough

The documentation for Celestia node types has been updated to remove specific hardware requirements across multiple guides, including bridge, consensus, full storage, validator, and light nodes. Instead of listing minimum specifications, each guide now directs users to a separate document that details the recommended hardware requirements. This change simplifies the guides and consolidates hardware information into a single resource.

Changes

File Changes
how-to-guides/bridge-node.md - Removed specific hardware requirements; added link to recommended hardware requirements.
how-to-guides/consensus-node.md - Removed specific hardware requirements; added link to recommended hardware requirements.
how-to-guides/full-storage-node.md - Removed specific hardware requirements; added link to recommended hardware requirements.
how-to-guides/validator-node.md - Removed specific hardware requirements; added link to recommended hardware requirements.
how-to-guides/light-node.md - Removed specific hardware requirements; added link to recommended hardware requirements.
how-to-guides/nodes-overview.md - Updated recommended hardware requirements for various node types, increasing memory and storage specifications.
tutorials/node-tutorial.md - Removed specific hardware requirements; added link to recommended hardware requirements.

Assessment against linked issues

Objective Addressed Explanation
Revise hardware requirements for archival consensus nodes (#1883)

Possibly related issues

Possibly related PRs

  • docs: update consensus-node page  #1662: The changes in the main PR regarding the removal of specific hardware requirements for various types of Celestia nodes are related to the retrieved PR, which also updates the hardware requirements for the consensus node.
  • Update full-storage-node.md #1752: The changes in the main PR regarding the removal of specific hardware requirements for various Celestia nodes are related to the retrieved PR, which also updates the hardware specifications for the full storage node by changing the disk storage requirement.

Suggested labels

documentation

Suggested reviewers

  • rootulp
  • Bidon15

Poem

🐰 Nodes growing strong, hardware takes flight,
Bytes and RAM dancing with delight,
From specifics to links, we simplify,
Celestia's guides, reaching for the sky! 🚀


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>, 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@jcstein jcstein requested a review from aWN4Y25pa2EK January 17, 2025 23:12
Copy link
Contributor

github-actions bot commented Jan 17, 2025

PR Preview Action v1.6.0

🚀 View preview at
https://celestiaorg.github.io/docs-preview/pr-1868/

Built to branch main at 2025-02-10 18:05 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

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: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a888617 and 31ba787.

📒 Files selected for processing (5)
  • how-to-guides/bridge-node.md (1 hunks)
  • how-to-guides/consensus-node.md (1 hunks)
  • how-to-guides/full-storage-node.md (1 hunks)
  • how-to-guides/nodes-overview.md (1 hunks)
  • how-to-guides/validator-node.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build
🔇 Additional comments (3)
how-to-guides/nodes-overview.md (1)

39-40: Hardware requirements are consistently updated across node types.

The updated requirements align with the PR objectives:

  • DA Layer nodes (Bridge & Full storage): 24GB RAM, 8 cores, 5 TiB NVME
  • Consensus Layer nodes (Validator & Consensus): 24GB RAM, 8 cores, 3 TiB SSD

Also applies to: 46-47

how-to-guides/validator-node.md (1)

22-24: Hardware requirements match nodes-overview.md.

The updated requirements for validator nodes are consistent with the overview document.

how-to-guides/consensus-node.md (1)

24-26: Hardware requirements match nodes-overview.md.

The updated requirements for consensus nodes are consistent with the overview document.

how-to-guides/full-storage-node.md Outdated Show resolved Hide resolved
how-to-guides/bridge-node.md Outdated Show resolved Hide resolved
@jcstein jcstein requested a review from tty47 January 17, 2025 23:55
@jcstein jcstein changed the title docs: change node reqs docs: change node requirements Jan 22, 2025
@jcstein jcstein self-assigned this Jan 22, 2025
@jcstein
Copy link
Member Author

jcstein commented Feb 5, 2025

This should also implement #1883

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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a3bf1a0 and b642a0b.

📒 Files selected for processing (7)
  • how-to-guides/bridge-node.md (2 hunks)
  • how-to-guides/consensus-node.md (1 hunks)
  • how-to-guides/full-storage-node.md (1 hunks)
  • how-to-guides/light-node.md (1 hunks)
  • how-to-guides/nodes-overview.md (1 hunks)
  • how-to-guides/validator-node.md (1 hunks)
  • tutorials/node-tutorial.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • how-to-guides/bridge-node.md
🔇 Additional comments (7)
how-to-guides/nodes-overview.md (2)

42-47: Non-archival Consensus Nodes Specs Verified
The table now shows non-archival consensus nodes with 24 GB RAM, 8 cores, and 3 TiB NVME – which aligns with the updated Cons component requirements as specified in the PR.


51-54: Archival Consensus Nodes Specs Confirmation Needed
The archival consensus nodes are listed with elevated specifications (Validator at 48 GB RAM and Consensus node at 64 GB RAM). These values are not specified in the PR objectives. Please confirm that these archival node specifications are correct and intentional.

how-to-guides/full-storage-node.md (1)

20-22: Centralized Hardware Requirements Reference
The explicit hardware specifications have been removed and replaced with a reference to the centralized hardware requirements document:
See [hardware requirements](/how-to-guides/nodes-overview.md#recommended-celestia-node-requirements).
This improves consistency and maintainability across documentation.

how-to-guides/light-node.md (1)

27-27: Hardware Requirements Reference Updated
The explicit hardware requirements for light nodes have been replaced with a link to the centralized hardware requirements. This change streamlines the documentation and ensures all node types refer to a single source for hardware recommendations.

how-to-guides/validator-node.md (1)

19-19: Centralized Hardware Requirements Reference
The validator node guide is now updated to remove explicit hardware values and instead references the centralized hardware requirements document. This ensures consistency with the rest of the documentation.

how-to-guides/consensus-node.md (1)

20-24: Hardware Requirements Consolidation
The consensus node guide now replaces the detailed minimum hardware requirements with a reference link:
See [hardware requirements](/how-to-guides/nodes-overview.md#recommended-celestia-node-requirements).
This refactoring aligns the guide with the overall documentation update, reducing redundancy and potential inconsistency.

tutorials/node-tutorial.md (1)

47-47: Update Centralized Hardware Requirements Link

The new link in the "Hardware requirements" section now directs users to the consolidated resource at /how-to-guides/nodes-overview.md#recommended-celestia-node-requirements, which aligns well with the PR objectives of updating node requirements and simplifying the documentation. Please ensure that the referenced page is updated to reflect the new specifications (for DA Layer: Memory: 24G, vCPUs: 6, Storage: 5 TiB; and for Cons: Memory: 24G, vCPUs: 8, Storage: 3 TiB) so that users have accurate deployment guidelines.

how-to-guides/nodes-overview.md Show resolved Hide resolved
@jcstein jcstein requested a review from mindstyle85 February 10, 2025 15:59
@jcstein jcstein requested a review from mindstyle85 February 10, 2025 18:06
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

♻️ Duplicate comments (1)
how-to-guides/nodes-overview.md (1)

39-40: Inconsistent Data Availability Node Specs with PR Objectives

The table rows for the Bridge node and Full storage node still list "64 GB RAM" and "8 cores", whereas the PR objectives indicate that DA Layer nodes should require "24 GB RAM" and "6 cores". Please update these rows accordingly to ensure consistency with the updated requirements.

-| Bridge node       | 64 GB RAM   | 8 cores     | 5 TiB NVME  | 1 Gbps    |
-| Full storage node | 64 GB RAM   | 8 cores     | 5 TiB NVME  | 1 Gbps    |
+| Bridge node       | 24 GB RAM   | 6 cores     | 5 TiB NVME  | 1 Gbps    |
+| Full storage node | 24 GB RAM   | 6 cores     | 5 TiB NVME  | 1 Gbps    |
🧹 Nitpick comments (1)
how-to-guides/nodes-overview.md (1)

51-56: Archival Consensus Nodes Specification Clarification

The archival consensus nodes table now shows a "Consensus node" with "64 GB RAM", "8 cores", and "6 TiB NVME". Since the PR objectives only specify the updated requirements for the Cons component as "24 GB RAM", "8 cores", and "3 TiB NVME", please confirm whether the higher specifications for archival nodes are intentional. If archival nodes are indeed meant to have increased resources, consider adding a clarifying note in the documentation.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b642a0b and cb0524d.

📒 Files selected for processing (1)
  • how-to-guides/nodes-overview.md (1 hunks)
🔇 Additional comments (1)
how-to-guides/nodes-overview.md (1)

42-50: Consensus Nodes Table Update

The updated non-archival consensus nodes table now specifies the "Validator" and "Consensus node" with "24 GB RAM", "8 cores", and "3 TiB NVME" as required for the Cons component per the PR objectives. This update aligns with the intended resource specifications.

@jcstein jcstein merged commit cc3f992 into main Feb 10, 2025
6 checks passed
@jcstein jcstein deleted the jcs/node-reqs-update branch February 10, 2025 20:37
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.

Revise hardware requirements for archival consensus nodes
2 participants