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(readme): Add additional recommended specs for running a node #307

Merged
merged 2 commits into from
Sep 17, 2024

Conversation

wbnns
Copy link
Member

@wbnns wbnns commented Aug 6, 2024

Add additional clarity regarding hardware requirements when running a node (specifically with regard to hard drive specifications)

@cb-heimdall
Copy link
Collaborator

cb-heimdall commented Aug 6, 2024

✅ Heimdall Review Status

Requirement Status More Info
Reviews 1/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 0
Sum 1

README.md Outdated
@@ -33,7 +33,10 @@ We recommend you have this hardware configuration to run a node:

- a modern multi-core CPU with good single-core performance
- at least 16 GB RAM (32 GB recommended)
- a high performance SSD drive (NVME recommended) with at least 750GB (full node) or 4.5TB (archive node) free
- a locally attached NVMe SSD drive
- adequate storage capacity to accommodate both the [snapshot restoration process](http://base.org/tutorials/run-a-base-node/#snapshots) (if restoring from snapshot) and chain data, ensuring a minimum of (2 \* current_chain_size) + snapshot_size + 20%\_buffer
Copy link
Contributor

Choose a reason for hiding this comment

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

curious why 2 * current_chain_size? We already have 20% buffer specified

Copy link

@sameersubudhi sameersubudhi Aug 7, 2024

Choose a reason for hiding this comment

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

FYI, the specified URL returns 404. Found: https://docs.base.org/tutorials/run-a-base-node/#snapshots instead.

Copy link
Member Author

Choose a reason for hiding this comment

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

@0x00101010 I have seen feedback where people do not have enough space when working with the chain data + snapshot in their local environment so wanted to try to add additional guidance here to hopefully avoid this situation. IMO, I think only the 20% buffer will not provide ample time before encountering disk space issues alongside growth of the chain; PLMK if you think something else might be preferable here 👍

@sameersubudhi Thanks for catching this; I've dropped this URL -- alongside the typo it looks like NextJS isn't loading the page client side in time to render it correctly with the page anchor

Copy link
Contributor

Choose a reason for hiding this comment

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

@wbnns Make sense! In this case, can we give 2 recommendations, 1 as minimum (which we call out that it is just barely enough), and 1 recommended with 2 * current_chain_size indicating that it gives people the capability to handle chain growth?

The worry from me is that if user should make their own decision about how many buffer they want to have (cost wise, etc) and we can just give them enough information to make the decision

Choose a reason for hiding this comment

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

Ready for review.

anikaraghu
anikaraghu previously approved these changes Aug 6, 2024
@cb-heimdall cb-heimdall dismissed anikaraghu’s stale review August 7, 2024 07:49

Approved review 2222409524 from anikaraghu is now dismissed due to new commit. Re-request for approval.

@wbnns wbnns merged commit fb05db2 into main Sep 17, 2024
3 of 5 checks passed
@wbnns wbnns deleted the wbnns/node-hdd-requirements branch September 17, 2024 14:26
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.

6 participants