From: Redouane Kachach Date: Fri, 1 Jul 2022 12:11:06 +0000 (+0200) Subject: doc/cephadm/services: the config section of service specs X-Git-Tag: v18.0.0~567^2 X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=b67bd50a3bb1233973586c4c2eabfb934db2e818;p=ceph.git doc/cephadm/services: the config section of service specs Fixes: https://tracker.ceph.com/issues/53997 Signed-off-by: Redouane Kachach --- diff --git a/doc/cephadm/services/index.rst b/doc/cephadm/services/index.rst index be9b3661a9e24..326aafa92f628 100644 --- a/doc/cephadm/services/index.rst +++ b/doc/cephadm/services/index.rst @@ -86,7 +86,20 @@ Service Specification ===================== A *Service Specification* is a data structure that is used to specify the -deployment of services. Here is an example of a service specification in YAML: +deployment of services. In addition to parameters such as `placement` or +`networks`, the user can set initial values of service configuration parameters +by means of the `config` section. For each param/value configuration pair, +cephadm calls the following command to set its value: + + .. prompt:: bash # + + ceph config set + +cephadm raises health warnings in case invalid configuration parameters are +found in the spec (`CEPHADM_INVALID_CONFIG_OPTION`) or if any error while +trying to apply the new configuration option(s) (`CEPHADM_FAILED_SET_OPTION`). + +Here is an example of a service specification in YAML: .. code-block:: yaml @@ -97,6 +110,10 @@ deployment of services. Here is an example of a service specification in YAML: - host1 - host2 - host3 + config: + param_1: val_1 + ... + param_N: val_N unmanaged: false networks: - 192.169.142.0/24