Доступно в редакциях:  Open/CE, Core, BE, SE, SE+, Ultimate/EE

Входит в расширения:  Продвинутое хранение данных, Хранение данных, Интеграция с системами хранения данных

Стадия жизненного цикла модуля: Общедоступная версия

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

Как явно включить или отключить модуль…

Явно включить или выключить модуль можно одним из следующих способов:

  • С помощью веб-интерфейса Deckhouse. В разделе «Система» → «Управление системой» → «Deckhouse» → «Модули» откройте модуль state-snapshotter и включите (или выключите) переключатель «Модуль включен». Сохраните изменения.

    Пример:

    Интерфейс включения и выключения модуля
  • С помощью Deckhouse CLI (d8).

    Используйте команду d8 system module enable для включения модуля или d8 system module disable для выключения модуля (требуется Deckhouse CLI (d8), настроенный на работу с кластером).

    Пример включения модуля state-snapshotter:

    d8 system module enable state-snapshotter
  • С помощью ModuleConfig state-snapshotter.

    Установите spec.enabled в true или false в ModuleConfig state-snapshotter (при необходимости создайте его).

    Пример манифеста для включения модуля state-snapshotter:

    apiVersion: deckhouse.io/v1alpha1
    kind: ModuleConfig
    metadata:
      name: state-snapshotter
    spec:
      enabled: true

Как настроить модуль…

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

  • С помощью веб-интерфейса Deckhouse.

    В разделе «Система» → «Управление системой» → «Deckhouse» → «Модули» откройте модуль state-snapshotter и включите переключатель «Дополнительные настройки». Заполните необходимые поля формы на вкладке «Конфигурация» или укажите настройки модуля в формате YAML на вкладке «YAML» без ключа верхнего уровня settings. Сохраните изменения.

    Пример:

    Интерфейс настройки модуля

    Вы также можете отредактировать объект ModuleConfig state-snapshotter на вкладке «YAML» в окне настроек модуля («Система» → «Управление системой» → «Deckhouse» → «Модули», откройте модуль state-snapshotter), указав версию схемы в параметре spec.version и необходимые параметры модуля в секции spec.settings.

  • С помощью Deckhouse CLI (d8) (требуется Deckhouse CLI (d8), настроенный на работу с кластером).

    Отредактируйте существующий ModuleConfig state-snapshotter (подробнее о настройке Deckhouse Platform читайте в документации), выполнив следующую команду:

    d8 k edit mc state-snapshotter

    Внесите необходимые изменения в секцию spec.settings. При необходимости укажите версию схемы в параметре spec.version. Сохраните изменения.

    Вы также можете создать файл манифеста ModuleConfig state-snapshotter, используя пример ниже. Заполните секцию spec.settings необходимыми параметрами модуля. При необходимости укажите версию схемы в параметре spec.version.

    Примените манифест с помощью следующей команды (укажите имя файла манифеста):

    d8 k apply -f <FILENAME>

    Пример файла манифеста ModuleConfig state-snapshotter:

    apiVersion: deckhouse.io/v1alpha1
    kind: ModuleConfig
    metadata:
      name: state-snapshotter
    spec:
      version: 1
      enabled: true
      settings: # Параметры модуля из раздела «Параметры» ниже.

Как сменить канал обновлений модуля…

Чтобы сменить канал обновлений модуля, выполните действия из раздела Как сменить канал обновлений для модуля?.

Требования

К версии Deckhouse Platform: 1.76.9 и выше.

Параметры

Версия схемы: 1

  • settings
    объект
    • settings.logLevel
      строка
      Уровень логирования модуля.

      По умолчанию: DEBUG

      Допустимые значения: ERROR, WARN, INFO, DEBUG, TRACE

    • settings.snapshotTtlAfterDelete
      строка
      Окно хранения «корзины»: сколько долговечные данные снапшота хранятся после удаления Snapshot — в течение этого окна их ещё можно восстановить. Строка длительности Go, например “24h”, “168h”. Если не задано, то в контроллере действует встроенный дефолт 30 дней (720h).

      По умолчанию: ‘’