diff --git a/doc/reference/configuration/configuration_reference.rst b/doc/reference/configuration/configuration_reference.rst index 11b42a61f3..92b93bad72 100644 --- a/doc/reference/configuration/configuration_reference.rst +++ b/doc/reference/configuration/configuration_reference.rst @@ -334,6 +334,7 @@ The ``config`` section defines various parameters related to centralized configu * :ref:`config.reload ` * :ref:`config.context.* ` * :ref:`config.etcd.* ` +* :ref:`config.storage.* ` .. _configuration_reference_config_reload: @@ -465,7 +466,7 @@ config.etcd.* :start-after: ee_note_centralized_config_start :end-before: ee_note_centralized_config_end -This section describes options related to :ref:`storing configuration in etcd `. +This section describes options related to providing connection settings to a :ref:`centralized etcd-based storage `. * :ref:`config.etcd.endpoints ` * :ref:`config.etcd.prefix ` @@ -489,7 +490,7 @@ This section describes options related to :ref:`storing configuration in etcd `. + See also: :ref:`etcd_local_configuration`. | | Type: array @@ -507,7 +508,7 @@ This section describes options related to :ref:`storing configuration in etcd /config/*``. Note that ```` should start with a slash (``/``). - See also: :ref:`Local etcd configuration `. + See also: :ref:`etcd_local_configuration`. | | Type: string @@ -522,6 +523,8 @@ This section describes options related to :ref:`storing configuration in etcd `. + +* :ref:`config.storage.endpoints ` +* :ref:`config.storage.prefix ` +* :ref:`config.storage.reconnect_after ` +* :ref:`config.storage.timeout ` + + +.. _config_storage_endpoints: + +.. confval:: config.storage.endpoints + + **Since:** :doc:`3.0.0 `. + + An array of endpoints used to access a configuration storage. + Each endpoint can include the following fields: + + * ``uri`` + * ``login`` + * ``password`` + * ``params``: SSL parameters (:ref:`.params.* `). + + See also: :ref:`centralized_configuration_storage_connect_tarantool`. + + | + | Type: array + | Default: nil + | Environment variable: TT_CONFIG_STORAGE_ENDPOINTS + + +.. _config_storage_prefix: + +.. confval:: config.storage.prefix + + **Since:** :doc:`3.0.0 `. + + A key prefix used to search a configuration in a centralized configuration storage. + Tarantool searches keys by the following path: ``/config/*``. + Note that ```` should start with a slash (``/``). + + See also: :ref:`centralized_configuration_storage_connect_tarantool`. + + | + | Type: string + | Default: nil + | Environment variable: TT_CONFIG_STORAGE_PREFIX + + +.. _config_storage_reconnect_after: + +.. confval:: config.storage.reconnect_after + + **Since:** :doc:`3.0.0 `. + + See also: :ref:`centralized_configuration_storage_connect_tarantool`. + + | + | Type: number + | Default: 3 + | Environment variable: TT_CONFIG_STORAGE_RECONNECT_AFTER + + +.. _config_storage_timeout: + +.. confval:: config.storage.timeout + + **Since:** :doc:`3.0.0 `. + + See also: :ref:`centralized_configuration_storage_connect_tarantool`. + + | + | Type: number + | Default: 3 + | Environment variable: TT_CONFIG_STORAGE_TIMEOUT + + + .. _configuration_reference_credentials: @@ -2167,6 +2260,45 @@ The ``replication`` section defines configuration parameters related to :ref:`re | Environment variable: TT_REPLICATION_TIMEOUT +.. _configuration_reference_roles_options: + +roles +----- + +This section describes configuration parameters related to roles. + +.. NOTE:: + + Configuration parameters related to roles can be defined in any :ref:`scope `. + +- :ref:`roles ` +- :ref:`roles_cfg ` + + +.. _configuration_reference_roles: + +.. confval:: roles + + **Since:** :doc:`3.0.0 `. + + | + | Type: array + | Default: nil + | Environment variable: TT_ROLES + + +.. _configuration_reference_roles_cfg: + +.. confval:: roles_cfg + + **Since:** :doc:`3.0.0 `. + + | + | Type: map + | Default: nil + | Environment variable: TT_ROLES_CFG + + .. _configuration_reference_security: