Skip to content

Commit

Permalink
Updated readme with Zeke & Tarik comments
Browse files Browse the repository at this point in the history
- Added the memory requirements for sidecar.
- Added the specs needed if running also a node alongside sidecar.
- Added the benchmarks results from Tarik.
  • Loading branch information
Imod7 committed Apr 7, 2022
1 parent 28fb665 commit b5468c6
Showing 1 changed file with 31 additions and 1 deletion.
32 changes: 31 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -389,4 +389,34 @@ NOTE: You must be a member of the `@substrate` NPM org and must belong to the `D
## Hardware requirements
Sidecar is a stateless program and thus has no specific hardware requirements to run (disk space, memory, etc.).
### Disk Space
Sidecar is a stateless program and thus should not use any disk space.
### Memory
Memory wise the requirements follow the default of node.js processes which is an upper bound in HEAP memory of a little less than 2GB thus 4GB of memory should be sufficient.
### Running sidecar and a node
Please note that if you run sidecar next to a substrate node in a single machine then your system specifications should improve significantly.
- Our official specifications related to validator nodes can be found in the polkadot wiki [page](https://wiki.polkadot.network/docs/maintain-guides-how-to-validate-polkadot#standard-hardware).
- Regarding archive nodes :
- again as mentioned in the polkadot wiki [page](https://wiki.polkadot.network/docs/maintain-sync#types-of-nodes), the space needed from an archive node depends on which block we are currently on (of the specific chain we are referring to).
- there are no other hardware requirements for an archive node since it is not time critical (archive nodes do not participate in the consensus).
### Benchmarks
During the benchmarks we performed, we concluded that sidecar would use a max of 1.1GB of RSS memory.
The benchmarks were:
- using 4 threads over 12 open http connections and
- were overloading the cache with every runtime possible on polkadot.
Hardware specs in which the benchmarks were performed:
```
Machine type:
n2-standard-4 (4 vCPUs, 16 GB memory)
CPU Platform:
Intel Cascade Lake
Hard-Disk:
500GB
```

0 comments on commit b5468c6

Please sign in to comment.