Skip to content

Commit e2f3c1b

Browse files
testgroundbotgitbook-bot
authored andcommitted
GITBOOK-258: change request with no subject merged in GitBook
1 parent 06b9795 commit e2f3c1b

File tree

2 files changed

+69
-0
lines changed

2 files changed

+69
-0
lines changed

SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
* [FVM Contract Deals](experimental-features/fvm-contract-deals.md)
3535
* [Local Index Directory](experimental-features/local-index-directory/README.md)
3636
* [Architecture](experimental-features/local-index-directory/architecture.md)
37+
* [Requirements](experimental-features/local-index-directory/requirements.md)
3738
* [Initialisation](experimental-features/local-index-directory/initialisation.md)
3839
* [GraphQL API](graphql-api.md)
3940
* [JSON-RPC API](json-rpc-api.md)
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
description: Local Index Directory requirements and dependencies
3+
---
4+
5+
# Requirements
6+
7+
## Dependencies
8+
9+
Local Index Directory depends on a backend database to store various indices. Currently we support two implementations - YugabyteDB or LevelDB - depending on the size of deal data and indices a storage provider holds.
10+
11+
**LevelDB** is an open source on-disk key-value store, and can be used when indices fit on a single host.
12+
13+
**YugabyteDB** is an open source modern distributed database designed to run in any public, private, hybrid or multi-cloud environment.
14+
15+
{% hint style="info" %}
16+
Storage providers who hold more than 1PiB data are encouraged to use YugabyteDB as it is horizontally scalable, provides better monitoring and management utilities and could support future growth.
17+
{% endhint %}
18+
19+
## Hardware requirements
20+
21+
{% hint style="info" %}
22+
For detailed instructions, playbooks and hardware recommendations, see the YugabyteDB website - [https://docs.yugabyte.com](https://docs.yugabyte.com)
23+
{% endhint %}
24+
25+
YugabyteDB is designed to run on bare-metal machines, virtual machines (VMs), and containers. CPU and RAM
26+
27+
You should allocate adequate CPU and RAM. YugabyteDB has adequate defaults for running on a wide range of machines, and has been tested from 2 core to 64 core machines, and up to 200GB RAM.
28+
29+
#### Minimum requirement
30+
31+
```
32+
2 cores
33+
2GB RAM
34+
```
35+
36+
#### Production requirement
37+
38+
```
39+
16+ cores
40+
32GB+ RAM
41+
Add more CPU (compared to adding more RAM) to improve performance.
42+
```
43+
44+
#### Verify support for SSE2 and SSE4.2
45+
46+
YugabyteDB requires the SSE2 instruction set support, which was introduced into Intel chips with the Pentium 4 in 2001 and AMD processors in 2003. Most systems produced in the last several years are equipped with SSE2.
47+
48+
In addition, YugabyteDB requires SSE4.2.
49+
50+
To verify that your system supports SSE2, run the following command:
51+
52+
`cat /proc/cpuinfo | grep sse2`
53+
54+
To verify that your system supports SSE4.2, run the following command:
55+
56+
`cat /proc/cpuinfo | grep sse4.2`
57+
58+
#### Disks
59+
60+
```
61+
SSDs (solid state disks) are required.
62+
```
63+
64+
We recommend a minimum of 1TiB allocated for YugabyteDB, depending on the amount of data you store and its average block size.
65+
66+
{% hint style="warning" %}
67+
Assuming you've kept unsealed copies of all your data and have consistently indexed deal data, the size of your DAG store directory should be comparable with the requirements for YugabyteDB
68+
{% endhint %}

0 commit comments

Comments
 (0)