-
Notifications
You must be signed in to change notification settings - Fork 395
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
Conversation
WalkthroughThe 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
Assessment against linked issues
Possibly related issues
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
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? 🪧 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 (
|
|
There was a problem hiding this 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
📒 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.
This should also implement #1883 |
There was a problem hiding this 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
📒 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 LinkThe 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.
There was a problem hiding this 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 ObjectivesThe 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 ClarificationThe 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
📒 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 UpdateThe 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.
Overview
Updates node requirements to:
Resolves #1883
Summary by CodeRabbit