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

В модуле реализовано 5 алертов.

Модуль включен по умолчанию в наборах модулей: Default, Managed. Модуль выключен по умолчанию в наборе модулей Minimal.

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

Чтобы явно включить или выключить модуль log-shipper, установите spec.enabled в true или false в ModuleConfig/log-shipper (создайте, при необходимости), или воспользуйтесь командой deckhouse-controller module в поде d8-system/deckhouse.

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

  • с помощью ресурса ModuleConfig:

    apiVersion: deckhouse.io/v1alpha1
    kind: ModuleConfig
    metadata:
      name: log-shipper
    spec:
      enabled: true
    
  • с помощью команды deckhouse-controller (требуется kubectl, настроенный на работу с кластером):

    kubectl -ti -n d8-system exec svc/deckhouse-leader -c deckhouse -- deckhouse-controller module enable log-shipper
    

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

  • с помощью ресурса ModuleConfig:

    apiVersion: deckhouse.io/v1alpha1
    kind: ModuleConfig
    metadata:
      name: log-shipper
    spec:
      enabled: false
    
  • с помощью команды deckhouse-controller (требуется kubectl, настроенный на работу с кластером):

    kubectl -ti -n d8-system exec svc/deckhouse-leader -c deckhouse -- deckhouse-controller module disable log-shipper
    

Чтобы настроить модуль, используйте custom resource ModuleConfig с именем log-shipper (подробнее о настройке Deckhouse…).

Пример ресурса ModuleConfig/log-shipper для настройки модуля:

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

Параметры

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

  • settings
    объект
    • settings.debug
      булевый

      Включить или выключить отладочные логи агента. По умолчанию: false.

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

    • settings.nodeSelector
      объект

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

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

    • settings.resourcesRequests
      объект

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

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

      Примеры:

      resourcesRequests:
        mode: VPA
        vpa:
          mode: Auto
          cpu:
            min: 50m
            max: 2
          memory:
            min: 256Mi
            max: 2Gi
      
      resourcesRequests:
        mode: VPA
        vpa:
          mode: Initial
          cpu:
            min: 1
            max: 3000m
          memory:
            min: 1024
            max: 4096
      
      resourcesRequests:
        mode: Static
        static:
          cpu: 55m
          memory: 256Ki
      
      • settings.resourcesRequests.mode
        строка

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

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

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

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

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

      • settings.resourcesRequests.static
        объект

        Настройка управления ресурсами в режиме Static.

        • settings.resourcesRequests.static.cpu

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

          Настройка запроса CPU (CPU requests).

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

        • settings.resourcesRequests.static.memory

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

          Настройка запроса памяти (memory requests).

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

      • 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
        строка