Доступно в редакциях:  EE

Стадия жизненного цикла модуля: General Availability
У модуля есть требования для установки

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

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

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

    Пример:

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

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

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

    d8 system module enable csi-s3
  • С помощью ModuleConfig csi-s3.

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

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

    apiVersion: deckhouse.io/v1alpha1
    kind: ModuleConfig
    metadata:
      name: csi-s3
    spec:
      enabled: true

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

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

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

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

    Пример:

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

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

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

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

    d8 k edit mc csi-s3

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

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

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

    d8 k apply -f <FILENAME>

    Пример файла манифеста ModuleConfig csi-s3:

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

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

Для смены канала обновлений модуля воспользуйтесь инструкцией.

Требования

К версии Deckhouse: 1.72 и выше.

Параметры

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

  • settings
    объект
    • settings.customCACertificates
      массив строк

      Дополнительные сертификаты удостоверяющих центров, которым модуль доверяет при обращении к HTTPS-эндпоинтам S3-совместимого хранилища.

      Каждый элемент списка должен содержать X.509-сертификат в формате PEM. Некорректные значения отклоняются валидирующим вебхуком до применения параметра модулем.

      Используйте этот параметр, если TLS-сертификат объектного хранилища подписан частным или корпоративным удостоверяющим центром, которого нет в стандартном наборе доверенных сертификатов модуля.

      По умолчанию: []

    • settings.dataNodes
      объект
      Настройки CSI S3 на узлах, где могут монтироваться тома

      По умолчанию: {}

      • settings.dataNodes.nodeSelector
        объект

        То же, что и в параметре spec.nodeSelector подов в Kubernetes.

        По умолчанию (kubernetes.io/os: linux) DaemonSet csi-node запускается на всех Linux-узлах. Переопределите параметр, чтобы ограничить CSI S3 подмножеством узлов. Пустой объект отклоняется валидирующим вебхуком (webhook), чтобы случайно не подобрать все узлы кластера.

        Внимание! Изменение этого параметра не переносит существующие монтирования. Если узел больше не соответствует nodeSelector, тома на этом узле станут недоступны.

        По умолчанию: { "kubernetes.io/os": "linux" }

    • settings.logLevel
      строка

      Задаёт уровень детализации журналирования CSI-контроллера модуля.

      Степень детализации уменьшается от TRACE к ERROR: TRACE и DEBUG используются для глубокой диагностики, INFO отражает штатную работу, WARN указывает на нетипичные, но не критичные ситуации, а ERROR фиксирует только ошибки.

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

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