Релиз v6.0.0


Предыдущая версия	5.9.3

В обновлении:

Продукт	Новая версия
pl	6.0.0
sm	6.0.0
cl	1.7.0
fm	1.3.0

Уровень простоя - полная остановка из-за глобального изменения маршрутизации.

Базовая информация

Релиз включает обновление различных модулей Monq. Если установлен только определенный набор модулей, например: pl и cl, то разделы с остальными модулями можно проигнорировать.

Выполнить бэкапы баз данных:

pl_user_grants_api_service
pl_identity_service

Проведение миграции

Для запуска обновления требуется скачать клиент управления Monq monqctl и выполнить конфигурацию контекста monqctl.

Примечание

Рекомендуемая версия monqctl: 1.1.2

Примечание

Токен для доступа в Monq ReleaseHub для скачивания обновления требуется получить, обратившись в поддержку Monq, либо из письма с регистрацией лицензии.

warning

Monq v6 перегенерирует токены доступа к обновлениям. Новый токен можно получить, обратившись в тех поддержку Monq.

Задать новый токен доступа в Monq Release Hub

monqctl config get releasehubs
monqctl config set releasehub <name> --token $token --server "https://release-hub.monqlab.com"

Создать токен для авторизации в реестре микросервисов

# Установить namespace в котором запущен реестр микросервисов.
namespace=<namespace> # "production" или "staging"
# Сгенерировать токен авторизации.
token=$(openssl rand -base64 32)
# Запомнить токен авторизации.
echo $token
# Создать secret содержащий токен.
kubectl create secret generic registry-token -n $namespace --from-literal=secure_token=$token
# Добавить переменную окружения содержащую токен.
kubectl set env -n $namespace deployment/pl-microservice-registry-api-service --from=secret/registry-token

Установить токен авторизации в реестре в контекст monqctl

monqctl config get credentials
monqctl config set credential <cred name> --registry-token $token

Выполнить обновление реестра микросервисов

monqctl registry update registry --version=3.2.0

Может случится такое, что адрес, заданный в сервисе K8s реестра микросервисов имеет вид https://kubernetes.default.svc.cluster.local и monqctl не может по этому адресу подключиться в Kubernetes. В таком случае требуется указать точку подключения в K8s через опцию --k8s-api=<uri>.

При обновлении из папки

# Требуется выполнить экспорт реестра в папку
monqctl registry export registry 3.2.0 --dest=<export directory>

# Выполнить команду `registry update registry` с аргументом `--sourceDir`.
monqctl registry update registry --version=3.2.0 --sourceDir=<папка с экспортированным обновлением>

Выполнить обновление шаблонов k8s в реестре микросервисов

# Получить текущий шаблон k8s из реестра микросервисов.
monqctl registry get services K8s --output json > registry-k8s-template.backup.json
# Установить список alias доменов. 
# В случае если используется несколько alias доменов, указать их через запятую(без пробела). Возможно использование wildcard (*.monq.domain.com).
# Если alias домены не используются, установить переменную в пустую строку(alias="").
alias="monq-alias.domain.com"
# Установить конфигурацию tls для доменов monq. Конфигурация должна покрывать все использующиеся домены(основной и alias).
secrets='[{"hosts":["monq.domain.com"],"secretName":"monq.domain.com-tls"},{"hosts":["monq-alias.domain.com"],"secretName":"monq-alias.domain.com-tls"}]'
# Выполнить обновление шаблона.
cat registry-k8s-template.backup.json | jq --arg alias "$alias" --argjson secrets $secrets 'del(.JsonConfig.Job) |
.JsonConfig.Deployment.spec.template.spec.volumes |= . + [{name:"monq-ca-certificates",secret:{secretName:"monq-ca-certificates",optional:true}}] |
.JsonConfig."Container-api".volumeMounts |= . + [{name:"monq-ca-certificates",mountPath:"/certs"}] |
.JsonConfig."Container-console".volumeMounts |= . + [{name:"monq-ca-certificates",mountPath:"/certs"}] |
.JsonConfig.routingIngress = {kind:"Ingress",spec:{rules:[]},metadata:{name:"%AppName%",namespace:"%Namespace%"},apiVersion:"extensions/v1beta1"} |
.JsonConfig.Parameters |= . + [{Name:"%IngressSnippet%",Value:"proxy_set_header X-Smon-Userspace-Id 1;"}] |
.JsonConfig.Parameters |= . + [{Name:"%AliasDomains%",Value:$alias}] |
.JsonConfig.Parameters |= . + [{Name:"%IngressSecrets%",Value:$secrets}]
' > registry-k8s-template.json
# Применить обновленный шаблон в реестр.
monqctl registry apply service K8s --file registry-k8s-template.json

Выполнить предрелизную подготовку

Проверить контекст monqctl и статус реестра микросервисов.

