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

The module lifecycle stageGeneral 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 local-path-provisioner 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 local-path-provisioner
    
  • Using ModuleConfig local-path-provisioner.

    Set spec.enabled to true or false in ModuleConfig local-path-provisioner (create it if necessary);

    Example of a manifest to enable module local-path-provisioner:

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

    d8 k edit mc local-path-provisioner
    

    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 local-path-provisioner 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 local-path-provisioner:

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

The module does not require any configuration.