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

Стадия жизненного цикла модуля: General Availability

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

Модуль не включен по умолчанию в каком-либо наборе модулей.

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

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

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

    Пример:

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

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

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

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

    d8 system module enable okmeter
    
  • С помощью ModuleConfig okmeter.

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

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

    apiVersion: deckhouse.io/v1alpha1
    kind: ModuleConfig
    metadata:
      name: okmeter
    spec:
      enabled: true
    

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

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

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

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

    Пример:

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

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

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

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

    d8 k edit mc okmeter
    

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

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

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

    d8 k apply -f <FILENAME>
    

    Пример файла манифеста ModuleConfig okmeter:

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

Параметры

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

  • settings
    объект
    • settings.apiKey
      строка

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

      Ключ для доступа к API Okmeter.

      Ключ можно взять в личном кабинете Okmeter (OKMETER_API_TOKEN).

      Пример:

      apiKey: 5ff9z2a3-9127-1sh4-2192-06a3fc6e13e3
      
    • settings.disableAutoDiscovery

      Отключает автоматическое обнаружение сервисов, которые способен мониторить okmeter. Установка опции в true оставит лишь базовый мониторинг хоста, прочие плагины (postgresql, mysql, redis и др.) будут отключены. По умолчанию установлено значение false.

    • settings.image
      объект
      • settings.image.repository
        строка

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

        Docker repository for okmeter agent image.

        По умолчанию: registry.okmeter.io/agent/okagent

      • settings.image.tag
        строка

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

        Okmeter agent image tag.

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

    • settings.nodeSelector
      объект

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

      Если ничего не указано или указано false, то Deckhouse попытается вычислить значение nodeSelector автоматически.

      Пример:

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

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

      Если ничего не указано или указано false, то Deckhouse попытается вычислить значение tolerations автоматически.

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