Обновлена 30 октября 2026 г. в 12:05

Переменные генератора инвентаря

В этом разделе приведены переменные, которые обрабатываются генератором инвентаря (plugins/new_generator/) и задаются в секции constants: инвентарного файла.

TCF

Переменные Tarantool Clusters Federation. Эти переменные читаются ролью tcf, но при использовании генератора инвентаря вычисляются автоматически, если не указаны пользователем в секции constants:. Полное описание опций — в разделе Переменные TCF.

Переменная	Описание
`tcf_gateway_alias`	Имя приложения для идентификации конкретного экземпляра Gateway. Если не задано — генератор формирует значение вида `gateway-{source}-{destination}-{index}`, где `{index}` дополняется нулями до двух знаков (например `-01`). Тип: `string`. Значение по умолчанию: `null` (вычисляется генератором).
`tcf_gateway_metrics_labels`	Пользовательские метки метрик Prometheus для репликаторов Gateway. Если не задано — генератор формирует метки `tcf_cluster`, `direction`, `component`, `instance`. Тип: `dict`. Значение по умолчанию: `{}` (вычисляется генератором).
`tcf_gateway_iproto_ssl_opts`	Параметры TLS для iproto-подключений Gateway к экземплярам хранения исходного кластера. Если не задано — генератор заполняет их из `tarantool_iproto_ssl_params` кластера-источника. Тип: `dictionary` или `list`. Значение по умолчанию: `null` (вычисляется генератором).
`tcf_gateway_clusters`	Конфигурация секции `gateway_clusters` в Gateway. Если не задано (и не задано `tcf_gateways`) — генератор строит структуру из зарегистрированных экземпляров Gateway. Тип: `object`. Значение по умолчанию: не задано (вычисляется генератором).
`tcf_gateways`	Список экземпляров Gateway — опция `destination.gateways`. Альтернатива `tcf_gateway_clusters`: если задано, секция `gateway_clusters` не строится генератором автоматически. Тип: `array`. Значение по умолчанию: `[]`.
`tcf_destination_alias`	Имя приложения для идентификации конкретного экземпляра Destination. Если не задано — генератор формирует значение вида `destination-{source}-{destination}-{index}`, где `{index}` дополняется нулями до двух знаков (например `-01`). Тип: `string`. Значение по умолчанию: `null` (вычисляется генератором).
`tcf_destination_metrics_labels`	Пользовательские метки метрик Prometheus для репликаторов Destination. Если не задано — генератор формирует метки `tcf_cluster`, `direction`, `component`, `instance`. Тип: `dict`. Значение по умолчанию: `{}` (вычисляется генератором).
`tcf_destination_shards`	Список шардов, закреплённых за данным Destination при масштабировании (параметр `scaling`). Если не задано — генератор использует подмножество шардов, назначенное компоненту. Тип: `array`. Значение по умолчанию: не задано (вычисляется генератором).

Переменная

Описание

tcf_gateway_alias

Имя приложения для идентификации конкретного экземпляра Gateway. Если не задано — генератор формирует значение вида gateway-{source}-{destination}-{index}, где {index} дополняется нулями до двух знаков (например -01). Тип: string. Значение по умолчанию: null (вычисляется генератором).

tcf_gateway_metrics_labels

Пользовательские метки метрик Prometheus для репликаторов Gateway. Если не задано — генератор формирует метки tcf_cluster, direction, component, instance. Тип: dict. Значение по умолчанию: {} (вычисляется генератором).

tcf_gateway_iproto_ssl_opts

Параметры TLS для iproto-подключений Gateway к экземплярам хранения исходного кластера. Если не задано — генератор заполняет их из tarantool_iproto_ssl_params кластера-источника. Тип: dictionary или list. Значение по умолчанию: null (вычисляется генератором).

tcf_gateway_clusters

Конфигурация секции gateway_clusters в Gateway. Если не задано (и не задано tcf_gateways) — генератор строит структуру из зарегистрированных экземпляров Gateway. Тип: object. Значение по умолчанию: не задано (вычисляется генератором).

