Available in editions:  CE, BE, SE, SE+, EE

The module lifecycle stageGeneral Availability

The module has 1 alert.

The module is not enabled by default in any bundles.

How to explicitly enable the module…

You may explicitly enable or disable the module in one of the following ways:

  • Via Deckhouse web UI. In the “System” → “System Management” → “Deckhouse” → “Modules” section, open the okmeter module and enable (or disable) the “Module enabled” toggle. Save changes.

    Example:

    Module enable/disable interface

  • Via Deckhouse CLI (d8).

    Use the d8 system module enable command for enabling, or d8 system module disable command for disabling the module (you need Deckhouse CLI (d8), configured to work with the cluster).

    Example of enabling the module:

    d8 system module enable okmeter
    
  • Using ModuleConfig okmeter.

    Set spec.enabled to true or false in ModuleConfig okmeter (create it if necessary);

    Example of a manifest to enable module okmeter:

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

How to configure the module…

You can configure the module in one of the following ways:

  • Via Deckhouse web UI.

    In the “System” → “System Management” → “Deckhouse” → “Modules” section, open the okmeter module and enable the “Advanced Settings” switch. Fill in the required fields in the “Configuration” tab or specify the module settings in YAML format on the “YAML” tab, excluding the settings section. Save the changes.

    Example:

    Module Setup Interface

    You can also edit the ModuleConfig object okmeter on the “YAML” tab in the module settings window (“System” → “System Management” → “Deckhouse” → “Modules”, open the module okmeter) by specifying the schema version in the spec.version parameter and the necessary module parameters in the spec.settings section.

  • Via Deckhouse CLI (d8) (requires Deckhouse CLI (d8) configured to work with the cluster).

    Edit the existing ModuleConfig okmeter (for more details on configuring Deckhouse, see the documentation) by executing the following command:

    d8 k edit mc okmeter
    

    Make the necessary changes in the spec.settings section. If necessary, specify the schema version in the spec.version parameter. Save the changes.

    You can also create a file with manifest for ModuleConfig okmeter using the example below. Fill in the spec.settings section with the required module parameters. If necessary, specify the schema version in the spec.version parameter.

    Apply the manifest using the following command (indicate the manifest file name):

    d8 k apply -f <FILENAME>
    

    Example of a manifest for ModuleConfig okmeter:

    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

  • settings
    object
    • settings.apiKey
      string

      Required value

      Key to access Okmeter API.

      You can get the key from your personal Okmeter account (OKMETER_API_TOKEN).

      Example:

      apiKey: 5ff9z2a3-9127-1sh4-2192-06a3fc6e13e3
      
    • settings.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

    • settings.image
      object
      • settings.image.repository
        string

        Required value

        Docker repository for okmeter agent image.

        Default: registry.okmeter.io/agent/okagent

      • settings.image.tag
        string

        Required value

        Okmeter agent image tag.

        Default: latest

    • settings.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
      
    • settings.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.

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