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

The module lifecycle stage: General Availability

The module has 39 alerts.

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

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 node-manager 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 node-manager

  • Using ModuleConfig node-manager.

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

    Example of a manifest to enable module node-manager:

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

    d8 k edit mc node-manager

    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 node-manager 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 node-manager:

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

Conversions

The module is configured using the ModuleConfig resource, the schema of which contains a version number. When you apply an old version of the ModuleConfig schema in a cluster, automatic transformations are performed. To manually update the ModuleConfig schema version, the following steps must be completed sequentially for each version :

  • Updates from version 1 to 2:

    Delete allowedKubernetesVersions and allowedBundles.

  • Updates from version 2 to 3:

    Delete earlyOomEnabled.

Parameters

Schema version: 3

  • settings
    object
    • settings.capiEmergencyBrake
      boolean

      Set to ‘true’ to disable CAPI in case of potentially cluster-damaging changes.

      Warning. Use this flag only if you fully understand the consequences.

      Default: false

      Example:

      capiEmergencyBrake: false
    • settings.instancePrefix
      string

      The prefix to use when creating instances via the corresponding cloud provider module.

      The default value can be calculated based on the ClusterConfiguration struct if the cluster is installed via the Deckhouse installer.

      Example:

      instancePrefix: kube
    • settings.mcmEmergencyBrake
      boolean

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

      Set to ‘true’ to disable machine-controller-manager in case of potentially cluster-damaging changes.

      Warning. Use this flag only if you fully understand the consequences.

      Default: false

      Example:

      mcmEmergencyBrake: false