diff --git a/docs/yaml_configuration.rst b/docs/yaml_configuration.rst index ab5b5587..41776f87 100644 --- a/docs/yaml_configuration.rst +++ b/docs/yaml_configuration.rst @@ -30,9 +30,15 @@ Log Bootstrap configuration ----------------------- + +.. note:: + Once Patroni has initialized the cluster for the first time and settings have been stored in the DCS, all future + changes to the ``bootstrap.dcs`` section of the YAML configuration will not take any effect! If you want to change + them please use either ``patronictl edit-config`` or the Patroni :ref:`REST API `. + - **bootstrap**: - - **dcs**: This section will be written into `///config` of the given configuration store after initializing of new cluster. The global dynamic configuration for the cluster. Under the ``bootstrap.dcs`` you can put any of the parameters described in the :ref:`Dynamic Configuration settings ` and after Patroni initialized (bootstrapped) the new cluster, it will write this section into `///config` of the configuration store. All later changes of ``bootstrap.dcs`` will not take any effect! If you want to change them please use either ``patronictl edit-config`` or Patroni :ref:`REST API `. + - **dcs**: This section will be written into `///config` of the given configuration store after initializing the new cluster. The global dynamic configuration for the cluster. You can put any of the parameters described in the :ref:`Dynamic Configuration settings ` under ``bootstrap.dcs`` and after Patroni has initialized (bootstrapped) the new cluster, it will write this section into `///config` of the configuration store. - **method**: custom script to use for bootstrapping this cluster. See :ref:`custom bootstrap methods documentation ` for details.