Stronghold в Deckhouse Platform работает как модуль stronghold и обновляется механизмом обновлений Deckhouse Platform. Новые версии модуля поступают по каналам обновлений и применяются в соответствии с настроенным режимом обновления.

Как поступают обновления

Порядок поставки обновлений модуля stronghold:

  • Версии модуля stronghold публикуются в каналах обновлений Alpha, Beta, Early Access, Stable и Rock Solid (подробнее — в разделе «Каналы обновлений»).
  • Deckhouse Platform создаёт в кластере ModuleRelease для каждой доступной версии модуля и применяет её автоматически, в окно обновлений или после ручного подтверждения.
  • Канал и режим обновления модуля по умолчанию определяются настройками модуля deckhouse. Чтобы задать их отдельно для модуля stronghold, используйте ModuleUpdatePolicy. Подробнее — в разделе «Ручное подтверждение обновлений модуля stronghold».

Список версий модуля в кластере:

d8 k get modulereleases | grep stronghold

Изменения в каждой версии описаны в истории изменений. Перед обновлением проверьте требования к версии Deckhouse Platform: например, для Stronghold 1.19 требуется Deckhouse Platform версии 1.76 или новее.

Проверка текущей версии

Проверьте версию Stronghold одним из способов:

  • Выполните команду:

    d8 stronghold status

    Версия указана в поле Version.

  • Проверьте лейблы подов:

    d8 k -n d8-stronghold get pod -o yaml | grep version
  • Проверьте стартовый баннер в логах:

    d8 k -n d8-stronghold logs stronghold-0 | head -20

    Пример строки с версией и редакцией:

    Version: Stronghold v1.15.0+ee
    

Текущий канал обновлений модуля:

d8 k get module stronghold -o jsonpath='{.properties.releaseChannel}'

Если команда не выводит значение, канал обновлений для модуля отдельно не задан.

Подготовка к обновлению

Перед обновлением выполните следующие действия:

  1. Убедитесь, что в кластере отсутствуют алерты и очередь Deckhouse Platform пуста:

    d8 system queue list
  2. Убедитесь, что модуль stronghold находится в состоянии Ready:

    d8 k get modules stronghold
  3. Проверьте состояние кластера Stronghold:

    d8 stronghold status
    d8 stronghold operator raft list-peers

    Значение Sealed должно быть равно false, все узлы Raft должны присутствовать в списке.

  4. Сохраните ключи распечатывания и root-токен в защищённое хранилище за пределами кластера:

    d8 k -n d8-stronghold get secret stronghold-keys -o yaml > stronghold-keys.yaml
    chmod 600 stronghold-keys.yaml
  5. Создайте снимок хранилища и проверьте его (подробнее — в разделе «Создание снимка» и «Проверка снимка»):

    d8 stronghold operator raft snapshot save stronghold-$(date +%F_%H-%M).snap
    d8 stronghold operator raft snapshot inspect stronghold-<SNAPSHOT_DATE>.snap

    Храните снимок и файл с ключами за пределами кластера Deckhouse Platform.

  6. Ознакомьтесь с историей изменений для всех версий между текущей и целевой.

Обновление платформы

Обновление платформы конфигурируется в ModuleConfig deckhouse.

Посмотреть текущую конфигурацию настроек обновления можно с помощью команды:

d8 k get mc deckhouse -oyaml

Пример вывода:

# ...
spec:
  settings:
    releaseChannel: Stable
    update:
      windows:
        - days:
            - Mon
          from: "19:00"
          to: "20:00"
# ...

Настройка режима обновления

Платформа поддерживает три режима обновления:

  • Автоматический + окна обновлений не заданы. Кластер обновится сразу после появления новой версии на соответствующем канале обновлений.
  • Автоматический + заданы окна обновлений. Кластер обновится в ближайшее доступное окно после появления новой версии на канале обновлений.
  • Ручной режим. Для применения обновления требуются ручные действия.

Пример фрагмента конфигурации для включения автоматического обновления платформы:

update:
  mode: Auto

Пример фрагмента конфигурации для включения автоматического обновления платформы с окнами обновлений:

update:
  mode: Auto
  windows:
    - from: "8:00"
      to: "15:00"
      days:
        - Tue
        - Sat

Пример фрагмента конфигурации для включения ручного режима обновления платформы:

update:
  mode: Manual

Каналы обновлений

Платформа использует пять каналов обновлений, предназначенных для использования в разных окружениях. Компоненты платформы могут обновляться автоматически, либо с ручным подтверждением по мере выхода обновлений в каналах обновления.

Информацию по версиям, доступным на каналах обновления, можно получить на сайте https://releases.deckhouse.ru/.

Чтобы перейти на другой канал обновлений, в конфигурации модуля deckhouse нужно установить параметр .spec.settings.releaseChannel.

