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

The module lifecycle stage: Preview
The module has requirements for installation

If you are enabling a module in a cluster where you need to publish the web interfaces of DKP service components and other modules, ensure that the global parameter publicDomainTemplate is specified. If it is not specified, system HTTPRoute/Gateway/ListenerSet objects will be created incorrectly, and the web interfaces of DKP service components and other modules will not be published.

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 alb 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 alb

  • Using ModuleConfig alb.

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

    Example of a manifest to enable module alb:

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

    d8 k edit mc alb

    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 alb 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 alb:

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

How to change the module release channel…

To change the module release channel, follow the instruction.

Requirements

To the Deckhouse version: 1.76 and above.

Parameters

Schema version: 1

  • settings
    object
    • settings.logLevel
      string
      The logging level of the alb module.

      Default: Info

      Allowed values: Error, Warning, Info, Debug, Verbose

      Example: 


      logLevel: Info
    • settings.storageClass
      string

      The name of the StorageClass to use for storing GeoIP databases in the geoproxy StatefulSet.

      If omitted, the effective StorageClass is selected in the following order:

      1. alb.storageClass
      2. global.modules.storageClass
      3. the cluster default StorageClass

      Set it to false to use emptyDir instead of persistent storage.

      Changing this parameter does not migrate existing geoproxy StatefulSets or PVCs to another StorageClass. The new value is only used for newly created geoproxy StatefulSets.

      Examples: 


      storageClass: ceph-ssd

      storageClass: 'false'