This feature is available in Enterprise Edition only.

OpenStackClusterConfiguration

Version: deckhouse.io/v1

  • apiVersionstring

    Required value

    Allowed values: deckhouse.io/v1, deckhouse.io/v1alpha1

  • kindstring

    Required value

    Allowed values: OpenStackClusterConfiguration

  • layoutstring

    Required value

    The way resources are located in the cloud.

    Read more about possible provider layouts.

  • masterNodeGroup

    Required value

    The definition of the master’s NodeGroup.

    • instanceClassobject

      Required value

      Partial contents of the fields of the OpenStackInstanceClass.

      • additionalSecurityGroupsarray of strings

        Security groups that will be applied to VM’s network ports in addition to security groups set in a cloud provider configuration.

        They allow you to set firewall rules for provisioned instances.

        The SecurityGroups may not be supported by the cloud provider.

      • additionalTagsobject

        The additional tags to attach to the instances created (in addition to those specified in the cloud provider configuration).

        Example:

        additionalTags:
          project: cms-production
          severity: critical
        
      • flavorNamestring

        Required value

        Flavor of OpenStack servers.

        Get a list of all available flavors: openstack flavor list.

        For all non-master nodes it is advisable to use flavor’s with a local disk. If cloud provider supports local disks they are usually faster and cheaper. The disadvantage of using such flavors is the inability to migrate nodes between hypervisors.

        Flavor create example: openstack flavor create c4m8d50 --ram 8192 --disk 50 --vcpus 4

      • imageNamestring

        Required value

        Image to use while provisioning OpenStack servers.

        Use this command to get a list of available images: openstack image list.

        Caution! Currently, only Ubuntu 18.04, Ubuntu 20.04, Ubuntu 22.04, Centos 7, Centos 8, Centos 9, Debian 9, Debian 10, Debian 11 are supported and tested to work.

      • rootDiskSizeinteger

        The size of a root disk (in gigabytes).

        This parameter also has influence on type of volume that will be used for root disk; the “How to use rootDiskSize and when it is preferred” section describes how to use it.

    • replicasinteger

      Required value

      The number of master nodes to create.

      Allowed values: 1 <= X

    • volumeTypeMapobject

      Required value

      A dictionary of disk types for storing etcd data and Kubernetes configuration files.

      If the rootDiskSize parameter is specified, the same disk type will be used for the VM’s boot drive.

      We recommend using the fastest disks provided by the provider in all cases.

      If the value specified in replicas exceeds the number of elements in the dictionary, the master nodes whose number exceeds the length of the dictionary get the values starting from the beginning of the dictionary. For example, if replicas: 5, then master-0, master-2, master-4 will have the ru-1a disk type, while master-1, master-3 will have the ru-1b disk type

      Example:

      volumeTypeMap:
        ru-1a: fast-ru-1a
        ru-1b: fast-ru-1b
      
  • nodeGroupsarray of objects

    An array of additional NodeGroups for creating static nodes (e.g., for dedicated front nodes or gateways).

    • instanceClassobject

      Required value

      Partial contents of the fields of the OpenStackInstanceClass.

      • additionalNetworksarray of strings

        Paths to networks that VirtualMachines’ secondary NICs will connect to.

        Example:

        additionalNetworks:
        - BGP-network-VLAN-3894
        - External-VLAN-3699
        
      • additionalSecurityGroupsarray of strings

        Security groups that will be applied to VM’s network ports in addition to security groups set in a cloud provider configuration.

        They allow you to set firewall rules for provisioned instances.

        The SecurityGroups may not be supported by the cloud provider.

      • additionalTagsobject

        The additional tags to attach to the instances created (in addition to those specified in the cloud provider configuration).

        Example:

        additionalTags:
          project: cms-production
          severity: critical
        
      • configDriveboolean

        Not required value.

        Specifies whether an additional disk containing the bootstrapping configuration will be mounted to the node.

        You must set it if DHCP is disabled in the mainNetwork.

        Default: false

      • flavorNamestring

        Required value

        Flavor of OpenStack servers.

        Get a list of all available flavors: openstack flavor list.

        For all non-master nodes it is advisable to use flavor’s with a local disk. If cloud provider supports local disks they are usually faster and cheaper. The disadvantage of using such flavors is the inability to migrate nodes between hypervisors.

        Flavor create example: openstack flavor create c4m8d50 --ram 8192 --disk 50 --vcpus 4

      • floatingIPPoolsarray of strings

        A list of networks to assign Floating IPs to nodes.

      • imageNamestring

        Required value

        Image to use while provisioning OpenStack servers.

        Use this command to get a list of available images: openstack image list.

        Caution! Currently, only Ubuntu 18.04, Ubuntu 20.04, Ubuntu 22.04, Centos 7, Centos 8, Centos 9, Debian 9, Debian 10, Debian 11 are supported and tested to work.

      • mainNetworkstring

        Required value

        Path to the network that VirtualMachines’ primary NICs will connect to (default gateway).

      • networksWithSecurityDisabledarray of strings

        A list of mainNetwork and additionalNetworks in which SecurityGroups and AllowedAddressPairs on ports CANNOT be configured.

      • rootDiskSizeinteger

        The size of a root disk (in gigabytes).

        This parameter also has influence on type of volume that will be used for root disk; the “How to use rootDiskSize and when it is preferred” section describes how to use it.

    • namestring

      Required value

      The name of the NodeGroup to use for generating node names.

    • nodeTemplate

      Parameters of Node objects in Kubernetes to add after registering the node.

      • annotationsobject

        The same as the metadata.annotations standard field.

        Example:

        annotations:
          ai.fleet.com/discombobulate: "true"
        
      • labelsobject

        A list of labels to attach to cluster resources.

        The same as the metadata.labels standard field.

        Note that you have to re-create all the machines to add new tags if tags were modified in the running cluster.

        Example:

        labels:
          environment: production
          app: warp-drive-ai
        
      • taintsarray of objects

        The same as the .spec.taints field of the Node object.

        Caution! Only the effect, key, values fields are available.

        Example:

        taints:
        - effect: NoExecute
          key: ship-class
          value: frigate
        
        • effectstring

          Allowed values: NoSchedule, PreferNoSchedule, NoExecute

        • keystring
        • valuestring
    • replicasinteger

      Required value

      The number of nodes to create.

    • zonesarray of strings

      Not required value.

      A limited set of zones in which nodes can be created.

  • providerobject

    Required value

    Contains settings to connect to the OpenStack API.

    These settings are the same as those in the connection field of the cloud-provider-openstack module.

    • authURLstring

      An OpenStack Identity API URL.

    • caCertstring

      Specify the CA x509 certificate used for signing if the OpenStack API has a self-signed certificate. Certificate should be passed in PEM format as multiline string.

      Example:

      caCert: |
        -----BEGIN CERTIFICATE-----
        MIIFyDCCBLCgAwIBAgIQBwDIWH1asdaKNaALUa4NUzANBgkqhkiG9w0BAQsFADBc
        ...
        -----END CERTIFICATE-----
      
    • domainNamestring

      The domain name.

    • passwordstring

      The user’s password.

    • regionstring

      The OpenStack region where the cluster will be deployed.

    • tenantIDstring

      The project id.

      Cannot be used together with tenantName.

    • tenantNamestring

      The project name.

      Cannot be used together with tenantID.

    • usernamestring

      The name of the user that has full project privileges.

  • simpleobject

    Settings for the Simple layout.

    • externalNetworkDHCPboolean

      This parameter defines if DHCP is enabled in the external network.

      Default: true

    • externalNetworkNamestring

      Required value

      The name of the network for external connections.

    • podNetworkModestring

      Sets the traffic mode for the network that the pods use to communicate with each other (usually, it is an internal network; however, there can be exceptions):

      • DirectRouting — nodes are directly routed (SecurityGroups are disabled in this mode).
      • VXLAN — direct routing does NOT work between nodes, VXLAN must be used (SecurityGroups are disabled in this mode).

      Caution! After changing this parameter, you need to run dhctl converge.

      Caution! All cluster nodes must be rebooted after switching work mode from/to VXLAN.

      Default: "VXLAN"

      Allowed values: VXLAN, DirectRouting

  • simpleWithInternalNetworkobject

    Settings for the SimpleWithInternalNetwork layout.

    • externalNetworkNamestring

      The name of the network for external connections.

    • internalSubnetNamestring

      Required value

      The name of the subnet in which the cluster nodes will run.

    • masterWithExternalFloatingIPboolean

      Defines if Floating IP must be assigned to master nodes.

      Default: true

    • podNetworkModestring

      Sets the traffic mode for the network that the pods use to communicate with each other (usually, it is an internal network; however, there can be exceptions):

      • DirectRouting — nodes are directly routed (SecurityGroups are disabled in this mode).
      • DirectRoutingWithPortSecurityEnabled — direct routing is enabled between the nodes, but only if the range of addresses of the internal network is explicitly allowed in OpenStack for Ports:
        • Caution! Make sure that the username can edit AllowedAddressPairs on Ports connected to the internalNetworkName network. Usually, an OpenStack user doesn’t have such a privilege if the network has the shared flag set.
      • VXLAN — direct routing does NOT work between nodes, VXLAN must be used (SecurityGroups are disabled in this mode).

      Caution! After changing this parameter, you need to run dhctl converge.

      Caution! All cluster nodes must be rebooted after switching work mode from/to VXLAN.

      Default: "DirectRoutingWithPortSecurityEnabled"

      Allowed values: VXLAN, DirectRouting, DirectRoutingWithPortSecurityEnabled

  • sshAllowListarray of strings

    A list of CIDR’s allowed to connect to nodes via ssh.

    By default, 0.0.0.0/0.

  • sshPublicKeystring

    Required value

    A public key for accessing nodes.

  • standardobject

    Settings for the Standard layout.

    • bastionobject

      The definition of the bastion instance.

      • instanceClassobject

        Partial contents of the fields of the OpenStackInstanceClass.

        • additionalTagsobject

          The additional tags to attach to the instance created (in addition to those specified in the cloud provider configuration).

          Example:

          additionalTags:
            project: cms-production
            severity: critical
          
        • flavorNamestring

          Required value

          Flavor of OpenStack servers.

          Get a list of all available flavors: openstack flavor list.

        • imageNamestring

          Required value

          Image to use while provisioning OpenStack servers.

          Use this command to get a list of available images: openstack image list.

          Caution! Currently, only Ubuntu 18.04, Ubuntu 20.04, Ubuntu 22.04, Centos 7, Centos 8, Debian 9, Debian 10, Debian 11 are supported and tested to work.

        • rootDiskSizeinteger

          The size of a root disk (in gigabytes).

          This parameter also has influence on type of volume that will be used for root disk; the “How to use rootDiskSize and when it is preferred” section describes how to use it.

      • volumeTypestring

        Root disk type.

      • zonestring

        The zone to create an instance for the bastion node.

    • externalNetworkNamestring

      Required value

      The name of the network for external connections.

    • internalNetworkCIDRstring

      Required value

      Routing for the internal cluster network.

      Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/(3[0-2]|[1-2][0-9]|[0-9]))$

    • internalNetworkDNSServersarray of strings

      Required value

      A list of addresses of the recursive DNSs of the internal cluster network.

      • Element of the arraystring

        Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$

    • internalNetworkSecurityboolean

      Defines whether SecurityGroups and AllowedAddressPairs must be configured for ports of the internal network.

      Default: true

  • standardWithNoRouterobject

    Settings for the StandardWithNoRouter layout.

    • externalNetworkDHCPboolean

      This parameter defines if DHCP is enabled in the external network.

      Default: true

    • externalNetworkNamestring

      Required value

      The name of the network for external connections.

    • internalNetworkCIDRstring

      Required value

      Routing for the internal cluster network.

      Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/(3[0-2]|[1-2][0-9]|[0-9]))$

    • internalNetworkSecurityboolean

      Defines whether SecurityGroups and AllowedAddressPairs must be configured for ports of the internal network.

      Default: true

  • tagsobject

    Not required value.

    A dictionary of tags to create on all resources that support this feature.

    You have to re-create all the machines to add new tags if tags were modified in the running cluster.

  • zonesarray of strings

    Not required value.

    The globally restricted set of zones that this Cloud Provider works with.