Add system requirements to README. #155
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #155 +/- ##
==========================================
+ Coverage 67.66% 72.78% +5.12%
==========================================
Files 32 38 +6
Lines 1976 2789 +813
==========================================
+ Hits 1337 2030 +693
- Misses 570 649 +79
- Partials 69 110 +41
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
README.md
Outdated
| For a simple deployment the following configuration works well: | ||
| * Network: Conduit colocated with Algod follower. | ||
| * Conduit: 4 CPU and 8 GB of ram. | ||
| * Algod: 4 CPU and 8 GB of ram. |
There was a problem hiding this comment.
Perhaps Conduit + Algod: 4 CPU and 8 GB of RAM? Otherwise it implies needing to dedicate that much to each process.
winder
commented
Oct 11, 2023
Co-authored-by: Will Winder <wwinder.unh@gmail.com>
gmalouf
reviewed
Oct 12, 2023
README.md
Outdated
| * Conduit + Algod: 4 CPU and 8 GB of ram. | ||
| * Storage: algod follower node, 40 GiB, 3000 IOPS minimum. | ||
| * Deployments allocating less ram might work in conjunction with [GOMEMLIMIT](https://pkg.go.dev/runtime@master#hdr-Environment_Variables) for Algod (and even Conduit). This configuration is not tested, so use with caution and monitor closely. | ||
| * Storage: 20 GiB, 3000 IOPS minimum. |
There was a problem hiding this comment.
Suggested change
| * Storage: 20 GiB, 3000 IOPS minimum. |
gmalouf
approved these changes
Oct 12, 2023
onetechnical
approved these changes
Oct 12, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Add system requirements section to README.
Test Plan
N/A