quickwit-oss / quickwit-oss/quickwit
Add docs about RAM requirements for the indexer
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Rust
- Stars
- 11.7k
- Forks
- 597
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 37
Description
With the ingest API, it's quite easy to take several GB of RAM. A user struggled on Kubernetes as he limited the indexer pod RAM to 2GB.
He solved the issue by reducing max_queue_memory_usage to 500MB instead of the default value 2GiB.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the ingest API and indexer configuration documentation, focusing on the max_queue_memory_usage setting and its default value. Document how queue memory affects RAM requirements for Kubernetes deployments and explain the reported 500MB adjustment for a pod limited to 2GB.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes
- Domain
- documentation, infrastructure
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100