The module lifecycle stage: General Availability

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

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 commander-agent 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 commander-agent

  • Using ModuleConfig commander-agent.

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

    Example of a manifest to enable module commander-agent:

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

    d8 k edit mc commander-agent

    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 commander-agent 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 commander-agent:

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

Requirements

To the Deckhouse version: 1.68 and above.

Parameters

Schema version: 1

  • settings
    object
    • settings.ca
      string

      The certificate authority public key of the certificate used by the commander server.

      This parameter is ignored if the HTTP protocol is used to connect to the commander.

      Default:

    • settings.commanderUrl
      string
      The URL of the commander server.

      Example: 


      commanderUrl: https://commander.dev/agent_api/00000000-0000-0000-0000-000000000000
    • settings.insecureSkipVerify
      boolean

      Skip verification of the certificate used by the commander server.

      This parameter is ignored if the HTTP protocol is used to connect to the commander.

      Default: false

      Example: 


      insecureSkipVerify: true
    • settings.logLevel
      string
      Log level.

      Default: info

      Allowed values: error, warn, info, debug, trace

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

    • 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