tcf_gateways

Список экземпляров Gateway — опция destination.gateways. Альтернатива tcf_gateway_clusters: если задано, секция gateway_clusters не строится генератором автоматически. Тип: array. Значение по умолчанию: [].

tcf_destination_alias

Имя приложения для идентификации конкретного экземпляра Destination. Если не задано — генератор формирует значение вида destination-{source}-{destination}-{index}, где {index} дополняется нулями до двух знаков (например -01). Тип: string. Значение по умолчанию: null (вычисляется генератором).

tcf_destination_metrics_labels

Пользовательские метки метрик Prometheus для репликаторов Destination. Если не задано — генератор формирует метки tcf_cluster, direction, component, instance. Тип: dict. Значение по умолчанию: {} (вычисляется генератором).

tcf_destination_shards

Список шардов, закреплённых за данным Destination при масштабировании (параметр scaling). Если не задано — генератор использует подмножество шардов, назначенное компоненту. Тип: array. Значение по умолчанию: не задано (вычисляется генератором).

TCS

Переменные Tarantool Column Store. Потребляются только генератором при формировании топологии TCS 1.x и не являются переменными роли по умолчанию. Полное описание — в разделе «Переменные TCS».

Переменная	Описание
`tcs_v1_support`	Включить поддержку TCS 1.x. Установите значение `true`, если используется генератор инвентаря для установки TCS 1.x. Тип: `boolean`. Значение по умолчанию: `false`.
`tcs_http_enabled`	Включить поддержку http-запросов для TCS. Тип: `boolean`. Значение по умолчанию: `true`.
`tcs_http_credentials`	Учётные данные (`username`, `password`) для секции конфигурации `http.credentials` текущей роли экземпляра (`tcs_roles/storage` или `tcs_roles/scheduler`). Тип: `object`. Значение по умолчанию: не задано.
`tcs_sql_credentials`	Учётные данные (`username`, `password`) для секции конфигурации `arrow_flight_sql.credentials` текущей роли экземпляра (`tcs_roles/storage` или `tcs_roles/scheduler`). Тип: `object`. Значение по умолчанию: не задано.
`tcs_tls_cert_file`	Путь к файлу с TLS-сертификатом. Передаётся в секцию `tls_cert_file` текущей роли экземпляра (`tcs_roles/storage` или `tcs_roles/scheduler`). Тип: `string`. Значение по умолчанию: не задано.
`tcs_tls_key_file`	Путь к файлу с TLS-ключом. Передаётся в секцию `tls_key_file` текущей роли экземпляра (`tcs_roles/storage` или `tcs_roles/scheduler`). Тип: `string`. Значение по умолчанию: не задано.

Переменная

Описание

tcs_v1_support

Включить поддержку TCS 1.x. Установите значение true, если используется генератор инвентаря для установки TCS 1.x. Тип: boolean. Значение по умолчанию: false.

tcs_http_enabled

Включить поддержку http-запросов для TCS. Тип: boolean. Значение по умолчанию: true.

tcs_http_credentials

Учётные данные (username, password) для секции конфигурации http.credentials текущей роли экземпляра (tcs_roles/storage или tcs_roles/scheduler). Тип: object. Значение по умолчанию: не задано.

tcs_sql_credentials

Учётные данные (username, password) для секции конфигурации arrow_flight_sql.credentials текущей роли экземпляра (tcs_roles/storage или tcs_roles/scheduler). Тип: object. Значение по умолчанию: не задано.

tcs_tls_cert_file

Путь к файлу с TLS-сертификатом. Передаётся в секцию tls_cert_file текущей роли экземпляра (tcs_roles/storage или tcs_roles/scheduler). Тип: string. Значение по умолчанию: не задано.

tcs_tls_key_file

