Актуализировано для версии: 959b8f8d

Оригинал документа в репозитрии developers/backend

Служебные команды Атом.Порт

Общие сведения

Командный интерфейс бэкенда Атом.Порт предназначен для управления доступными системе сущностями, как правло хранящимися в базе данных. Ряд комманд принимает ключ --pk для указания уникального идентификатора той записи в базе данных, которую вы хотите изменить. Идентификаторы некоторых сущностей монжо можно узнать в графическом интерфейсе пользователя.

Команды вызываются из коммандной оболочки сервера следующим образом

charon КОМАНДА АРГУМЕНТЫ

Вызов любой команды с флагом (аргументом) --help выводит краткую инструкцию по команде и её опциям.

Обычно пользователю не требуется прибегать к коммандному интерфейсу. Следует учитывать, что использование перечисленных комманд требует аккуратности и может привести к нарушению работы системы.

Каждая команда описана в отдельном файле, список файлов можно получить, выполнив find charon -path '*/management/commands/*' | sort

Далее команды приводятся в разбивке по приложениям (модулям) бэкенда.

Автоматизации core_processes

ap_remove

Удаляет автоматизацию по идентификатору --pk. Команда запрашивает подтверждение.

graph_files_dump

charon graph_files_dump --output-dir PATH [--static-nodes] [--schema-version {1,2}] [--overwrite] [GRAPH ...]

Выгружает графы в YAML-файлы. По умолчанию выгружает все существующие в системе графы и статические узлы.

Принимаемые аргументы:

  • Позиционные аргументы — названия графов для выгрузки.
  • --output-dir — обязательно — директория, в которой будут сохранены файлы.
  • --overwrite — перезаписывать существующие файлы.
  • --static-nodes — выгрузить так же файл статических узлов static_nodes.yaml.
  • --schema-version — 1 или 2 — версия синтаксиса описаний графов для выгрузки в устаревшем формате, обычно не требуется.

graph_files_load

charon graph_files_load [--load-special] [--schema-version VERSION] [PATH ...]

Загужает графы из YAML-файлов. По умолчанию загружаются все графы из директории по умолчанию /srv/salt/graphs/, а так же файл статических узлов /srv/salt/graphs/static_nodes.yaml.

Принимаемые аргументы:

  • Позиционные аргументы — пути к файлом графов или директориям (рекурсивный поиск) для загрузки, если не указано — загружать всё по пути по умолчанию.
  • --static-nodes-file [PATH] — загружать так же файл статических узлов по умолчанию либо по пути PATH, если передан пользователем.
  • --schema-version — 1, 2 или auto — версия синтаксиса описаний графов для загрузки устаревших файлов, обычно не требуется.

Команда проверяет корректность загружаемых файлов и при первой ошибке завершает выполнение с указанием проблемы. В случае ошибки никакие изменения не будут применены.

sp_remove

Удаляет порождённый процесс по идентификатору --pk. Команда запрашивает подтверждение.

Правила автоматизацийcore_process_rules

process_rule_list

Выводит таблицу имеющихся в системе правил автоматизаций.

process_rule_load

Загружает правило автоматизации из файла описания. Единственный позиционный агрумент — путь к файлу.

process_rule_remove

Удаляет правило автоматизации по идентификатору --pk. Команда запрашивает подтверждение.

process_rule_list_retrieve

Выводит подробную информацию о правиле автоматизации, выбранном при помощи идентификатора --pk.

Справочные данные core_reference

load_ref_data

Загрузка референсной информации о моделях аппаратного обеспечения. Единственный позиционный аргумент — тип аппаратного ресурса: cpu, gpu, socket и all для обработки всех типов.

unload_ref_data

Выгрузка референсной информации о моделях аппаратного обеспечения. Единственный позиционный аргумент — тип аппаратного ресурса: cpu, gpu, socket и all для обработки всех типов.

Настройки приложения core_settings

settings_file_load

Функциональность перенесена из graphs_files_load

charon settings_file_load [PATH] [--overwrite]

Загружает файл настроек по пути /srv/salt/settings.yaml либо по пути PATH, переданному пользователем. Перезаписывает существующие в системе значения, если передан флаг --overwrite. Текущие значения доступны в интерфесе системы, в разделе Система -> Настройки.

rename_app

Служебная команда для переименование компонента сервера в базе данных. Может нарушить работу сервера.

Системные утилиты core_system

remove_stale

charon remove_stale [--days 30] [--force] [--dry-run] [TABLES ...]

Команда для удаления исторических данных. Затрагивает записи старше --days дней в таблицах tables (по умолчанию все поддерживаемые таблицы). См. список поддерживаемых таблица в справке по флагу --help.

Флаг --force отменяет запрос продтверждения от пользователя.

Флаг --dry-run вызывает вывод окончательного количества удаляемых записей, однако предотвращает реальное удалени из базы.

Системные службы core_units

load_units_manifest

Загружает в систему декларацию системных служб Атом.Порт для отоборажения их в интерфейсе пользователя. Единственный позиционный параметр указывает файл для загрузки.

Домены domains

pickle_domain

Сохраняет домен по идентификатору --pk в двоичный pickle-файл. Опционально принимает позиционный аргумент с путём конечного файла.

sync_domain

Сохраняет в систему объекты службы каталогов выбранного домена. Домен указывается в виде целочисленного идентификатора --domain.

unpickle_domain

Загружает домен из двоичного pickle-файла, передаваемого путём в виде позиционного аргумента.

Задачи salt_jobs

load_job_templates

charon load_job_templates [PATH] [--clear-old] [--confirm] [--overwrite]

Загружает шаблоны задач из файла в формате YAML. Опциональные принимаемы аргументы:

  • path — путь к файлу описания в формате YAML.
  • --clear-old — удалить существунющие шаблоны перед загрузкой.
  • --confirm — подтвердить операции.
  • --overwrite — перезаписывать существующие шаблоны.

Клиенты salt_minions

minion_remove

Удаляет миньон по идентификатору --pk. Команда запрашивает подтверждение.

mock_presence_status

charon mock_presence_status [--dry-run] [--days 14] [--skip 0.3]

Создаёт искуственную историю активности миньонов за последние --days дней (по умолчанию 14). Флаг --skip передаёт долю миньонов, для которых не будет создана история (по умолчанию 0.3, т. е. 30%). Флаг --dry-run запускает в «холостом режиме» (без запси изменений).

Модули SaltStack salt_modules

salt_module_load

Загрузить в базу данных документацию к функциям SaltStack.

salt_module_remove

Удалить из базы данных документацию к модулю SaltStack. Модуль указывается целочичленным идентификатором --pk.

Рабочие станции ws

ws_remove

Удаляет рабочую станцию по идентификатору --pk. При удалении рабочей станции будут удалены все связанные с ней миньоны, автоматизации, порождённые процессы и т. д. Перед удалением будет выведено дерево удаляемых сущностей и запрошено подтверждение.

ws_edit

Привязывает к рабочей станции миньон. Параметром --pk передаётся идентификатор рабочей станции. Далее опциональными аргументами соответственно типу миньона передаются идентификаторы миньонов:

  • --win_minion
  • --help_minion
  • --lin_minion

Допустимо указывать разные типы миньонов одновременно.

ws_create

Создаёт рабочии станции. Параметр --count укажет количество рабочих станции, которые будут созданы (по умолчанию 1). Параметр --mock, наполняет рабочие станции тестовыми данными и миньонами.

Last modified: Thursday, 11 April 2024, 2:42 PM