The module does not have any mandatory parameters.

The module is enabled by default in the following bundles: Default, Managed. The module is disabled by default in the Minimal bundle.

How to explicitly enable the module…

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

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

Use the monitoringPing 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 monitoring-ping module:

apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: monitoring-ping
spec:
  enabled: true

Example of disabling the monitoring-ping module:

apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: monitoring-ping
spec:
  enabled: false

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

Example of the ModuleConfig/monitoring-ping resource for configuring the module:

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

Parameters

Schema version: 1

  • externalTargetsarray of objects

    A list of additional hosts to monitor.

    Example:

    - name: google-primary
      host: 8.8.8.8
    - name: yaru
      host: ya.ru
    - host: youtube.com
    
    • externalTargets.hoststring

      Required value

      IP address or host name to monitor.

    • externalTargets.namestring

      Monitoring record name.