VK Docs logo
Помощь
Обновлена 27 января 2026 г. в 19:56

Переменные TCS

В этом разделе приведены переменные окружения для роли tcs. Роль определяет настройки продукта Tarantool Column Store.

Управление правами доступа

Переменная

Описание

tcs_dir_mode

Права доступа на каталоги компонента Scheduler для TCS 0.х. Тип: string. Значение по умолчанию: "{{ tarantool_dir_mode | default('0750') }}".

tcs_file_mode

Права доступа на конфигурационные файлы компонента Scheduler для TCS 0.х. Тип: string. Значение по умолчанию: "{{ tarantool_file_mode | default('0644') }}".

Общие настройки

Переменная

Описание

tcs_package_dir

Полный путь к архиву с пакетом установки компонента Scheduler для TCS 0.х. Тип: string. Значение по умолчанию: "{{ cartridge_app_install_dir }}/{{ cartridge_package_path | basename | split('.tar.gz') | first }}".

tcs_v1_support

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

tcs_http_credentials

Имя пользователя (username) и пароль (password) для секции конфигурации roles_cfg.tcs_roles/storage.http.credentials, если используется динамический инвентарь для установки TCS 1.x. Применяется для экземпляров хранилища (storage). Доступно с версии 1.12.0. Тип: object.

tcs_sql_credentials

Имя пользователя (username) и пароль (password) для секции конфигурации roles_cfg.tcs_roles/storage.arrow_flight_sql.credentials, если используется динамический инвентарь для установки TCS 1.x. Применяется для экземпляров хранилища (storage). Доступно с версии 1.12.0. Тип: object.

tcs_http_enabled

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

cartridge_app_user

Пользователь приложения. Тип: string. Значение по умолчанию: tarantool.

cartridge_app_group

Группа приложения. Тип: string. Значение по умолчанию: tarantool.

cartridge_app_install_dir

Путь к директории, в которой хранятся установленные версии (дистрибутивы) Cartridge-приложения. Тип: string. Значение по умолчанию: "/app/tarantool/{{ cartridge_app_name }}/dist".

Конфигурация компонента Scheduler для TCS 0.x

Переменная

Описание

tcs_scheduler_bin_directory

Путь к директории, в которой хранятся ссылки (symlink) на распакованные файлы для каждого экземпляра Scheduler. Тип: string. Значение по умолчанию: "/app/tarantool/{{ cartridge_app_name }}/bin".

tcs_scheduler_instance_directory

Путь к директории с файлами экземпляров Scheduler, запущенных на этом хосте. Тип: string. Значение по умолчанию: "{{ tcs_scheduler_bin_directory }}/{{ cartridge_app_name }}.{{ inventory_hostname }}".

tcs_scheduler_binary_name

Путь к бинарному файлу компонента Scheduler относительно распакованного архива с поставкой TCS. Тип: string. Значение по умолчанию: "bin/scheduler".

tcs_scheduler_config_directory

Путь к директории с файлом конфигурации компонентов Scheduler, которые запущены на данном хосте. Тип: string. Значение по умолчанию: "/app/tarantool/{{ cartridge_app_name }}/etc/conf.d/scheduler".

tcs_scheduler_config_name

Путь к файлу конфигурации компонента Scheduler, который запущен на данном хосте. Тип: string. Значение по умолчанию: "scheduler-{{ inventory_hostname }}.yml".

tcs_scheduler_config_path

Полный путь к конфигурации компонента Scheduler (директория и имя файла). Тип: string. Значение по умолчанию: "{{ tcs_scheduler_config_directory }}/{{ tcs_scheduler_config_name }}".

tcs_scheduler_service_unit_name

Имя systemd-юнита, которое используется для создания systemd-сервиса Scheduler. Тип: string. Значение по умолчанию: "{{ cartridge_app_name }}-scheduler@{{ inventory_hostname }}.service".

tcs_scheduler_service_dir

