aa-setup

aa-setup#

Утилита aa-setup используется для развертывания платформы и предоставляет различные возможности по управлению ею.

Назначение#

Утилита aa-setup выполняет следующие действия:

  • развертывает платформу в виде нескольких связанных компонентов;

  • обновляет версии и структуру компонентов платформы;

  • выполняет резервное копирование и восстановление базы данных;

  • генерирует и распространяет секретный ключ;

  • проверяет версии Astra Automation, доступные в репозитории;

  • удаляет Astra Automation.

Установка и запуск#

Для установки утилиты aa-setup выполните следующие действия:

  1. В каталоге /etc/apt/sources.list.d/ создайте файл astra-automation.list со ссылкой на репозиторий Astra Automation:

    deb https://dl.astralinux.ru/aa/aa-debs-for-alse-1.8 <version> main

    Вместо <version> необходимо подставить версию устанавливаемой платформы, например, 2.0.

    Доступные версии продукта опубликованы в таблице История обновлений.

  2. Обновите список доступных пакетов:

    sudo apt update

  3. Выполните команду установки:

    sudo apt install astra-automation-setup --yes

Описание аргументов#

Запустить утилиту можно в каталоге /opt/rbta/aa/astra-automation-setup/ со следующими аргументами:

-h, --help#

Выводит информацию о доступных опциях и соответствующих аргументах.

-p <log_path>, --log-path <log_path>#

Путь к альтернативному каталогу для сохранения журнала установки. Текущий пользователь должен иметь привилегию на создание файлов и запись в этом каталоге.

Значение по умолчанию: ./ (текущий каталог).

-k, --generate-key#

Генерирует и распространяет новый секретный ключ, используемый для выполнения следующих задач:

  • шифрование данных пользовательских сессий;

  • генерация токенов для паролей;

  • защита данных контроллера.

-b, --backup#

Сохраняет в виде резервной копии данные, необходимые для полного восстановления платформы на узлах, описанных в инвентаре установщика.

-r, --restore#

Использует резервную копию данных для восстановления платформы на узлах, описанных в инвентаре установщика.

-d, --debug#

Включает режим отладки для более подробного вывода информации о процессе.

-u, --uninstall#

Запускает процесс удаления компонентов Astra Automation, перечисленных в файле инвентаризации.

-y, --force-yes#

Ключ отключает запрос на подтверждение выполнения операции, подразумевая, что ответ всегда Да (Yes).

--force-postgres-removal#

Запускает процесс удаления PostgreSQL.

--plain#

Отключает расширенный вариант текстового пользовательского интерфейса.

--repo-url <repo_url>#

URL репозитория с пакетами Astra Automation.

Эта настройка может быть полезна в том случае, когда вы хотите использовать собственное зеркало репозитория Astra Automation вместо серверов ПАО Группа Астра, например:

sudo ./aa-setup --repo-url https://example.com/aa-debs-for-alse-1.8

Предупреждение

По умолчанию aa-setup настраивает узлы платформы на использование репозитория Astra Automation для соответствующей версии Astra Linux Special Edition. При использовании опции --repo-url на всех узлах платформы используется одна и та же ссылка на репозиторий, не зависящая от версии установленной ОС. Использование репозитория Astra Automation для версии Astra Linux Special Edition, отличающейся от установленной на узле, приведет к нарушению работы платформы либо ошибкам при ее развертывании и обновлении.

--default-job-ee <ee_url>#

Указывает на образ контейнера, который будет использован в качестве среды исполнения по умолчанию (Default execution environment). Например, эта команда задает в качестве среды исполнения по умолчанию образ hub.astralinux.ru/aa-1.2/aa-full-ee:latest:

sudo ./aa-setup --default-job-ee hub.astralinux.ru/aa-1.2/aa-full-ee:latest
--component <component_name>#

Указывает альтернативный компонент репозитория. Например, если необходимо использовать пакеты, размещенные в компоненте testing, воспользуйтесь командой:

sudo ./aa-setup --component testing
--product-version <product_version>#

Указывает определенную версию Astra Automation. По умолчанию устанавливается новейшая версия. Для установки определенной версии <product_version>, например, 2.0 воспользуйтесь командой:

sudo ./aa-setup --product-version <product_version>
-v, --version#

Показывает версию утилиты aa-setup.

--upgrade#

Обновляет компоненты Astra Automation до новейшей версии. Может быть использован совместно с аргументом --product-version для обновления до определенной версии.

--check-releases#

Выводит на экран терминала версии Astra Automation, доступные в репозитории.

-i, --inventory#

Путь к файлу инвентаря, который утилита aa-setup должна использовать вместо инвентаря по умолчанию (inventory).

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

  • INI:

    • .ini;

    • .cfg;

  • YAML:

    • .yml;

    • .yaml.

Примечание

Если расширение не указано, файл интерпретируется как имеющий формат INI.

-c, --preflight-check#

Выполняет предварительные проверки (preflight checks) перед установкой или обновлением платформы, без фактического развертывания или изменения системы.

Пример использования аргумента:

sudo ./aa-setup -c

Примечание

По умолчанию утилита aa-setup выполняет проверку наличия ошибок в параметрах описания инвентаря и в самом инвентаре перед развертыванием.

--activation-manifest <activation_manifest>#

Путь к ZIP-архиву с манифестом подписки для активации лицензии.

-lg, --log-gathering#

Запускает утилиту sosreport и помещает журналы в каталог определяемый в переменной target_sos_directory в inventory. Каталог по умолчанию: /tmp.

Пример добавления переменной в inventory:

[all:vars]
target_sos_directory='/path/to/log'
--file <file>#

Путь к файлу, содержащему схему совместимости с версиями операционных систем. Файл по умолчанию: /opt/rbta/aa/astra-automation-setup/playbooks/os_compatibility_matrix.yml.

Внимание

Этот аргумент обязателен при использовании аргументов --os-compatibility-update, --validate-only и --force.

-o, --os-compatibility-update#

Обновляет схему совместимости версии Astra Automation с версиями операционных систем.

Пример использования аргумента:

sudo ./aa-setup --os-compatibility-update --file /tmp/os_compatibility_matrix_new.yml
--validate-only#

Выполняет проверку указанного файла со схемой совместимости операционных систем, без внесения изменений.

Пример использования аргумента:

sudo ./aa-setup --os-compatibility-update --file /tmp/os_compatibility_matrix_new.yml --validate-only

Внимание

При использовании аргумента --validate-only обязательно укажите аргументы --os-compatibility-update и --file, как показано в примере использования.

-f, --force#

Принудительно заменяет файл совместимости ОС на файл, заданный аргументом --file.

Дополнительные аргументы#

Утилита aa-setup позволяет передать дополнительные аргументы для команды ansible-playbook. Укажите их после --, например:

sudo ./aa-setup -b -- -vvv --ask-pass