Установка Macroscop Сервер на Linux при помощи Ansible🔗

Поддерживается автоматизированная установка приложений Macroscop на Linux при помощи Ansible. Исходный код готовых ролей для деплоя продукта на любое количество серверов и рабочих мест под управлением Linux доступен для загрузки в репозитории https://github.com/Macroscop/Ansible официального аккаунта Macroscop на Github.

Поддерживаемые дистрибутивы:

  • Debian 12 / 13

  • Ubuntu 22.04 / 24.04

  • Astra Linux SE 1.7 / 1.8

  • ALT Linux Workstation/Server 10, 11

  • ALT SP Linux Workstation/Server 10, 11

  • Роса «Хром» Рабочая станция/Сервер 12, 13

Важно

Для настройки автоматизированной установки необходимо изучить основы работы с Ansible: Официальная документация Ansible.

Инструкции по использованию Ansible🔗

Подготовка к установке

Ansible запускается на управляющем компьютере (рабочем месте администратора или каком-либо сервере) и подключается к серверам по SSH. Устанавливать Ansible на каждый сервер или рабочее место не требуется.

В инструкции используются следующие понятия:

  • Хост — компьютер, на котором требуется установить ПО.

  • Inventory — «инвентарь», файл со списком хостов и групп.

  • Плейбук — сценарий в файле .yml, который запускает задачи установки.

  • Роль — набор задач и настроек, используемый плейбуком.

Перед началом работы подготовьте:

  • Управляющий компьютер с Linux, Python и Git. Все приведённые ниже команды выполняются в его терминале. При работе из Windows используйте Linux в WSL.

  • Хосты с работающим SSH-сервером и доступом к репозиториям пакетов через интернет (или внутренним репозиториям, откуда будут установлены пакеты).

  • Учётную запись на каждом хосте с правом подключения по SSH и выполнения команд через sudo. Для установки Macroscop Клиент на рабочих местах также необходима графическая оболочка.

1. Установка Ansible и загрузка плейбуков

Установите Ansible на управляющий компьютер по официальной инструкции Ansible. Выберите способ установки и версии Python, подходящие для вашей ОС и версии Ansible.

После установки проверьте доступность команды:

ansible --version

Загрузите репозиторий Macroscop и перейдите в его папку:

git clone https://github.com/Macroscop/Ansible.git
cd Ansible

Дальнейшие команды выполняйте из этой папки. В ней находятся:

  • ansible.cfg — настройки Ansible;

  • inventory/hosts.yml — список хостов;

  • group_vars/all.yml — общие параметры подключения;

  • install_macroscop_server.yml — установка Macroscop Сервер;

  • install_macroscop_flatpak.yml — установка Macroscop Клиент через Flatpak;

  • roles — задачи установки и их параметры.

2. Настройка ansible.cfg

Откройте ansible.cfg в текстовом редакторе и замените его содержимое следующим примером:

[defaults]
inventory         = ./inventory/hosts.yml
forks             = 5
timeout           = 30
host_key_checking = false
stdout_callback   = ansible.builtin.default

Назначение параметров:

  • inventory — путь к файлу со списком хостов;

  • forks — максимальное число параллельных процессов Ansible. В примере одновременно обрабатывается не более пяти хостов;

  • timeout — время ожидания SSH-подключения в секундах. Это не ограничение общей продолжительности установки.

  • host_key_checking — проверка ключа SSH-сервера при подключении;

  • stdout_callback — формат вывода результатов. Значение ansible.builtin.default использует встроенный обработчик.

Проверьте настройки:

ansible-config dump --only-changed

В строке config file должен быть указан файл из папки загруженного репозитория. Если выбран другой файл, проверьте текущую папку и переменную окружения ANSIBLE_CONFIG. Обратите внимание, что Ansible ищет файл конфигурации в указанном порядке и использует первый найденный, при этом конфигурация из разных файлов не совмещается.

  • ANSIBLE_CONFIG — переменная окружения;

  • ansible.cfg — в текущей папке;

  • ~/.ansible.cfg — в домашнем каталоге пользователя;

  • /etc/ansible/ansible.cfg — конфигурация для всей системы (всех пользователей);

Подробнее см. параметры конфигурации Ansible.

3. Настройка групп и хостов

Откройте inventory/hosts.yml и замените демонстрационные адреса списком ваших серверов. Например, для двух серверов и одного рабочего места:

all:
  children:
    macroscop_servers:
      hosts:
        server01:
          ansible_host: 192.168.10.11
        server02:
          ansible_host: 192.168.10.12
    macroscop_clients:
      hosts:
        client01:
          ansible_host: 192.168.10.21

Здесь macroscop_servers и macroscop_clients — группы по назначению компьютеров; server01, server02 и client01 — имена хостов внутри Ansible; ansible_host — IP-адрес для подключения. Вместо IP-адреса можно указать доступное DNS-имя. Группа all включает все хосты.

Названия групп сами по себе не выбирают устанавливаемый продукт. Группу нужно указать при запуске соответствующего плейбука.

Если для отдельного хоста используются другой SSH-пользователь или порт, добавьте параметры к этому хосту:

server02:
  ansible_host: 192.168.10.12
  ansible_user: operator
  ansible_port: 2222

Этот фрагмент заменяет описание server02 в предыдущем примере с сохранением его отступов. При редактировании YAML используйте пробелы вместо табуляции.

Проверьте полученный список:

ansible-inventory --graph

Подробнее см. настройку inventory в документации Ansible.

4. Настройка подключения

В файле group_vars/all.yml из репозитория указаны демонстрационные имя пользователя и пароль. Замените содержимое файла настройками своей учётной записи. Пример для подключения по SSH-ключу:

ansible_user: administrator
ansible_ssh_private_key_file: ~/.ssh/id_ed25519
ansible_become: true
ansible_become_method: sudo

ansible_user — существующий пользователь Linux на удалённых компьютерах, а не пользователь системы Macroscop. Укажите своё имя пользователя и путь к закрытому ключу на управляющем компьютере. Соответствующий открытый ключ должен быть добавлен в ~/.ssh/authorized_keys этого пользователя на каждом хосте.

ansible_become: true включает повышение прав, а ansible_become_method: sudo задаёт способ его выполнения.

Проверьте доступность всех хостов через Ansible:

ansible all -m ansible.builtin.ping -K

Параметр -K запрашивает пароль для sudo. Если вашей учётной записи разрешено выполнение необходимых команд без пароля, опустите этот параметр. Ответ pong означает, что Ansible смог подключиться и выполнить модуль Python; это не проверка сетевой командой ping.

Примечание

Для подключения по SSH-паролю удалите строку ansible_ssh_private_key_file и добавляйте к командам -k. Например: ansible all -m ansible.builtin.ping -k -K. Строчная -k запрашивает пароль SSH, заглавная -K — пароль повышения прав. Один введённый пароль каждого типа используется для всех хостов данного запуска; при разных паролях выполняйте запуск отдельно для соответствующих хостов или групп.

5. Запуск плейбуков

Важно

В обоих плейбуках репозитория указано hosts: all. Без параметра --limit выбранный плейбук выполняется на всех хостах из inventory, включая серверы и рабочие места. Для приведённого выше смешанного списка используйте ограничение по группе.

Установка на группу компьютеров

Чтобы установить Macroscop Сервер на хосты группы macroscop_servers, выполните:

ansible-playbook install_macroscop_server.yml --limit macroscop_servers -K

Чтобы установить Macroscop Клиент на хосты группы macroscop_clients, выполните:

ansible-playbook install_macroscop_flatpak.yml --limit macroscop_clients -K

Установка на выбранные хосты

Пример запуска только для server01:

ansible-playbook install_macroscop_server.yml --limit server01 -K

Пример запуска для двух хостов:

ansible-playbook install_macroscop_server.yml --limit 'server01,server02' -K

В --limit указывайте имена из inventory. Этот параметр ограничивает существующий список, а не добавляет в него новые компьютеры.

Установка на все хосты

Если все компьютеры из inventory предназначены для установки Macroscop Сервер, выполните:

ansible-playbook install_macroscop_server.yml -K

Если все компьютеры предназначены для установки Macroscop Клиент, выполните:

ansible-playbook install_macroscop_flatpak.yml -K

Это альтернативные команды для разных списков хостов. Для установки обоих продуктов на соответствующие группы используйте две команды из подраздела «Установка на группу компьютеров».

Выбор версии Macroscop

По умолчанию в ролях задано значение latest. Для выбора версии передайте параметр через -e. Например, для ветки 4.6:

ansible-playbook install_macroscop_server.yml --limit macroscop_servers -e 'macroscop_version=4.6.*' -K
ansible-playbook install_macroscop_flatpak.yml --limit macroscop_clients -e 'macroscop_client_flatpak_version=4.6' -K

Замените значения на нужную версию, доступную в репозитории пакетов. Версия 4.6 здесь приведена только как пример формата параметра.

Примечание

Текущая роль Macroscop Клиент пропускает установку, если приложение уже обнаружено через flatpak info. Повторный запуск с другой версией не переключает установленный клиент на эту версию.

6. Проверка запуска и результата

Перед установкой проверьте синтаксис плейбука и список выбранных хостов:

ansible-playbook install_macroscop_server.yml --syntax-check
ansible-playbook install_macroscop_server.yml --limit macroscop_servers --list-hosts

Эти команды не выполняют установку. Для проверки клиентского плейбука замените имя файла и группу на install_macroscop_flatpak.yml и macroscop_clients.

По завершении установки просмотрите итоговый блок PLAY RECAP для каждого хоста:

  • ok — успешно выполненные задачи;

  • changed — задачи, сообщившие об изменениях;

  • unreachable — ошибки подключения;

  • failed — ошибки выполнения задач;

  • skipped — пропущенные задачи.

Если unreachable или failed не равны нулю, найдите сообщение об ошибке выше в выводе. При ошибке подключения проверьте адрес, порт и учётную запись; при ошибке повышения прав — настройки sudo и необходимость параметра -K. Для подробного вывода повторите нужную команду с -v.

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

Полный список параметров запуска приведён в справке ansible-playbook.