From 7bb3a3387a73705ad9f61b9620ca734b704af814 Mon Sep 17 00:00:00 2001 From: Rafael Bradley Date: Sun, 10 Aug 2025 23:35:26 -0300 Subject: [PATCH] Add documentation about scylla's `aio-max-nr` in the crate's root docs --- src/main.rs | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/src/main.rs b/src/main.rs index 951ee46..bf544e3 100644 --- a/src/main.rs +++ b/src/main.rs @@ -22,6 +22,22 @@ //! //! To stop the database cluster at any time, run `docker compose down`. To stop it and delete the //! volumes (resetting the database), run `docker compose down -v`. +//! +//! Before booting up scylla, you'll need to set the `aio-max-nr` kernel parameter to `1048576` or +//! higher. You can check [Scylla's documentation](https://hub.docker.com/r/scylladb/scylla) for +//! the math of the value at which you'll need to set the parameter. In linux, you can set it by +//! running: +//! +//! ```shell +//! $ sudo sysctl -w fs.aio-max-nr=1048576 +//! ``` +//! +//! That will set it up for your current session. To make it persistent across reboots, add the +//! following to your `/etc/sysctl.conf` file (or to a new file in `/etc/sysctl.d/`): +//! +//! ```conf +//! fs.aio-max-nr = 1048576 +//! ``` //! //! ## Booting Up //!