Имя поддиректории для переопределения директив из systemd-юнита, указанного в переменной tcs_scheduler_service_unit_name. Тип: string. Значение по умолчанию: "{{ tcs_scheduler_service_unit_name }}.d".

tcs_scheduler_service_env_file

Полный путь к файлу с переменными окружения для сервиса Scheduler. Тип: string. Значение по умолчанию: "{{ tcs_scheduler_service_dir }}/env.conf".

tcs_scheduler_metrics_enabled

Включить передачу метрик с компонента Scheduler. Доступно с версии 1.10.0. Тип: boolean. Значение по умолчанию: false.

tcs_scheduler_features_enabled

Включить использование дополнительных возможностей (параметра features) компонента Scheduler. Доступно с версии 1.10.0. Тип: boolean. Значение по умолчанию: false.

tcs_scheduler_features

Дополнительные возможности, которые должны быть активированы у компонента Scheduler. Поддерживается только для TCS 0.x настройки ["sharding_api"]. Доступно с версии 1.10.0. Тип: object. Значение по умолчанию: [].

tcs_extra_env

Словарь переменных окружения, которые будут добавлены в сервис компонента Scheduler. Тип: array. Значение по умолчанию: null.

tcs_additional_config

Дополнительные опции конфигурации, которые автоматически добавляются в конец сгенерированной YAML-конфигурации компонента Scheduler. Поддерживаются словарь или список (mapping/sequence), которые сериализуются в YAML. Доступно с версии 1.14.0. Тип: object.

tcs_scheduler_config_template

Путь к Jinja2-шаблону на контроллере, который полностью заменяет встроенный шаблон конфигурации компонента Scheduler. Если переменная задана, роль использует указанный файл вместо roles/tcs/templates/tcs-scheduler-config.yml.j2. Доступно с версии 1.14.0. Тип: string.

tcs_scheduler_etcd_endpoints

Список узлов централизованного хранилища конфигурации etcd. Тип: string. Значение по умолчанию: "{{ tarantool_config_etcd_endpoints | default(['http://' + tarantool_etcd_host + ':' + '2379']) }}".

tcs_scheduler_http_credentials

Имя пользователя (username) и пароль (password) для секции конфигурации roles_cfg.tcs_roles/scheduler.http.credentials, если используется динамический инвентарь для установки TCS 1.x. В TCS 1.0 применяется для экземпляров хранилища (storage), а с версии TCS 1.1 — для экземпляров хранилища и Scheduler. Доступно с версии 1.12.0. Тип: object.

tcs_scheduler_sql_credentials

Имя пользователя (username) и пароль (password) для секции конфигурации roles_cfg.tcs_roles/scheduler.arrow_flight_sql.credentials, если используется динамический инвентарь для установки TCS 1.x. В TCS 1.0 применяется для экземпляров хранилища (storage), а с версии TCS 1.1 — для экземпляров хранилища и Scheduler. Доступно с версии 1.12.0. Тип: object.

Конфигурация экземпляров хранилища

Переменная

Описание

tcs_storage_group_name

Название группы, в которую может входить несколько наборов реплик с экземплярами хранилища. Тип: string. Значение по умолчанию: "aggregators".

tcs_storage_replicaset_name

Название набора реплик с экземплярами хранилища. Тип: string.

Настройка TLS-соединения

Переменная

Описание

tcs_tls_cert_file

Путь к существующему на целевой машине файлу с TLS-сертификатом для работы с TCS 1.1.0 и выше. Будет передан в секцию конфигурации tcs_roles/storage.tcs_cert_file для экземпляров хранилища и tcs_roles/scheduler.tls_cert_file для экземпляров Scheduler. Доступно с версии 1.15.0. Тип: string.

tcs_tls_key_file

Путь к существующему на целевой машине файлу с TLS-ключом для работы с TCS 1.1.0 и выше. Будет передан в секцию конфигурации tcs_roles/storage.tcs_key_file для экземпляров хранилища и tcs_roles/scheduler.tls_key_file для экземпляров Scheduler. Доступно с версии 1.15.0. Тип: string.