Путь к файлу с TLS-ключом. Передаётся в секцию tls_key_file текущей роли экземпляра (tcs_roles/storage или tcs_roles/scheduler). Тип: string. Значение по умолчанию: не задано.

TCM

Переменные Tarantool Cluster Manager. Задаются в секции constants: инвентаря и используются генератором при автоматическом формировании tcm_initial_clusters. Статического значения по умолчанию в роли нет. Полное описание — в разделе «Переменные TCM».

Переменная	Описание
`tcm_cluster_display_name`	Отображаемое имя кластера в веб-интерфейсе TCM. Если не задано — используется `cluster_name` из инвентаря. Тип: `string`. Значение по умолчанию: не задано (задаётся в `constants:` инвентаря).
`tcm_cluster_id`	Идентификатор кластера в TCM (UUID). Если не задано — TCM генерирует его автоматически при создании кластера. Тип: `string`. Значение по умолчанию: не задано (задаётся в `constants:` инвентаря).
`tcm_cluster_etcd_tls_skip_verify`	Пропуск проверки SSL-сертификата etcd кластера в подключении TCM → etcd кластера (через `initial_clusters`). Не влияет на экземпляры Tarantool. Тип: `boolean`. Значение по умолчанию: не задано (задаётся в `constants:` инвентаря; `false`).
`tcm_cluster_etcd_tls_skip_san_verify`	Пропуск проверки SAN в SSL-сертификате etcd кластера в подключении TCM → etcd кластера (через `initial_clusters`). Не влияет на экземпляры Tarantool. Тип: `boolean`. Значение по умолчанию: не задано (задаётся в `constants:` инвентаря; `false`).

Переменная

Описание

tcm_cluster_display_name

Отображаемое имя кластера в веб-интерфейсе TCM. Если не задано — используется cluster_name из инвентаря. Тип: string. Значение по умолчанию: не задано (задаётся в constants: инвентаря).

tcm_cluster_id

Идентификатор кластера в TCM (UUID). Если не задано — TCM генерирует его автоматически при создании кластера. Тип: string. Значение по умолчанию: не задано (задаётся в constants: инвентаря).

tcm_cluster_etcd_tls_skip_verify

Пропуск проверки SSL-сертификата etcd кластера в подключении TCM → etcd кластера (через initial_clusters). Не влияет на экземпляры Tarantool. Тип: boolean. Значение по умолчанию: не задано (задаётся в constants: инвентаря; false).

tcm_cluster_etcd_tls_skip_san_verify

Пропуск проверки SAN в SSL-сертификате etcd кластера в подключении TCM → etcd кластера (через initial_clusters). Не влияет на экземпляры Tarantool. Тип: boolean. Значение по умолчанию: не задано (задаётся в constants: инвентаря; false).

Tarantool / TDB

Глобальные переменные Tarantool, которые генератор потребляет из секции constants: для автоматического построения секций конфигурации экземпляров (iproto, roles.httpd). Эти переменные являются общими (см. раздел «Глобальные переменные») и здесь указаны в контексте их потребления генератором.

Переменная	Описание
`tarantool_iproto_ssl_params`	Параметры SSL для iproto-подключений. Генератор помещает их в `iproto.listen.params` конфигурации экземпляра. Тип: `dict`. Значение по умолчанию: `{}`.
`tarantool_httpd_ssl_params`	Параметры SSL для HTTP-подключений. Генератор помещает их в секцию `roles.httpd.default` конфигурации экземпляра. Тип: `dict`. Значение по умолчанию: `{}`.

Переменная

Описание

tarantool_iproto_ssl_params

Параметры SSL для iproto-подключений. Генератор помещает их в iproto.listen.params конфигурации экземпляра. Тип: dict. Значение по умолчанию: {}.

tarantool_httpd_ssl_params

Параметры SSL для HTTP-подключений. Генератор помещает их в секцию roles.httpd.default конфигурации экземпляра. Тип: dict. Значение по умолчанию: {}.

Была ли статья полезна?

Содержание

Была ли статья полезна?