Доступно в редакциях:  CE, BE, SE, SE+, EE, CSE Lite (1.73), CSE Pro (1.73)

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

Модуль начинает чтение логов, только если создан pipeline в виде связанных между собой ClusterLoggingConfig/PodLoggingConfig и ClusterLogDestination.

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

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

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

    Пример:

    Интерфейс включения и выключения модуля

  • С помощью Deckhouse CLI (d8).

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

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

    d8 system module enable log-shipper

  • С помощью ModuleConfig log-shipper.

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

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

    apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: log-shipper
spec:
  enabled: true

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

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

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

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

    Пример:

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

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

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

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

    d8 k edit mc log-shipper

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

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

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

    d8 k apply -f <FILENAME>

    Пример файла манифеста ModuleConfig log-shipper:

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

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

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

Требования

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

Конверсии

Модуль настраивается с помощью ресурса ModuleConfig, схема которого содержит номер версии. При применении в кластере старой версии схемы ModuleConfig выполняются автоматические преобразования. Чтобы обновить версию схемы ModuleConfig вручную, необходимо последовательно для каждой версии выполнить следующие действия:

  • Обновление из версии 1 в 2:

    Перенесите .settings.resourcesRequests.static.cpu и .settings.resourcesRequests.static.memory в .settings.resourcesRequests.static.requests.

Параметры

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

  • settings
    объект
    • settings.debug
      булевый
      Включить или выключить отладочные логи агента. По умолчанию: false.

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

    • settings.nodeSelector
      объект

      Структура, аналогичная spec.nodeSelector пода Kubernetes.

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

    • settings.registry
      объект

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

      • settings.registry.dockercfg
        строка
        Base64-encoded .dockerconfigjson for pulling module images. If empty, global.modulesImages.registry.dockercfg is used.
    • settings.resourcesRequests
      объект

      Настройки максимальных значений CPU и памяти, которые может запросить под при выборе узла (CPU requests, memory requests).

      Если модуль vertical-pod-autoscaler выключен, максимальные значения становятся значениями по умолчанию.

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

      Примеры: 

      mode: VPA
vpa:
  cpu:
    max: 2
    min: 50m
  memory:
    max: 2Gi
    min: 256Mi
  mode: Auto

      mode: VPA
vpa:
  cpu:
    max: 3000m
    min: 1
  memory:
    max: 4096
    min: 1024
  mode: Initial

      mode: Static
static:
  limits:
    cpu: 2
    memory: 2Gi
  requests:
    cpu: 55m
    memory: 256Mi
      • settings.resourcesRequests.mode
        строка

        Обязательный параметр

        Режим управления запросами ресурсов (requests):

        • Static — классический, с помощью явного указания ограничения. Настраивается в секции параметров static;
        • VPA — с помощью VPA. Настраивается в секции параметров vpa.

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

        Допустимые значения: VPA, Static

      • settings.resourcesRequests.static
        объект
        Настройка управления ресурсами в режиме Static.

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

        • settings.resourcesRequests.static.limits
          объект
          Настройка ограничений CPU и памяти (limits).
          • settings.resourcesRequests.static.limits.cpu
            Настройка ограничения CPU (CPU limits).
          • settings.resourcesRequests.static.limits.memory
            Настройка ограничения памяти (memory limits).
        • settings.resourcesRequests.static.requests
          объект
          Настройка запросов ресурсов (requests) для подов.
          • settings.resourcesRequests.static.requests.cpu
            Настройка запроса CPU (CPU requests).
          • settings.resourcesRequests.static.requests.memory
            Настройка запроса памяти (memory requests).
      • settings.resourcesRequests.vpa
        объект
        Настройка управления ресурсами в режиме VPA.

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

        • settings.resourcesRequests.vpa.cpu
          объект

          Обязательный параметр

          Настройки VPA при работе с CPU.

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

          • settings.resourcesRequests.vpa.cpu.max
            Максимальное значение, которое может выставить VPA для запроса CPU (CPU requests).

            По умолчанию: 500m

          • settings.resourcesRequests.vpa.cpu.min
            Минимальное значение, которое может выставить VPA для запроса CPU (CPU requests).

            По умолчанию: 50m

        • settings.resourcesRequests.vpa.memory
          объект

          Обязательный параметр

          Настройки VPA при работе с памятью.

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

          • settings.resourcesRequests.vpa.memory.max
            Максимальное значение, которое может выставить VPA для запроса к памяти (memory requests).

            По умолчанию: 2048Mi

          • settings.resourcesRequests.vpa.memory.min
            Минимальное значение, которое может выставить VPA для запроса к памяти (memory requests).

            По умолчанию: 64Mi

        • settings.resourcesRequests.vpa.mode
          строка

          Обязательный параметр

          Режим работы VPA.

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

          Допустимые значения: Initial, Auto

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

      Структура, аналогичная spec.tolerations пода Kubernetes.

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

      • settings.tolerations.effect
        строка
      • settings.tolerations.key
        строка
      • settings.tolerations.operator
        строка
      • settings.tolerations.tolerationSeconds
        целочисленный
      • settings.tolerations.value
        строка