diff --git a/doc/reference/tooling/tcm/tcm_configuration_reference.rst b/doc/reference/tooling/tcm/tcm_configuration_reference.rst index ea652ff4c8..724a3d2ff8 100644 --- a/doc/reference/tooling/tcm/tcm_configuration_reference.rst +++ b/doc/reference/tooling/tcm/tcm_configuration_reference.rst @@ -28,22 +28,16 @@ cluster The ``cluster`` group defines parameters of |tcm| interaction with connected Tarantool clusters. -- :ref:`on-air-limit ` - :ref:`connection-rate-limit ` - :ref:`tarantool-timeout ` - :ref:`tarantool-ping-timeout ` - -.. _tcm_configuration_reference_cluster_on-air-limit: - -.. confval:: cluster.on-air-limit - - The maximum number of on-air requests from |tcm| to all connected clusters. - - | - | Type: int64 - | Default: 4096 - | Environment variable: TCM_CLUSTER_ON_AIR_LIMIT - | Command-line option: ``--cluster.on-air-limit`` +- :ref:`tt-command ` +- :ref:`refresh-state-period ` +- :ref:`refresh-state-timeout ` +- :ref:`discovery-period ` +- :ref:`sharding-index ` +- :ref:`skew-time ` +- :ref:`fragmentation-threshold ` .. _tcm_configuration_reference_cluster_connection-rate-limit: @@ -81,6 +75,95 @@ Tarantool clusters. | Environment variable: TCM_CLUSTER_TARANTOOL_PING_TIMEOUT | Command-line option: ``--cluster.tarantool-ping-timeout`` +.. _tcm_configuration_reference_cluster_tt-command: + +.. confval:: cluster.tt-command + + The command that runs the :ref:`tt ` utility on hosts with cluster instances. + + | + | Type: string + | Default: `tt` + | Environment variable: TCM_CLUSTER_TT_COMMAND + | Command-line option: ``--cluster.tt-command`` + +.. _tcm_configuration_reference_cluster_refresh-state-period: + +.. confval:: cluster.refresh-state-period + + The time interval for refreshing the cluster instances state on the Stateboard. + + | + | Type: time.Duration + | Default: 5s + | Environment variable: TCM_CLUSTER_REFRESH_STATE_PERIOD + | Command-line option: ``--cluster.refresh-state-period`` + +.. _tcm_configuration_reference_cluster_refresh-state-timeout: + +.. confval:: cluster.refresh-state-timeout + + The time limit for refreshing an instance state. + If this limit is reached, an error is shown. + + | + | Type: time.Duration + | Default: 4s + | Environment variable: TCM_CLUSTER_REFRESH_STATE_TIMEOUT + | Command-line option: ``--cluster.refresh-state-timeout`` + +.. _tcm_configuration_reference_cluster_discovery-period: + +.. confval:: cluster.discovery-period + + The time interval for checking the leadership in replica sets. + + | + | Type: time.Duration + | Default: 4s + | Environment variable: TCM_CLUSTER_DISCOVERY_PERIOD + | Command-line option: ``--cluster.discovery-period`` + +.. _tcm_configuration_reference_cluster_sharding-index: + +.. confval:: cluster.sharding-index + + The name of the space field that is used as a sharding key. + + | + | Type: String + | Default: `bucket_id` + | Environment variable: TCM_CLUSTER_SHARDING_INDEX + | Command-line option: ``--cluster.sharding-index`` + +.. _tcm_configuration_reference_cluster_skew-time: + +.. confval:: cluster.skew-time + + The maximum time skew between any two cluster instances. + If this limit is reached, a warning is shown. + + | + | Type: time.Duration + | Default: 30s + | Environment variable: TCM_CLUSTER_SKEW_TIME + | Command-line option: ``--cluster.skew-time`` + +.. _tcm_configuration_reference_cluster_fragmentation-threshold: + +.. confval:: cluster.fragmentation-threshold + + The count of allocated slabs that reflects high memory fragmentation. + When this number is reached, a warning is shown. + + See also: :ref:`engines-memtx` + + | + | Type: int + | Default: 40 + | Environment variable: TCM_CLUSTER_FRAGMENTATION_THRESHOLD + | Command-line option: ``--cluster.fragmentation-threshold`` + .. _tcm_configuration_reference_http: http @@ -88,7 +171,6 @@ http The ``http`` group defines parameters of HTTP connections between |tcm| and clients. -- :ref:`http.basic_auth.enabled ` - :ref:`http.network ` - :ref:`http.host ` - :ref:`http.port ` @@ -112,7 +194,6 @@ The ``http`` group defines parameters of HTTP connections between |tcm| and clie - :ref:`http.cors.exposed-headers ` - :ref:`http.cors.allow-credentials ` - :ref:`http.cors.debug ` -- :ref:`http.metrics-endpoint ` - :ref:`http.tls.enabled ` - :ref:`http.tls.cert-file ` - :ref:`http.tls.key-file ` @@ -125,7 +206,6 @@ The ``http`` group defines parameters of HTTP connections between |tcm| and clie - :ref:`http.read-header-timeout ` - :ref:`http.write-timeout ` - :ref:`http.idle-timeout ` -- :ref:`http.idle-timeout ` - :ref:`http.disable-general-options-handler ` - :ref:`http.max-header-bytes ` - :ref:`http.api-timeout ` @@ -137,18 +217,6 @@ The ``http`` group defines parameters of HTTP connections between |tcm| and clie - :ref:`http.graphql.complexity ` -.. _tcm_configuration_reference_http_basic-auth_enabled: - -.. confval:: http.basic_auth.enabled - - Whether to use the `HTTP basic authentication `__. - - | - | Type: bool - | Default: false - | Environment variable: TCM_HTTP_BASIC_AUTH_ENABLED - | Command-line option: ``--http.basic-auth-enabled`` - .. _tcm_configuration_reference_http_network: .. confval:: http.network @@ -491,18 +559,6 @@ The ``http`` group defines parameters of HTTP connections between |tcm| and clie | Type: bool | Default: false -.. _tcm_configuration_reference_http_metrics-endpoint: - -.. confval:: http.metrics-endpoint - - The HTTP endpoint for |tcm| metrics in the `Prometheus `__ format. - - | - | Type: string - | Default: /metrics - | Environment variable: TCM_HTTP_METRICS_ENDPOINT - | Command-line option: ``--http.metrics-endpoint`` - .. _tcm_configuration_reference_http_tls_enabled: .. confval:: http.tls.enabled @@ -543,7 +599,7 @@ The ``http`` group defines parameters of HTTP connections between |tcm| and clie .. confval:: http.tls.server - The TSL server. + The TLS server. | | Type: string @@ -1056,6 +1112,7 @@ etcd storage parameters: - :ref:`storage.etcd.max-call-send-msg-size ` - :ref:`storage.etcd.username ` - :ref:`storage.etcd.password ` +- :ref:`storage.etcd.password-file ` - :ref:`storage.etcd.tls.enabled ` - :ref:`storage.etcd.tls.auto ` - :ref:`storage.etcd.tls.cert-file ` @@ -1123,11 +1180,14 @@ Tarantool storage parameters: - :ref:`storage.tarantool.prefix ` - :ref:`storage.tarantool.addr ` -- :ref:`storage.tarantool.auth ` +- :ref:`storage.tarantool.addrs ` +- :ref:`storage.tarantool.auth ` +- :ref:`storage.tarantool.timeout ` - :ref:`storage.tarantool.reconnect ` - :ref:`storage.tarantool.max-reconnects ` -- :ref:`storage.tarantool.user ` -- :ref:`storage.tarantool.pass ` +- :ref:`storage.tarantool.username ` +- :ref:`storage.tarantool.password ` +- :ref:`storage.tarantool.password-file ` - :ref:`storage.tarantool.rate-limit ` - :ref:`storage.tarantool.rate-limit-action ` - :ref:`storage.tarantool.concurrency ` @@ -1138,6 +1198,7 @@ Tarantool storage parameters: - :ref:`storage.tarantool.ssl.ca-file ` - :ref:`storage.tarantool.ssl.ciphers ` - :ref:`storage.tarantool.ssl.password ` +- :ref:`storage.tarantool.ssl.password-file ` - :ref:`storage.tarantool.required-protocol-info.auth ` - :ref:`storage.tarantool.required-protocol-info.version ` - :ref:`storage.tarantool.required-protocol-info.features ` @@ -1290,6 +1351,18 @@ Tarantool storage parameters: | Environment variable: TCM_STORAGE_ETCD_PASSWORD | Command-line option: ``--storage.etcd.password`` +.. _tcm_configuration_reference_storage_etcd_password-file: + +.. confval:: storage.etcd.password-file + + A path to the file with a password for accessing the etcd storage. + + | + | Type: string + | Default: "" + | Environment variable: TCM_STORAGE_ETCD_PASSWORD-FILE + | Command-line option: ``--storage.etcd.password-file`` + .. _tcm_configuration_reference_storage_etcd_tls_enabled: .. confval:: storage.etcd.tls.enabled @@ -1485,7 +1558,7 @@ etcd cluster is not available or not needed. .. confval:: storage.tarantool.prefix - A prefix for the TCM configuration parameters in the Tarantool |tcm| configuration storage. + A prefix for the |tcm| configuration parameters in the Tarantool-based configuration storage. | | Type: string @@ -1498,7 +1571,7 @@ etcd cluster is not available or not needed. .. confval:: storage.tarantool.addr - The URI for connecting to the Tarantool |tcm| configuration storage. + The URI for connecting to the Tarantool-based configuration storage. | | Type: string @@ -1506,12 +1579,24 @@ etcd cluster is not available or not needed. | Environment variable: TCM_STORAGE_TARANTOOL_ADDR | Command-line option: ``--storage.tarantool.addr`` +.. _tcm_configuration_reference_storage_tarantool_addrs: + +.. confval:: storage.tarantool.addrs + + An array of the Tarantool-based configuration storage URIs. + + | + | Type: []string + | Default: ["unix/:/tmp/tnt_config_instance.sock"] + | Environment variable: TCM_STORAGE_TARANTOOL_ADDRS + | Command-line option: ``--storage.tarantool.addrs`` + .. _tcm_configuration_reference_storage_tarantool_auth: .. confval:: storage.tarantool.auth - An authentication method for the Tarantool |tcm| configuration storage. + An authentication method for the Tarantool-based configuration storage. Possible values are the Go's `go-tarantool/Auth `__ constants: @@ -1530,7 +1615,7 @@ etcd cluster is not available or not needed. .. confval:: storage.tarantool.timeout - A request timeout for the Tarantool |tcm| configuration storage. + A request timeout for the Tarantool-based configuration storage. See also `go-tarantool.Opts `__. @@ -1544,7 +1629,7 @@ etcd cluster is not available or not needed. .. confval:: storage.tarantool.reconnect - A timeout between reconnect attempts for the Tarantool |tcm| configuration storage. + A timeout between reconnect attempts for the Tarantool-based configuration storage. See also `go-tarantool.Opts `__. @@ -1558,7 +1643,7 @@ etcd cluster is not available or not needed. .. confval:: storage.tarantool.max-reconnects - The maximum number of reconnect attempts for the Tarantool |tcm| configuration storage. + The maximum number of reconnect attempts for the Tarantool-based configuration storage. See also `go-tarantool.Opts `__. @@ -1569,10 +1654,11 @@ etcd cluster is not available or not needed. | Command-line option: ``--storage.tarantool.max-reconnects`` .. _tcm_configuration_reference_storage_tarantool_user: +.. _tcm_configuration_reference_storage_tarantool_username: -.. confval:: storage.tarantool.user +.. confval:: storage.tarantool.username - A username for connecting to the Tarantool |tcm| configuration storage. + A username for connecting to the Tarantool-based configuration storage. See also `go-tarantool.Opts `__. @@ -1580,13 +1666,14 @@ etcd cluster is not available or not needed. | Type: string | Default: "" | Environment variable: TCM_STORAGE_TARANTOOL_USER - | Command-line option: ``--storage.tarantool.user`` + | Command-line option: ``--storage.tarantool.username`` .. _tcm_configuration_reference_storage_tarantool_pass: +.. _tcm_configuration_reference_storage_tarantool_password: -.. confval:: storage.tarantool.pass +.. confval:: storage.tarantool.password - A password for connecting to the Tarantool |tcm| configuration storage. + A password for connecting to the Tarantool-based configuration storage. See also `go-tarantool.Opts `__. @@ -1594,13 +1681,25 @@ etcd cluster is not available or not needed. | Type: string | Default: "" | Environment variable: TCM_STORAGE_TARANTOOL_PASS - | Command-line option: ``--storage.tarantool.pass`` + | Command-line option: ``--storage.tarantool.password`` + +.. _tcm_configuration_reference_storage_tarantool_password-file: + +.. confval:: storage.tarantool.password-file + + A path to the file with a password for connecting to the Tarantool-based configuration storage. + + | + | Type: string + | Default: "" + | Environment variable: TCM_STORAGE_TARANTOOL_PASSWORD-FILE + | Command-line option: ``--storage.tarantool.password-file`` .. _tcm_configuration_reference_storage_tarantool_rate-limit: .. confval:: storage.tarantool.rate-limit - A rate limit for connecting to the Tarantool |tcm| configuration storage. + A rate limit for connecting to the Tarantool-based configuration storage. See also `go-tarantool.Opts `__. @@ -1890,6 +1989,7 @@ between them. - :ref:`limits.users-count ` - :ref:`limits.clusters-count ` - :ref:`limits.roles-count ` +- :ref:`limits.webhooks-count ` - :ref:`limits.user-secrets-count ` - :ref:`limits.user-websessions-count ` - :ref:`limits.linked-cluster-users ` @@ -1930,6 +2030,18 @@ between them. | Environment variable: TCM_LIMITS_ROLES_COUNT | Command-line option: ``--limits.roles-count`` +.. _tcm_configuration_reference_limits_webhooks-count: + +.. confval:: limits.webhooks-count + + The maximum number of webhooks in |tcm|. + + | + | Type: int + | Default: 200 + | Environment variable: TCM_LIMITS_WEBHOOKS_COUNT + | Command-line option: ``--limits.webhooks-count`` + .. _tcm_configuration_reference_limits_user-secrets-count: .. confval:: limits.user-secrets-count @@ -1979,8 +2091,9 @@ The ``security`` section defines the security parameters of |tcm|. - :ref:`security.auth ` - :ref:`security.hash-cost ` - :ref:`security.encryption-key ` -- :ref:`security.encryption-key-file ` +- :ref:`security.encryption-key-file ` - :ref:`security.bootstrap-password ` +- :ref:`security.bootstrap-api-token ` - :ref:`security.integrity-check ` - :ref:`security.signature-private-key-file ` @@ -2043,8 +2156,7 @@ The ``security`` section defines the security parameters of |tcm|. .. confval:: security.bootstrap-password - A password for the first login of the ``admin`` user. Must be changed after the - successful login. Only for testing purposes. + A password for the first login of the ``admin`` user. Only for testing purposes. | | Type: string @@ -2052,19 +2164,19 @@ The ``security`` section defines the security parameters of |tcm|. | Environment variable: TCM_SECURITY_BOOTSTRAP_PASSWORD | Command-line option: ``--security.bootstrap-password`` -.. _tcm_configuration_security_signature-private-key-file: +.. _tcm_configuration_reference_security_bootstrap-api-token: -.. confval:: security.signature-private-key-file +.. confval:: security.bootstrap-api-token - A path to a file with the private key to sign |tcm| data. + A default API token for the ``admin`` user. Only for testing purposes. | | Type: string | Default: "" - | Environment variable: TCM_SECURITY_SIGNATURE_PRIVATE_KEY_FILE - | Command-line option: ``--security.signature-private-key-file`` + | Environment variable: TCM_SECURITY_BOOTSTRAP_API_TOKEN + | Command-line option: ``--security.bootstrap-api-token`` -.. _tcm_configuration_security_integrity-check: +.. _tcm_configuration_reference_security_integrity-check: .. confval:: security.integrity-check @@ -2077,6 +2189,18 @@ The ``security`` section defines the security parameters of |tcm|. | Environment variable: TCM_SECURITY_INTEGRITY_CHECK | Command-line option: ``--security.integrity-check`` +.. _tcm_configuration_reference_security_signature-private-key-file: + +.. confval:: security.signature-private-key-file + + A path to a file with the private key to sign |tcm| data. + + | + | Type: string + | Default: "" + | Environment variable: TCM_SECURITY_SIGNATURE_PRIVATE_KEY_FILE + | Command-line option: ``--security.signature-private-key-file`` + .. mode .. _tcm_configuration_reference_mode: @@ -2094,3 +2218,41 @@ mode | Environment variable: TCM_MODE | Command-line option: ``--mode`` + +.. feature + +.. _tcm_configuration_reference_feature: + +feature +------- + + +The ``feature`` section defines the security parameters of |tcm|. + +- :ref:`feature.ttgraph ` +- :ref:`feature.column-store ` + + +.. _tcm_configuration_reference_feature_ttgraph: + +.. confval:: feature.ttgraph + + Whether Tarantool Graph DB integration is enabled. + + | + | Type: bool + | Default: false + | Environment variable: TCM_FEATURE_TTGRAPH + | Command-line option: ``--feature.ttgraph`` + +.. _tcm_configuration_reference_feature_column-store: + +.. confval:: feature.column-store + + Whether Tarantool Column Store integration is enabled. + + | + | Type: bool + | Default: false + | Environment variable: TCM_FEATURE_COLUMN_STORE + | Command-line option: ``--feature.column-store`` \ No newline at end of file