# Просмотреть текущий контекст, с которым работает monqctl.
monqctl config current-context
# Просмотреть статус реестра микросервисов из контекста.
monqctl registry get status
# Просмотреть статус сервисов в реестре микросервисов из контекста.
monqctl registry get services

Примечание

В ответе на команду monqctl registry get status вывод будет содержать

-------------------------
 Consul         | Failed 
-------------------------         

На данном этапе можно проигнорировать. Сервис Consul добавлен только для возможности получить адрес и токен monqctl, который формирует файл доступа для программы-мигратора. Но для Consul в реестре микросервисов не реализованы методы генерирования шаблонов микросервисов, поэтому и выбрасывается ошибка валидации. Будет исправлено в последующих версиях.

Установить контекст релиза, с которым будет работать monqctl в рамках контекста установленного Monq. Команда при этом скачивает и подготавливает релиз.

monqctl release use-version 6.0.0 --product=monq

При обновлении из папки

# Требуется выполнить экспорт релиза в папку
monqctl release version export 6.0.0 --product=monq --dest=<export directory>

# Выполнить команду `use-version` с аргументом `--sourceDir`.
monqctl release use-version 6.0.0 --product=monq --sourceDir=<папка с экспортированным обновлением>

Глобальное изменение маршрутизации

ВНИМАНИЕ

Будет остановлена вся система, т.к. требуется удалить старую систему маршрутизации и заменить новой.

Удалить старые маршруты.

# Установить namespace в котором запущен реестр микросервисов.
namespace=<namespace> # "production" или "staging"
kubectl delete ing -n $namespace frontend-box frontend-box-api
kubectl delete ing -n $namespace pl-routing-external pl-routing-internal
kubectl delete ing -n $namespace cl-routing-external cl-routing-internal
kubectl delete ing -n $namespace sm-routing-external sm-routing-internal
kubectl delete ing -n $namespace fm-routing-external fm-routing-internal

ВНИМАНИЕ

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

kubectl delete ing -n $namespace frontend-*

После удаления маршрутизации необходимо сделать паузу около 1 минуты, для того чтобы nginx-ingress-controller выполнил reload.

Применить новую маршрутизацию.

monqctl release update routing --module=pl
monqctl release update routing --module=cl
monqctl release update routing --module=sm # Не применять, если не установлен модуль AIOps.
monqctl release update routing --module=fm # Не применять, если не установлен модуль FMonq.
monqctl release update routing --module=sm --file monq.json # Не применять, если не установлен модуль AIOps.

Monq Platform (pl)

Выполнить перекачку контейнеров в Docker репозиторий обновляемого экземпляра Monq

monqctl release update images --module=pl

Выполнить конфигурацию баз данных микросервисов

monqctl release update db pgsql --module=pl --microservice=pl-i18n-service --file sqls/pl-i18n-service.sql
monqctl release update db pgsql --module=pl --microservice=pl-automaton-rules-api-service --file sqls/pl-automaton-rules-api-service.sql
monqctl release update db pgsql --module=pl --microservice=pl-user-grants-api-service --file sqls/pl-user-grants-api-service.sql
monqctl release update db pgsql --module=pl --microservice=pl-userspaces-api-service --file sqls/pl-userspaces-api-service.sql
monqctl release update db pgsql --module=pl --microservice=pl-userspaces-api-service --file userspace-configuration.sql

Выполнить конфигурацию микросервисов в реестре для микросервисов из обновления и применить шаблоны в Kubernetes

ВНИМАНИЕ

Из-за значительного изменения шаблона Deployment в Kubernetes, все микросервисы обновятся в режиме Replace, это значит, что потеряется количество реплик, введенное вручную в реестре микросервисов. Перед обновлением следует выписать к-во реплик по микросервисам и после обновления выставить их обратно в реестре и Kubernetes.

monqctl release update microservices --module=pl --k8s-merge-type=Replace

Сбросить кэш для микросервисов

monqctl instance clear cache --microservice=pl-i18n-service
monqctl instance clear cache --microservice=pl-user-grants-api-service
monqctl instance clear cache --microservice=pl-userspaces-api-service

Monq Service Monitor (sm)

Выполнить перекачку контейнеров в Docker репозиторий обновляемого экземпляра Monq

monqctl release update images --module=sm

Выполнить конфигурацию баз данных микросервисов

monqctl release update db pgsql --module=sm --microservice=pl-userspaces-api-service --file userspace-configuration.sql

Выполнить конфигурацию микросервисов в реестре для микросервисов из обновления и применить шаблоны в Kubernetes

ВНИМАНИЕ

monqctl release update microservices --module=sm --k8s-merge-type=Replace

Сбросить кэш для микросервисов

monqctl instance clear cache --microservice=pl-userspaces-api-service

Monq Collector (cl)

Выполнить перекачку контейнеров в Docker репозиторий обновляемого экземпляра Monq

monqctl release update images --module=cl

Выполнить конфигурацию баз данных микросервисов

