Skip to content

Commit 8954dde

Browse files
authored
Improve cluster sizing doc on control plane/metastore/janitor. Closes quickwit-oss#5872 (quickwit-oss#6202)
1 parent 92a526b commit 8954dde

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

docs/deployment/cluster-sizing.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -74,17 +74,22 @@ Searcher nodes based on:
7474
### Other services
7575

7676
The Control Plane, Metastore and, Janitor are lightweight components.
77-
Each of these services requires 1 replica.
7877

79-
The Control Plane needs a single core and 2GB of RAM. It doesn't require any disk.
80-
81-
The Metastore also requires a single core and 2GB of RAM. For clusters handling
82-
hundreds of indexes, you may increase the size to 2 cores and 4GB of RAM. It
83-
doesn't write to disk.
84-
85-
In general, the Janitor requires 1 core and 2GB of RAM and doesn't use the disk.
86-
If you use the [delete API](https://quickwit.io/docs/overview/concepts/deletes),
87-
the Janitor should be dimensioned like an indexer.
78+
- **Control Plane**: A cluster must have only one Control Plane. It needs a
79+
single core and 2GB of RAM. It doesn't require any disk.
80+
81+
- **Metastore**: A cluster must have exactly one Metastore when using the
82+
[file-backed metastore](../configuration/metastore-config.md#file-backed-metastore).
83+
When using the [PostgreSQL metastore](#postgres-metastore-backend), you can
84+
run one or several Metastore pods for high availability (HA). The Metastore
85+
requires a single core and 2GB of RAM. For clusters handling hundreds of
86+
indexes, you may increase the size to 2 cores and 4GB of RAM. It doesn't
87+
write to disk (when using PostgreSQL, the database handles persistence).
88+
89+
- **Janitor**: A cluster must have only one Janitor. In general, it requires 1
90+
core and 2GB of RAM and doesn't use the disk. If you use the [delete
91+
API](https://quickwit.io/docs/overview/concepts/deletes), the Janitor should
92+
be dimensioned like an indexer.
8893

8994
### Single node deployments
9095

0 commit comments

Comments
 (0)