This feature requires an Okmeter license.

The module is not enabled by default in any bundles.

How to explicitly enable the module…

Note that the configOverrides parameter of the InitConfiguration resource is used when installing Deckhouse, not ModuleConfig.

Set the okmeterEnabled: true or okmeterEnabled: false in the configOverrides parameter to explicitly enable or disable the module when installing Deckhouse.

Use the okmeter section of the configOverrides parameter to configure the module when installing Deckhouse.

Set the spec.enabled module parameter to true or false to explicitly enable or disable the module.

Example of enabling the okmeter module:

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

Example of disabling the okmeter module:

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

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

  • apiKeystring

    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

  • imageobject
    • image.repositorystring

      Required value

      Docker repository for okmeter agent image.

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

    • image.tagstring

      Required value

      Okmeter agent image tag.

      Default: "latest"

  • nodeSelectorobject

    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
  • tolerationsarray 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.effectstring
    • tolerations.keystring
    • tolerations.operatorstring
    • tolerations.tolerationSecondsinteger
    • tolerations.valuestring