Перейти к основному содержимому

Автоматизированная установка Recovery Manager

Предусловия​

Перед началом установки убедитесь, что выполнены следующие условия:

  1. Подготовлено окружение.
  2. Дистрибутив CopyWala распакован в соответствии с инструкцией, приведенной в разделе Установка, шаг Распаковка дистрибутива CopyWala.

Последовательность действий​

Выполните шаги в следующем порядке:

  1. Подготовка среды Ansible.
  2. Установка Ansible-коллекций.
  3. Генерация TLS-сертификатов.
  4. Подготовка inventory-файла и переменных ролей.
  5. Запуск установки.

Подготовка среды Ansible​

Рекомендуется запускать установку модуля Recovery Manager в виртуальной среде Python.

к сведению

Данный шаг выполняется на управляющем узле Ansible (control node) — машине, с которой запускаются Ansible-плейбуки.

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

  1. Создайте виртуальное окружение. Рекомендуется использовать Python 3.9:

    python3 -m venv .pbr

  2. Активируйте виртуальное окружение:

    source .pbr/bin/activate

  3. Установите необходимые пакеты:

    python3.9 -m pip install 'ansible==8.7.0'

  4. Проверьте, что установка Ansible прошла успешно: ansible --version. В результате вывод не должен содержать ошибок. Команда pip list должна вывести зависимости:

        ansible             8.7.0
        ansible-core        2.15.13
к сведению

После завершения установки компонентов виртуальную среду можно отключить. Выполните консольную команду: deactivate.

Установка Ansible-коллекций​

к сведению

Данный шаг выполняется на управляющем узле Ansible (control node) — машине, с которой запускаются Ansible-плейбуки.

Установите или обновите Ansible-коллекции с помощью ansible-galaxy. Необходимые зависимости:

Название Ansible-коллекции

Версия

Установка

sbt-pbr (поставляется в составе дистрибутива продукта CopyWala)

1.0.0

Перейдите в директорию с распакованным дистрибутивом любого компонента CopyWala и запустите команду:

ansible-galaxy collection install package/scripts/Ansible/collections/sbt-pbr-1.0.0.tar.gz

Community.Postgresql (устанавливается из внешнего репозитория Ansible Galaxy)

3.9.1

ansible-galaxy collection install community.postgresql:3.9.1

Community.Library_Inventory_Filtering_V1 (устанавливается из внешнего репозитория Ansible Galaxy)

1.0.2

ansible-galaxy collection install community.library_inventory_filtering_v1:1.0.2

Генерация TLS-сертификатов​

Сгенерируйте TLS-сертификаты, необходимые для работы модуля Recovery Manager с шифрованием.

Для генерации используйте Ansible-роль certs. Работа с ролью описана в дополнительной документации для автоматизированного варианта установки (с помощью Ansible) в разделе Генерация сертификатов с помощью Ansible-роли certs.

Подготовка inventory-файла и переменных ролей​

  1. Перейдите в директорию со скриптами установки. Например, если дистрибутив был распакован в /path_to_dir/distrib/:

    cd /path_to_dir/distrib/pbr/owned/dbbr/package/scripts/Ansible

  2. Создайте inventory-файл на основе inventory_example.yml и в секции recovery.hosts укажите IP-адреса узлов, на которые необходимо установить модуль Recovery Manager.

    Пример inventory-файла

    recovery:
      hosts:
        recovery-host:
          ansible_host: "<recovery_manager_ip_address>"

    Подсказка

    Если Recovery Manager необходимо установить на несколько хостов, добавьте дополнительные секции в inventory-файл по примеру ниже:

    Пример inventory-файла

    recovery:
      hosts:
        recovery-host1:
          ansible_host: "<recovery_manager_ip_address_1>"

        recovery-host2:
          ansible_host: "<recovery_manager_ip_address_2>"

        # КОД ПРОПУЩЕН: секции с IP-адресами остальных хостов

  3. Задайте переменные роли recovery_manager.

    к сведению

    Роль recovery_manager выполняет установку и настройку модуля Recovery Manager. Она использует RPM-пакет, путь к которому задается в переменной recovery_manager_package_path. Пакет копируется на целевой узел, после чего выполняется его установка.

    Путь к RPM-пакету можно задать вручную с помощью переменной recovery_manager_package_path или определить автоматически с помощью роли common.

    Задайте переменные, у которых в таблице ниже в столбце «Обязательность заполнения» – Да, а также при необходимости задайте другие (не обязательные) переменные.

    примечание

    • Если переменная не задана явно в плейбуке, для нее используется значение по умолчанию, определенное в файле defaults/main.yml роли.

    • Из необязательных переменных рекомендуется заполнять секцию *_tls, где * — это префикс с именем модуля. Например, для Storage Manager секция будет выглядеть так:

      storage_manager_tls:
        rootca:
          local_path: /path/to/certs/certificates/rootCA.crt
        cert:
          local_path: /path/to/certs/certificates/storage-manager.crt
        key:
          local_path: /path/to/certs/certificates/storage-manager.key
Переменные Ansible-роли recovery_manager

Название переменной

Описание

Значение по умолчанию

Обязательность заполнения

recovery_manager_package_path

Путь к RPM-файлу установщика Recovery Manager

""

Да или использовать роль common. При использовании роли common задавать эту переменную не требуется

recovery_manager_user

Пользователь, который будет работать с Recovery Manager

{{ lookup('env', 'USER') }}

Нет

recovery_manager_config_dir

Директория для размещения файлов Recovery Manager

/home/{{ recovery_manager_user }}/.pbr

Нет

recovery_manager_open_id_rootca

Путь к CA сертификату OpenID провайдера на Ansible-узле

""

Нет

recovery_manager_ag_rootca

Путь к CA сертификату API Gateway на Ansible-узле

""

Нет

Переменные роли можно задать одним из следующих способов:

Пример заполнения

recovery:
  hosts:
    recovery-host:
      ansible_host: "<recovery_manager_ip_address>"
      recovery_manager_package_path: /path_to_dir/distrib/pbr/owned/dbbr/rpms/recovery-manager-1.3.1-sberlinux9.x86_64.rpm

      # КОД ПРОПУЩЕН: другие переменные роли

Подсказка

Пример плейбука также приведен в файле pbr/owned/dbbr/package/scripts/Ansible/playbook_example.yml.

Запуск установки​

примечание

Перед запуском убедитесь, что виртуальное окружение .pbr активировано.

  1. Перед запуском установки Recovery Manager, в install.yml закомментируйте или удалите роли компонентов, которые не требуется устанавливать.

    Пример

    #- name: Install additional components
    #  hosts: dbbr
    #  roles:
    #   - agent_manager
    #   - api_gateway
    #   - task_manager
    #   - storage_manager

    - name: Install Recovery Manager
      hosts: recovery
      roles:
        - recovery_manager

  2. Для запуска установки выполните команды:

    cd pbr/owned/dbbr/package/scripts/Ansible
    ansible-playbook -i inventory.yml install.yml
    примечание

    Если на шаге подготовка inventory-файла и переменных ролей переменные были заданы в отдельном файле, укажите его с помощью флага -e, например:

    cd pbr/owned/dbbr/package/scripts/Ansible
    ansible-playbook -i inventory.yml install.yml -e @recovery-manager-vars.yml

Проверка результата​

Для проверки установки и работоспособности модуля Recovery Manager обратитесь к разделу Чек-лист проверки корректности работы.

к сведению

После завершения установки данного модуля:

  1. При необходимости выполните установку других модулей Platform V CopyWala.
  2. Перейдите к следующему шагу — Настройка интеграции Platform V CopyWala с внешними сервисами.