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

The module lifecycle stage: General Availability

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 namespace-configurator 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 namespace-configurator

  • Using ModuleConfig namespace-configurator.

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

    Example of a manifest to enable module namespace-configurator:

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

    d8 k edit mc namespace-configurator

    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 namespace-configurator 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 namespace-configurator:

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

Parameters

Schema version: 1

  • settings
    object
    • settings.configurations
      array of objects
      • settings.configurations.annotations
        object

        A list of annotations in the key: "value" format.

        Example:

        annotations:
  example: 'true'
      • settings.configurations.excludeNames
        array of strings

        A list of namespace patterns to exclude.

        Default: []

        Example:

        excludeNames:
- infra-test
      • settings.configurations.includeNames
        array of strings

        Required value

        A list of namespace patterns to include.

        Default: []

        Example:

        includeNames:
- prod-.*
- infra-.*
      • settings.configurations.labels
        object

        A list of labels in the key: "value" format.

        Example:

        labels:
  istio-injection: 'true'