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

The module lifecycle stage: General Availability

The module does not have any mandatory parameters.

The module has 1 alert.

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…

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 monitoring-ping 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 monitoring-ping

  • Using ModuleConfig monitoring-ping.

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

    Example of a manifest to enable module monitoring-ping:

    apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: monitoring-ping
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 monitoring-ping 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 monitoring-ping on the “YAML” tab in the module settings window (“System” → “System Management” → “Deckhouse” → “Modules”, open the module monitoring-ping) 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 monitoring-ping (for more details on configuring Deckhouse, see the documentation) by executing the following command:

    d8 k edit mc monitoring-ping

    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 monitoring-ping 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 monitoring-ping:

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

Requirements

To the versions of other modules:

  • monitoring-kubernetes: any version.

Parameters

Schema version: 1

  • settings
    object
    • settings.externalTargets
      array 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
      • settings.externalTargets.host
        string

        Required value

        IP address or host name to monitor.

      • settings.externalTargets.name
        string

        Monitoring record name.