monqctl release update db pgsql --module=cl --microservice=cl-streams-service --file sqls/cl-streams-service.sql
monqctl release update db pgsql --module=cl --microservice=pl-identity-service --file sqls/pl-identity-service.sql
monqctl release update db pgsql --module=cl --microservice=pl-userspaces-api-service --file userspace-configuration.sql

Выполнить конфигурацию микросервисов в реестре для микросервисов из обновления и применить шаблоны в Kubernetes

monqctl release update microservices --module=cl --k8s-merge-type=Replace

Сбросить кэш для микросервисов

monqctl instance clear cache --microservice=pl-identity-service
monqctl instance clear cache --microservice=pl-userspaces-api-service

Test Forge (fm)

Выполнить перекачку контейнеров в Docker репозиторий обновляемого экземпляра Monq

monqctl release update images --module=fm

Выполнить конфигурацию баз данных микросервисов

monqctl release update db pgsql --module=fm --microservice=fm-projects-api-service --file sqls/fm-projects-api-service.sql
monqctl release update db pgsql --module=fm --microservice=pl-userspaces-api-service --file userspace-configuration.sql

Выполнить конфигурацию микросервисов в реестре для микросервисов из обновления и применить шаблоны в Kubernetes

ВНИМАНИЕ

monqctl release update microservices --module=fm --k8s-merge-type=Replace

Сбросить кэш для микросервисов

monqctl instance clear cache --microservice=pl-userspaces-api-service

Базовая информация​

Проведение миграции​

Задать новый токен доступа в Monq Release Hub​

Создать токен для авторизации в реестре микросервисов​

Выполнить обновление реестра микросервисов​

При обновлении из папки​

Выполнить обновление шаблонов k8s в реестре микросервисов​

Выполнить предрелизную подготовку​

При обновлении из папки​

Глобальное изменение маршрутизации​

Удалить старые маршруты.​

Применить новую маршрутизацию.​

Monq Platform (pl)​

Выполнить перекачку контейнеров в Docker репозиторий обновляемого экземпляра Monq​

Выполнить конфигурацию баз данных микросервисов​

Выполнить конфигурацию микросервисов в реестре для микросервисов из обновления и применить шаблоны в Kubernetes​

Сбросить кэш для микросервисов​

Monq Service Monitor (sm)​

Выполнить перекачку контейнеров в Docker репозиторий обновляемого экземпляра Monq​

Выполнить конфигурацию баз данных микросервисов​

Выполнить конфигурацию микросервисов в реестре для микросервисов из обновления и применить шаблоны в Kubernetes​

Сбросить кэш для микросервисов​

Monq Collector (cl)​

Выполнить перекачку контейнеров в Docker репозиторий обновляемого экземпляра Monq​

Выполнить конфигурацию баз данных микросервисов​

Выполнить конфигурацию микросервисов в реестре для микросервисов из обновления и применить шаблоны в Kubernetes​

Сбросить кэш для микросервисов​

Test Forge (fm)​

Выполнить перекачку контейнеров в Docker репозиторий обновляемого экземпляра Monq​

Выполнить конфигурацию баз данных микросервисов​

Выполнить конфигурацию микросервисов в реестре для микросервисов из обновления и применить шаблоны в Kubernetes​

Сбросить кэш для микросервисов​

Базовая информация

Проведение миграции

Задать новый токен доступа в Monq Release Hub

Создать токен для авторизации в реестре микросервисов

Выполнить обновление реестра микросервисов

При обновлении из папки

Выполнить обновление шаблонов k8s в реестре микросервисов

Выполнить предрелизную подготовку

При обновлении из папки

Глобальное изменение маршрутизации

Удалить старые маршруты.

Применить новую маршрутизацию.

Monq Platform (pl)

Выполнить перекачку контейнеров в Docker репозиторий обновляемого экземпляра Monq

Выполнить конфигурацию баз данных микросервисов

Выполнить конфигурацию микросервисов в реестре для микросервисов из обновления и применить шаблоны в Kubernetes

Сбросить кэш для микросервисов

Monq Service Monitor (sm)

Выполнить перекачку контейнеров в Docker репозиторий обновляемого экземпляра Monq

Выполнить конфигурацию баз данных микросервисов

Выполнить конфигурацию микросервисов в реестре для микросервисов из обновления и применить шаблоны в Kubernetes

Сбросить кэш для микросервисов

Monq Collector (cl)

Выполнить перекачку контейнеров в Docker репозиторий обновляемого экземпляра Monq

Выполнить конфигурацию баз данных микросервисов

Выполнить конфигурацию микросервисов в реестре для микросервисов из обновления и применить шаблоны в Kubernetes

Сбросить кэш для микросервисов

Test Forge (fm)

Выполнить перекачку контейнеров в Docker репозиторий обновляемого экземпляра Monq

Выполнить конфигурацию баз данных микросервисов

Выполнить конфигурацию микросервисов в реестре для микросервисов из обновления и применить шаблоны в Kubernetes

Сбросить кэш для микросервисов