Timetta CLI

Обновлено: 23.06.2026

Timetta.Presentation.Cli — служебная консольная утилита для первоначальной настройки, обновления и диагностики on-premises-инсталляции Timetta.

Основной сценарий использования — запуск в Docker Compose или в виде Kubernetes Job перед запуском сервисов Timetta.

КонфигурацияКонфигурация

CLI использует те же настройки, что и остальные сервисы Timetta. Рекомендуется подключать к нему общую конфигурацию инсталляции, описанную в отдельной статье, а не создавать отдельный набор настроек.

Для работы CLI необходимы:

• строка подключения TimettaDB;
• строка подключения SchedulerDB;
• строка подключения к Redis, если Redis используется;
• LicenseKey;
• конфигурация Tenant.

Лицензия проверяется перед выполнением каждой команды. Проверяются корректность ключа, соответствие домена конфигурации tenant и срок действия лицензии.

Пароли и лицензионный ключ не выводятся в диагностические сообщения.

ЗапускЗапуск

Общий формат:

tmt <command>

В Docker-образе уже настроен entrypoint, поэтому контейнеру передаётся только команда:

docker compose run --rm admin-cli <command>

КомандыКоманды

initinit

Инициализирует новую пустую базу данных.

Последовательно выполняет:

1. Проверку, что схема public пуста.
2. Создание начальной структуры базы.
3. Применение всех миграций.
4. Заполнение системных данных.
5. Развёртывание стандартных данных Timetta.

tmt init

Если база уже содержит таблицы, команда завершается с ошибкой. Для обновления существующей базы следует использовать migrate.

migratemigrate

Применяет ожидающие миграции к существующей базе данных.

tmt migrate

Команда:

• не очищает базу;
• не выполняет повторную инициализацию;
• не разворачивает стандартные данные;
• успешно завершается, если новых миграций нет.

Для пустой базы необходимо использовать init.

statusstatus

Проверяет конфигурацию и доступность инфраструктуры.

tmt status

Команда выводит:

• версию CLI;
• основной домен и язык tenant;
• адрес PostgreSQL без пароля;
• доступность и версию PostgreSQL;
• имя базы и пользователя;
• состояние базы;
• последнюю применённую миграцию;
• количество применённых и ожидающих миграций;
• доступность Redis, если он настроен;
• итоговый статус Healthy или Unhealthy.

При ошибке подключения выводятся тип исключения, сообщение и цепочка внутренних причин.

Если обязательная инфраструктура недоступна, команда возвращает код 1.

versionversion

Выводит версию CLI:

tmt version

Перед выполнением также проверяется лицензия.

reset --forcereset --force

Полностью удаляет схему public, создаёт её заново и выполняет полную инициализацию:

tmt reset --force

Команда выполняет:

1. Удаление всех объектов схемы public.
2. Повторное создание схемы.
3. Создание начальной структуры базы.
4. Применение миграций.
5. Заполнение системных данных.
6. Развёртывание стандартных данных.

Команду не следует включать в автоматический production-процесс.

Коды завершенияКоды завершения

• 0 — команда успешно выполнена;
• 1 — ошибка выполнения, лицензии или инфраструктуры;
• 2 — неизвестная команда или некорректные аргументы.

Docker ComposeDocker Compose

CLI следует подключать к той же общей конфигурации и секретам, что и остальные сервисы Timetta.

  admin-cli:
    container_name: admin-cli
    image: cr.yandex/crpr8bvek949tq2fuqkf/admin-cli:${BACKEND_IMAGE_TAG}
    <<: *app-config
    configs:
      - source: app_settings
        target: /app/secrets/settings.json

Для первоначальной установки:

command: ["init"]

Для диагностики:

command: ["status"]

Для миграции данных:

command: ["migrate"]

Запуск:

docker compose run --rm admin-cli <command>

Kubernetes JobKubernetes Job

Пример Job для применения миграций:

apiVersion: batch/v1
kind: Job
metadata:
  name: timetta-migrate
spec:
  backoffLimit: 2
  template:
    spec:
      restartPolicy: Never
      containers:
        - name: migrate
          image: registry.example.com/timetta/admin-cli:1.0.0
          args: ["migrate"]
          envFrom:
            - configMapRef:
                name: timetta-config
            - secretRef:
                name: timetta-secrets

Образ содержит entrypoint dotnet tmt.dll, поэтому команда CLI передаётся через args.

Для первоначальной установки используется:

args: ["init"]

CLI должен получать ту же конфигурацию и те же secrets, что и остальные сервисы Timetta.

Рекомендуемый процесс развёртыванияРекомендуемый процесс развёртывания

Новая установка:

Создать инфраструктуру → init → запустить сервисы Timetta

Обновление:

Создать резервную копию → migrate → запустить новую версию сервисов

init предназначен только для пустой базы. Для всех последующих обновлений используется migrate.