mirrors/scylladb
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs/docker-hub.md: add quickstart section with --smp 1

Browse Source 
Also provide formula to calculate proper value for aio-max-nr.

Closes #7252
This commit is contained in:
Ivan Prisyazhnyy
2020-09-17 17:49:09 +02:00
committed by Piotr Sarna
parent 59463d6e5f
commit f4412029f4
1 changed files with 29 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/docker-hub.md
View File

@@ -7,6 +7,35 @@ ScyllaDB is released under the GNU Affero General Public License version 3 and t
![logo](http://www.scylladb.com/wp-content/uploads/mascot_medium.png)
# Quick start
To startup a Scylla single-node cluster in developer mode execute:
```console
$ docker run --name some-scylla --hostname some-scylla -d scylladb/scylla --smp 1
```
This command will start a Scylla single-node cluster in developer mode
(see `--developer-mode 1`) limited by a single CPU core (see `--smp`).
Production grade configuration requires tuning a few kernel parameters
such that limiting number of available cores (with `--smp 1`) is
the simplest way to go.
Multiple cores requires setting a proper value to the `/proc/sys/fs/aio-max-nr`.
On many non production systems it will be equal to 65K. The formula
to calculate proper value is:
Available AIO on the system - (request AIO per-cpu * ncpus) =
aio_max_nr - aio_nr < (reactor::max_aio + detect_aio_poll + reactor_backend_aio::max_polls) * cpu_cores =
aio_max_nr - aio_nr < (1024 + 2 + 10000) * cpu_cores =
aio_max_nr - aio_nr < 11026 * cpu_cores
where
reactor::max_aio = max_aio_per_queue * max_queues,
max_aio_per_queue = 128,
max_queues = 8.
# How to use this image
## Start a `scylla` server instance