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.

Sign up for GitHub

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

Jump to bottom

docs(readme): Add additional recommended specs for running a node #307

Merged
merged 2 commits into from
Sep 17, 2024
Merged

docs(readme): Add additional recommended specs for running a node #307

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e80ba2
feat(docs): Add additional recommended specs for running a node
wbnns Aug 6, 2024
7f9a96e
docs(readme): Drop page anchor to snapshot section
wbnns Aug 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 •
edited
Loading

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

Copy link

Choose a reason for hiding this comment

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

Ready for review.


**Note:** If utilizing Amazon Elastic Block Store (EBS), ensure timing buffered disk reads are fast enough in order to avoid latency issues alongside the rate of new blocks added to Base during the initial synchronization process; `io2 block express` is recommended.

### Troubleshooting

Expand Down
Loading