Available in:  Open/CE, Core, BE, SE, SE+, Ultimate/EE

Included in extensions:  Advanced Storage, Core Storage, Storage Integration

The module lifecycle stage: Experimental

The module has requirements for installation

Before enabling the module, you need to allow the use of experimental modules in the deckhouse ModuleConfig. To do this, set the allowExperimentalModules parameter to true.

The module works only in Kubernetes clusters from version 1.20 onward.

The module generally requires no configuration.

How to explicitly enable or disable 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 storage-foundation 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 storage-foundation

  • Using ModuleConfig storage-foundation.

    Set spec.enabled to true or false in ModuleConfig storage-foundation (create it if necessary).

    Example of a manifest to enable module storage-foundation:

    apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: storage-foundation
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 storage-foundation module and enable the “Advanced Settings” toggle. Fill in the required fields in the “Configuration” tab or specify the module settings in YAML format on the “YAML” tab, without the top-level settings key. Save the changes.

    Example:

    Module settings interface

    You can also edit the ModuleConfig object storage-foundation on the “YAML” tab in the module settings window (“System” → “System Management” → “Deckhouse” → “Modules”, open the module storage-foundation) 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 storage-foundation (for more details on configuring Deckhouse Platform, see the documentation) by executing the following command:

    d8 k edit mc storage-foundation

    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 manifest file for ModuleConfig storage-foundation 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 storage-foundation:

    apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: storage-foundation
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 steps in How do I change the release channel for a module?.

Requirements

To the Deckhouse Platform version: 1.74 and above.

To the versions of other modules:

  • state-snapshotter: any version.

Parameters

Schema version: 1

  • settings
    object
    • settings.highAvailability
      boolean

      Manually enable the high availability mode.

      By default, Deckhouse automatically decides whether to enable the HA mode. Click here to learn more about the HA mode for modules.

      Examples: 

      highAvailability: true

      highAvailability: false
    • settings.logLevel
      string
      Logging level for the module components.

      Default: DEBUG

      Allowed values: ERROR, WARN, INFO, DEBUG, TRACE