Available in editions:  Ultimate/EE, SE+

Included in extensions: On-prem IaaS

The module lifecycle stage: General Availability

The module has 1 alert.

The module is not enabled by default in any bundles.

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 cloud-provider-zvirt 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 cloud-provider-zvirt
    
  • Using ModuleConfig cloud-provider-zvirt.

    Set spec.enabled to true or false in ModuleConfig cloud-provider-zvirt (create it if necessary);

    Example of a manifest to enable module cloud-provider-zvirt:

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

    d8 k edit mc cloud-provider-zvirt
    

    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 cloud-provider-zvirt 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 cloud-provider-zvirt:

    apiVersion: deckhouse.io/v1alpha1
    kind: ModuleConfig
    metadata:
      name: cloud-provider-zvirt
    spec:
      version: 2
      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:

    The settings are grouped under the provider, nodes, storage, and ccm parameters.

    The conversion sets temporary values for the server, clusterID, and sshPublicKey parameters. Replace them with the actual values.

    The zVirt login and password are not stored in the module settings. The module reads them from the d8-credentials Secret of the cloud-provider.deckhouse.io/credentials type.

Parameters

Schema version: 2

  • settings
    object
    • settings.ccm
      object

      Cloud Controller Manager (CCM) subsystem settings.

      CCM keeps the cluster node metadata up to date and removes from the cluster the nodes whose virtual machines no longer exist in zVirt.

      • settings.ccm.disabled
        boolean

        Disables the Cloud Controller Manager.

        When set to true, the module does not deploy CCM.

        Default: false

      • settings.ccm.parameters
        object

        Required value

        Parameters of the CCM subsystem.

    • settings.nodes
      object

      Required value

      Nodes subsystem settings.

      The subsystem describes how the cluster nodes are created in zVirt, including the layout, the SSH key, and the static network configuration.

      • settings.nodes.disabled
        boolean

        Disables the nodes subsystem.

        When set to true, the cluster does not create CloudEphemeral nodes in zVirt.

        Default: false

      • settings.nodes.parameters
        object

        Required value

        Parameters of the nodes subsystem.

        • settings.nodes.parameters.customNetworkConfigs
          object

          Static network configuration of the nodes of CloudPermanent NodeGroups.

          The key is the name of a CloudPermanent NodeGroup, for example master. Nodes of a NodeGroup that is not listed get their network settings over DHCP.

          Addresses from the networkInterfaceAddresses list are assigned by node index. The first address goes to the node with index 0, the second address goes to the node with index 1, and so on. If the list holds fewer addresses than the NodeGroup has replicas, the remaining nodes get their addresses over DHCP.

          • settings.nodes.parameters.customNetworkConfigs.<KEY_NAME>
            object

            <KEY_NAME> — item (key) name.

            Static network configuration of a node network interface.

            • settings.nodes.parameters.customNetworkConfigs.<KEY_NAME>.dnsServers
              array of strings

              List of DNS servers.

              Example:

              dnsServers:
              - 8.8.8.8
              - 8.8.4.4
              
            • settings.nodes.parameters.customNetworkConfigs.<KEY_NAME>.networkInterfaceAddresses
              array of strings

              Required value

              List of IP addresses to assign to the interface, one address per node.

              Example:

              networkInterfaceAddresses:
              - 192.168.1.10
              - 192.168.1.11
              
            • settings.nodes.parameters.customNetworkConfigs.<KEY_NAME>.networkInterfaceGateway
              string

              Required value

              Default network gateway.

              Example:

              networkInterfaceGateway: 192.168.1.1
              
            • settings.nodes.parameters.customNetworkConfigs.<KEY_NAME>.networkInterfaceName
              string

              Required value

              Name of the network interface to apply the static configuration to.

              Example:

              networkInterfaceName: enp1s0
              
            • settings.nodes.parameters.customNetworkConfigs.<KEY_NAME>.networkInterfaceNetmask
              string

              Required value

              Subnet mask for the interface.

              Example:

              networkInterfaceNetmask: 255.255.255.0
              
        • settings.nodes.parameters.layout
          string

          Required value

          Layout name.

          The available layouts are described in “Layouts”.

          Allowed values: Standard

        • settings.nodes.parameters.sshPublicKey
          string

          Required value

          Public SSH key for accessing the nodes.

    • settings.provider
      object

      Required value

      zVirt connection settings.

      • settings.provider.parameters
        object

        Required value

        Parameters for connecting to the zVirt API.

        The login and the password are not set in the module settings. The module reads them from the d8-credentials Secret of the cloud-provider.deckhouse.io/credentials type in the d8-cloud-provider-zvirt namespace.

        • settings.provider.parameters.caBundle
          string

          Base64-encoded bundle of CA certificates in PEM format to verify the zVirt API certificate.

          When the insecure parameter is set to true, the bundle is ignored.

        • settings.provider.parameters.clusterID
          string

          Required value

          ID of the zVirt cluster to create virtual machines in.

          The cluster must have shared storage domains and CPUs of the same type.

          Pattern: ^[\da-fA-F]{8}\-[\da-fA-F]{4}\-[\da-fA-F]{4}\-[\da-fA-F]{4}\-[\da-fA-F]{12}$

          Example:

          clusterID: 49bb4594-0cd4-4eb7-8288-8594eafd5a86
          
        • settings.provider.parameters.insecure
          boolean

          Disables verification of the zVirt API certificate.

          Set to true if zVirt uses a self-signed certificate.

          Default: false

        • settings.provider.parameters.server
          string

          Required value

          URL of the zVirt API endpoint.

          Specify a URL with the http or https scheme.

    • settings.storage
      object

      Storage subsystem settings.

      The subsystem provides the CSI driver and the StorageClasses for zVirt storage domains.

      • settings.storage.disabled
        boolean

        Disables the storage subsystem.

        When set to true, disk provisioning in the cluster is unavailable.

        Default: false

      • settings.storage.parameters
        object

        Required value

        Parameters of the storage subsystem.

        • settings.storage.parameters.excludedStorageClasses
          array of strings

          List of StorageClasses to exclude from creation in the cluster.

          The module creates a StorageClass for each active zVirt storage domain. Each item of the list is a regular expression matched against the whole StorageClass name. For example, data excludes only the data StorageClass, and data.* excludes every StorageClass whose name starts with data.