Skip to content

Commit 7fb9492

Browse files
authored
Fix TCM config reference (#3911)
1 parent bf0c00e commit 7fb9492

File tree

1 file changed

+72
-14
lines changed

1 file changed

+72
-14
lines changed

doc/reference/tooling/tcm/tcm_configuration_reference.rst

Lines changed: 72 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1053,21 +1053,20 @@ etcd storage parameters:
10531053
- :ref:`storage.etcd.max-call-send-msg-size <tcm_configuration_reference_storage_etcd_max-call-send-msg-size>`
10541054
- :ref:`storage.etcd.username <tcm_configuration_reference_storage_etcd_username>`
10551055
- :ref:`storage.etcd.password <tcm_configuration_reference_storage_etcd_password>`
1056-
- :ref:`storage.etcd.tls <tcm_configuration_reference_storage_etcd_tls>`
10571056
- :ref:`storage.etcd.tls.enabled <tcm_configuration_reference_storage_etcd_tls_enabled>`
10581057
- :ref:`storage.etcd.tls.auto <tcm_configuration_reference_storage_etcd_tls_auto>`
10591058
- :ref:`storage.etcd.tls.cert-file <tcm_configuration_reference_storage_etcd_tls_cert-file>`
10601059
- :ref:`storage.etcd.tls.key-file <tcm_configuration_reference_storage_etcd_tls_key-file>`
10611060
- :ref:`storage.etcd.tls.trusted-ca-file <tcm_configuration_reference_storage_etcd_tls_trusted-ca-file>`
1062-
- :ref:`storage.etcd.tls.client-cert-auth <tcm_configuration_reference_storage_etcd_tls>`
1063-
- :ref:`storage.etcd.tls.crl-file: <tcm_configuration_reference_storage_etcd_tls>`
1064-
- :ref:`storage.etcd.tls.insecure-skip-verify <tcm_configuration_reference_storage_etcd_tls>`
1065-
- :ref:`storage.etcd.tls.skip-client-san-verify <tcm_configuration_reference_storage_etcd_tls>`
1066-
- :ref:`storage.etcd.tls.server-name <tcm_configuration_reference_storage_etcd_tls>`
1067-
- :ref:`storage.etcd.tls.cipher-suites <tcm_configuration_reference_storage_etcd_tls>`
1068-
- :ref:`storage.etcd.tls.allowed-cn <tcm_configuration_reference_storage_etcd_tls>`
1069-
- :ref:`storage.etcd.tls.allowed-hostname <tcm_configuration_reference_storage_etcd_tls>`
1070-
- :ref:`storage.etcd.tls.empty-cn <tcm_configuration_reference_storage_etcd_tls>`
1061+
- :ref:`storage.etcd.tls.client-cert-auth <tcm_configuration_reference_storage_etcd_tls_client-cert-auth>`
1062+
- :ref:`storage.etcd.tls.crl-file <tcm_configuration_reference_storage_etcd_tls_crl-file>`
1063+
- :ref:`storage.etcd.tls.insecure-skip-verify <tcm_configuration_reference_storage_etcd_tls_insecure-skip-verify>`
1064+
- :ref:`storage.etcd.tls.skip-client-san-verify <tcm_configuration_reference_storage_etcd_tls_skip-client-san-verify>`
1065+
- :ref:`storage.etcd.tls.server-name <tcm_configuration_reference_storage_etcd_tls_server-name>`
1066+
- :ref:`storage.etcd.tls.cipher-suites <tcm_configuration_reference_storage_etcd_tls_cipher-suites>`
1067+
- :ref:`storage.etcd.tls.allowed-cn <tcm_configuration_reference_storage_etcd_tls_allowed-cn>`
1068+
- :ref:`storage.etcd.tls.allowed-hostname <tcm_configuration_reference_storage_etcd_tls_allowed-hostname>`
1069+
- :ref:`storage.etcd.tls.empty-cn <tcm_configuration_reference_storage_etcd_tls_empty-cn>`
10711070
- :ref:`storage.etcd.permit-without-stream <tcm_configuration_reference_storage_etcd_permit-without-stream>`
10721071
- :ref:`storage.etcd.embed.enabled <tcm_configuration_reference_storage_etcd_embed>`
10731072
- :ref:`storage.etcd.embed.endpoints <tcm_configuration_reference_storage_etcd_embed>`
@@ -1123,7 +1122,7 @@ Tarantool storage parameters:
11231122
- :ref:`storage.tarantool.addr <tcm_configuration_reference_storage_tarantool_addr>`
11241123
- :ref:`storage.tarantool.auth <tcm_configuration_reference_storage_tarantool_timeout>`
11251124
- :ref:`storage.tarantool.reconnect <tcm_configuration_reference_storage_tarantool_reconnect>`
1126-
- :ref:`storage.tarantool.max_reconnect <tcm_configuration_reference_storage_tarantool_max_reconnect>`
1125+
- :ref:`storage.tarantool.max-reconnects <tcm_configuration_reference_storage_tarantool_max-reconnects>`
11271126
- :ref:`storage.tarantool.user <tcm_configuration_reference_storage_tarantool_user>`
11281127
- :ref:`storage.tarantool.pass <tcm_configuration_reference_storage_tarantool_pass>`
11291128
- :ref:`storage.tarantool.rate-limit <tcm_configuration_reference_storage_tarantool_rate-limit>`
@@ -1204,7 +1203,6 @@ Tarantool storage parameters:
12041203
| Default: 10s
12051204
| Environment variable: TCM_STORAGE_ETCD_DIAL_TIMEOUT
12061205
| Command-line option: ``--storage-etcd-dial-timeout``
1207-
``
12081206
12091207
.. _tcm_configuration_reference_storage_etcd_auto-sync-interval:
12101208

@@ -1458,6 +1456,18 @@ Tarantool storage parameters:
14581456
| Environment variable: TCM_STORAGE_ETCD_TLS_EMPTY_CN
14591457
| Command-line option: ``--storage-etcd-tls-empty-cn``
14601458
1459+
.. _tcm_configuration_reference_storage_etcd_permit-without-stream:
1460+
1461+
.. confval:: storage.etcd.permit-without-stream
1462+
1463+
Whether keepalive pings can be send to the etcd server without active streams.
1464+
1465+
|
1466+
| Type: bool
1467+
| Default: false
1468+
| Environment variable: TCM_STORAGE_ETCD_PERMIT_WITHOUT_STREAM
1469+
| Command-line option: ``--storage-etcd-permit-without-stream``
1470+
14611471
.. _tcm_configuration_reference_storage_etcd_embed:
14621472

14631473
storage.etcd.embed.*
@@ -1602,7 +1612,7 @@ etcd cluster is not available or not needed.
16021612

16031613
.. confval:: storage.tarantool.rate-limit-action
16041614

1605-
An action to perform when the :ref:`<tcm_configuration_reference_storage_tarantool_rate-limit>` is reached.
1615+
An action to perform when the :ref:`tcm_configuration_reference_storage_tarantool_rate-limit` is reached.
16061616

16071617
See also `go-tarantool.Opts <https://pkg.go.dev/github.com/tarantool/go-tarantool#Opts>`__.
16081618

@@ -1743,7 +1753,55 @@ etcd cluster is not available or not needed.
17431753
| Default: ""
17441754
| Environment variable: TCM_STORAGE_TARANTOOL_SSL_PASSWORD_FILE
17451755
| Command-line option: ``--storage-tarantool-ssl-password-file``
1746-
``
1756+
1757+
.. _tcm_configuration_reference_storage_tarantool_required-protocol-info_auth:
1758+
1759+
.. confval:: storage.tarantool.required-protocol-info.auth
1760+
1761+
An authentication method for the Tarantool |tcm| configuration storage.
1762+
1763+
Possible values are the Go's `go-tarantool/Auth <https://pkg.go.dev/github.com/tarantool/go-tarantool#Auth>`__ constants:
1764+
1765+
- ``AutoAuth`` (0)
1766+
- ``ChapSha1Auth``
1767+
- ``PapSha256Auth``
1768+
1769+
See also `go-tarantool.ProtocolInfo <https://pkg.go.dev/github.com/tarantool/go-tarantool#ProtocolInfo>`__.
1770+
1771+
|
1772+
| Type: int
1773+
| Default: 0
1774+
| Environment variable: TCM_STORAGE_TARANTOOL_SSL_REQUIRED_PROTOCOL_INFO_AUTH
1775+
| Command-line option: ``--storage-tarantool-required-protocol-info-auth``
1776+
1777+
.. _tcm_configuration_reference_storage_tarantool_required-protocol-info_version:
1778+
1779+
.. confval:: storage.tarantool.required-protocol-info.version
1780+
1781+
A Tarantool protocol version.
1782+
1783+
See also `go-tarantool.ProtocolInfo <https://pkg.go.dev/github.com/tarantool/go-tarantool#ProtocolInfo>`__.
1784+
1785+
|
1786+
| Type: uint64
1787+
| Default: 0
1788+
| Environment variable: TCM_STORAGE_TARANTOOL_SSL_REQUIRED_PROTOCOL_INFO_VERSION
1789+
| Command-line option: ``--storage-tarantool-required-protocol-info-version``
1790+
1791+
.. _tcm_configuration_reference_storage_tarantool_required-protocol-info_features:
1792+
1793+
.. confval:: storage.tarantool.required-protocol-info.features
1794+
1795+
An array of Tarantool protocol features.
1796+
1797+
See also `go-tarantool.ProtocolInfo <https://pkg.go.dev/github.com/tarantool/go-tarantool#ProtocolInfo>`__.
1798+
1799+
|
1800+
| Type: []int
1801+
| Default: []
1802+
| Environment variable: TCM_STORAGE_TARANTOOL_SSL_REQUIRED_PROTOCOL_INFO_FEATURES
1803+
| Command-line option: ``--storage-tarantool-required-protocol-info-features``
1804+
17471805
.. _tcm_configuration_reference_storage_tarantool_embed:
17481806

17491807
storage.tarantool.embed.*

0 commit comments

Comments
 (0)