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

docs: explain precedence of configure options

Browse Source 
to explain for instance which setting takes effect if both
command line options and `scylla.yaml` configures the same parameter.

Signed-off-by: Kefu Chai <kefu.chai@scylladb.com>
(cherry picked from commit 1aa030a8cd)

Closes scylladb/scylladb#20775
This commit is contained in:
Kefu Chai
2024-09-19 14:44:48 +08:00
committed by Botond Dénes
parent 10d71d2f4b
commit ef32ba704d
1 changed files with 17 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/reference/configuration-parameters.rst
View File

@@ -3,7 +3,23 @@ Configuration Parameters
========================
This section contains a list of properties that can be configured in ``scylla.yaml`` - the main configuration file for ScyllaDB.
In addition, properties that support live updates (liveness) can be updated via the ``system.config`` virtual table or the REST API.
In addition, properties that support live updates (liveness) can be updated via the ``system.config`` virtual table or the :doc:`REST API </operating-scylla/rest>`.
Live update means that parameters can be modified dynamically while the server
is running. If ``liveness`` of a parameter is set to ``true``, sending the ``SIGHUP``
signal to the server processes will trigger ScyllaDB to re-read its configuration
and override the current configuration with the new value.
**Configuration Precedence**
As the parameters can be configured in more than one place, ScyllaDB applies them
in the following order with ``scylla.yaml`` parameters updated via ``SIGHUP``
having the highest priority:
#. Live update via ``scylla.yaml`` (with ``SIGHUP``) or REST API
#. ``system.config`` table
#. command line options
#. ``scylla.yaml``
.. scylladb_config_list:: ../../db/config.hh ../../db/config.cc
:template: db_config.tmpl