Обновление EVTD#

Перед обновлением рекомендуется сделать архивную копию текущей версии, запустив установку с тегом backup.

С предустановкой Platform V Corax#

Обновление происходит путем последовательного перезапуска брокеров Platform V Corax. При смене версии протокола требуется задать дополнительные параметры конфигурации вида inter.broker.protocol.version=X и log.message.format.version=Х в файле свойств брокера.

  1. В конфигурационном файле server.properties задайте параметры inter.broker.protocol.version=X и log.message.format.version=Х.

  2. Остановите работу одного из брокеров и замените исполняемые файлы.

  3. Запустите обновленный брокер.

  4. Повторите шаги 2 и 3 для каждого последующего брокера кластера.

  5. Уберите параметр inter.broker.protocol.version=X из файлов server.properties всех брокеров и выполните повторный перезапуск.

После перехода клиентов на новую версию уберите параметр log.message.format.version=Х и перезапустите кластер.

Подробнее об обновлении брокеров Platform V Corax в документации на продукт в разделе «Руководство по установке».

С помощью ansible#

Для обновления на сервере, с которого производилась установка, выполнить команду:

ansible-playbook -i inventories/<ID>/inventory rolling_upgrade.yml --ask-vault-pass

, где ID - имя созданного inventory.

С помощью Jenkins#

Для обновления необходимо запустить Jenkins job с выбором playbook rolling_upgrade.yml c необходимым тегом. Остановка и удаление предыдущей версии компонента выполняется автоматически при запуске обновления на новую версию.

Процесс создания Jenkins job описан в разделе Подготовка окружения EVTD, подраздел «Создание Jenkins Job для автоматической установки EVTD».

Настраиваемые параметры:

  • job_config_renew — обновление Jenkins Job. При установке приложения должен быть выключен (false). Для обновления текущих параметров и сохранения значений по умолчанию должен быть включен (true);

  • inventory — имя inventory для установки;

  • nexusUrl — ссылка на переданный дистрибутив ./EVTD-kafka-[version]-distrib.zip;

  • nexusUrlKafka — полный путь до дистрибутива KFKA или дистрибутива Apache Kafka;

  • playbook— необходимый сценарий установки;

  • tags — список тегов для playbook rolling_upgrade.yml:

    • rolling_restart_kafka — понодная перезагрузка Kafka;

    • rolling_restart_zookeeper — понодная перезагрузка Zookeper;

    • zk_ssl — включение ssl авторизации на Zookeper;

    • zk_ssl_plaintext — включение одновременной работы plaintext и SSL;

  • select_all_hosts – выполнение playbooks на всех серверах из выбранного inventory;

  • only_on_host – выполнение playbooks на выбранных серверах;

  • emailto — список адресов электронной почты для отправки результатов (письмо исполнителю упадет автоматически);

  • custom_vault_password – ручной ввод пароля для Ansible Vault;

  • jenkins_slave — выбор Jenkins Slave;

  • ansible_branch — ветка скриптов развертывания;

  • ansible_version — указание Jenkins Tool с необходимой версией Ansible. Конкретное значение необходимо получить у администратора Jenkins;

  • nexus_user_cred — Jenkins Username with Password credential ID для выкачивания дистрибутива. При задании secman_url – полный путь в HashiCorp Vault до имени пользователя и пароля. Например: {Jenkins *Vault App Role credential* ID для получения секретов из HashiCorp Vault}|path/to/nexus:{user},{password};

  • vault_cred — Jenkins secret file credential ID со строкой для расшифровки паролей (ansible vault). При задании secman_url – полный путь в HashiCorp Vault до пароля. Например: {Jenkins *Vault App Role credential* ID_1}|/path/to/vault:{password_1}, {Jenkins *Vault App Role credential* ID_2}|/path/to/vault:{password_2} В качестве пароля можно использовать не строку, а файл в base64 формате с ключом секрета, заканчивающимся на Base64. Например myVaultBase64;

  • server_ssh_cred — Jenkins ssh key Credential ID с ssh ключом для подключения к конечным серверам. Чтобы получить ssh_username, ssh_key, ssh_key_passsphrase для подключения к серверам из HashiCorp Vault, необходимо заполнить параметр secman_url в формате: JenkinsCredID|SecManPath:SecManKeys|SecManParams, где:

    • JenkinsСredID — Jenkins Vault App Role Credential ID, содержащий реквизиты для подключения к HashiCorp Vault;

    • SecManPath — путь к секретам в HashiCorp Vault;

    • SecManKeys — имена полей для JKS администратора в HashiCorp Vault и пароля от него через запятую.

      • Окончание имени поля для JKS администратора должно быть Base64;

      • JKS администратора в HashiCorp Vault должен храниться в KV хранилище в Base64 формате;

      • Поле пароля для JKS администратора опционально, в случае его отсутствия пароль будет запрошен в интерактивном режиме.

    • SecManParams — параметры подключения к HashiCorp Vault (через точку с запятой). Если данные параметры по умолчанию, то пропускаются вместе с «|» (в качестве ключа можно использовать не строку, а файл в base64 формате и секрет в HashiCorp Vault с именем, оканчивающимся на «Base64», например: myPrivateKeyBase64). Примеры:

      • SecManAppRoleCred|/CI01994970_CI02618129_ES/A/DEV/APP/JEN/KV/vault:ssh_username,ssh_key

      • SecManAppRoleCred|/CI01994970_CI02618129_ES/A/DEV/APP/JEN/KV/vault:ssh_username,ssh_key,ssh_key_passphrase

      • SecManAppRoleCred|/CI01994970_CI02618129_ES/A/DEV/APP/JEN/KV/vault:ssh_username,ssh_key,ssh_key_passphrase|engineVersion:2.

  • secman_url — URL для подключения к HashiCorp Vault;

  • jdk_tool — наименование Jenkins Tool с необходимой версией JDK. Конкретное значение необходимо получить у администратора Jenkins;

  • ssl_verify — проверка, являются ли сертификаты HashiCorp Vault/Nexus доверенными;

  • inventories_repo — репозиторий с inventory. Данный пункт применим, если inventory были созданы в другом репозитории, отличным от того, где лежат скрипты;

  • inventories_branch — ветка репозитория, где находятся inventory. Данный пункт применим, если inventory были созданы в другом репозитории, отличным от того, где лежат скрипты;

  • inventories_path — путь до inventories от корня репозитория (значение Ansible/inventories).

Если не выбран ни один из параметров only_on_host, select_all_hosts, выполнение Jenkins job прервется с ошибкой Не выбраны сервера.