The module has 1 alert.

The module is not enabled by default in any bundles.

How to explicitly enable the module…

Set the spec.enabled module parameter to true or false in the ModuleConfig/okmeter resource (create it, if necessary) to explicitly enable or disable the module, or use the deckhouse-controller module command in the d8-system/deckhouse pod.

Example of enabling the module:

  • by using the ModuleConfig resource:

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

  • by using the deckhouse-controller command (you need a kubectl, configured to work with the cluster):

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

Example of disabling the module:

  • by using the ModuleConfig resource:

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

  • by using the deckhouse-controller command (you need a kubectl, configured to work with the cluster):

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

The module is configured using the ModuleConfig custom resource named okmeter (learn more about setting up Deckhouse…).

Example of the ModuleConfig/okmeter resource for configuring the module:

apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: okmeter
spec:
  version: 1
  enabled: true
  settings: # <-- Module parameters from the "Parameters" section below.

Parameters

Schema version: 1

  • apiKey
    string

    Required value

    Key to access Okmeter API.

    You can get the key for your project on the okmeter installation page (OKMETER_API_TOKEN).

    Example:

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

    Disables okagent autodiscovery. Setting this option to true will leave only basic host monitoring, all other plugins (postgresql/mysql/redis/etc.) will be disabled. Default value is false

  • image
    object
    • image.repository
      string

      Required value

      Docker repository for okmeter agent image.

      Default: "registry.okmeter.io/agent/okagent"

    • image.tag
      string

      Required value

      Okmeter agent image tag.

      Default: "latest"

  • nodeSelector
    object

    The same as in the pods’ spec.nodeSelector parameter in Kubernetes.

    If the parameter is omitted or false, it will be determined automatically.

    Example:

    nodeSelector:
  test: test
  • tolerations
    array of objects

    The same as in the pods’ spec.tolerations parameter in Kubernetes;

    If the parameter is omitted or false, it will be determined automatically.

    • tolerations.effect
      string
    • tolerations.key
      string
    • tolerations.operator
      string
    • tolerations.tolerationSeconds
      integer
    • tolerations.value
      string