Пример конфигурации модуля deckhouse с установленным каналом обновлений Stable:

apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: deckhouse
spec:
  version: 1
  settings:
    releaseChannel: Stable
  • При смене канала обновлений на более стабильный (например, с Alpha на EarlyAccess) Deckhouse скачивает данные о релизе (в примере — из канала EarlyAccess) и сравнивает их с данными из существующих в кластере ресурсов DeckhouseRelease:
    • Более поздние релизы, которые ещё не были применены (в статусе Pending), удаляются.
    • Если более поздние релизы уже применены (в статусе Deployed), смены релиза не происходит. В этом случае платформа останется на таком релизе до тех пор, пока на канале обновлений EarlyAccess не появится более поздний релиз.
  • При смене канала обновлений на менее стабильный (например, с EarlyAcess на Alpha):
    • Deckhouse скачивает данные о релизе (в примере — из канала Alpha) и сравнивает их с данными из существующих в кластере ресурсов DeckhouseRelease.
    • Затем платформа выполняет обновление согласно установленным параметрам обновления.

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

d8 k get deckhouserelease
d8 k get modulereleases

Для отключения механизма обновления платформы, удалите в конфигурации модуля deckhouse параметр .spec.settings.releaseChannel. В этом случае платформа не проверяет обновления и обновление на patch-релизы не выполняется.

Крайне не рекомендуется отключать автоматическое обновление! Это заблокирует обновления на patch-релизы, которые могут содержать исправления критических уязвимостей и ошибок.

Немедленное применение обновлений

Чтобы применить обновление немедленно, установите в соответствующем ресурсе DeckhouseRelease аннотацию release.deckhouse.io/apply-now: "true".

Обратите внимание! В этом случае будут проигнорированы окна обновления, настройки canary-release и режим ручного обновления кластера. Обновление применится сразу после установки аннотации.

Пример команды установки аннотации пропуска окон обновлений для версии v1.56.2:

d8 k annotate deckhousereleases v1.56.2 release.deckhouse.io/apply-now="true"

Пример ресурса с установленной аннотацией пропуска окон обновлений:

apiVersion: deckhouse.io/v1alpha1
kind: DeckhouseRelease
metadata:
  annotations:
    release.deckhouse.io/apply-now: "true"

Ручное подтверждение обновлений модуля stronghold

Чтобы обновлять модуль stronghold только после ручного подтверждения, независимо от режима обновления платформы:

  1. Создайте ModuleUpdatePolicy с ручным режимом обновления, указав в поле releaseChannel нужный канал обновлений:

    apiVersion: deckhouse.io/v1alpha2
    kind: ModuleUpdatePolicy
    metadata:
      name: stronghold-update-policy
    spec:
      releaseChannel: Stable
      update:
        mode: Manual
  2. Укажите созданный ресурс в ModuleConfig stronghold:

    d8 k patch moduleconfig stronghold --type merge --patch '{"spec":{"updatePolicy":"stronghold-update-policy"}}'
  3. Убедитесь, что политика применилась:

    d8 k get module stronghold -o jsonpath='{.properties.updatePolicy}'
  4. Когда появится новая версия, подтвердите соответствующий ModuleRelease.

Чтобы автоматически получать только patch-версии, переключите политику в режим AutoPatch:

d8 k patch mup stronghold-update-policy --type merge --patch '{"spec":{"update":{"mode":"AutoPatch"}}}'

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

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

  1. Проверьте состояние модуля:

    d8 k get modules stronghold

    Значения ENABLED и READY должны быть равны True.

  2. Проверьте поды:

    d8 k -n d8-stronghold get pods

    Поды stronghold-* должны находиться в состоянии Running и иметь готовность 2/2. Состояния ImagePullBackOff, ErrImagePull и CrashLoopBackOff должны отсутствовать.

  3. Проверьте версию и состояние Stronghold:

    d8 stronghold status
    d8 stronghold operator raft list-peers

    В поле Version должна быть указана целевая версия, значение Sealed должно быть равно false.

  4. Проверьте вход и чтение тестового секрета, а также работу приложений, получающих секреты из Stronghold.

Ограничения отката

Откат обновления имеет следующие ограничения:

  • Механизм обновлений Deckhouse Platform не откатывает модуль на предыдущую версию автоматически.
  • Основной способ вернуться к состоянию до обновления — восстановление из снимка, созданного на этапе подготовки (подробнее — в разделе «Восстановление из снимка»).
  • Данные, записанные после создания снимка, при восстановлении будут потеряны. Планируйте обновление так, чтобы между созданием снимка и обновлением прошло минимальное время.
  • Если планируете переход между редакциями, выполняйте его отдельно от обновления версии (подробнее — в разделе «Переключение Stronghold с EE на CSE»).