OpenStackClusterConfiguration
Version: deckhouse.io/v1
Describes the configuration of a cloud cluster in OpenStack.
Used by the cloud provider if a cluster’s control plane is hosted in the cloud.
Run the following command to change the configuration in a running cluster:
kubectl -n d8-system exec -ti svc/deckhouse-leader -c deckhouse -- deckhouse-controller edit provider-cluster-configuration
After updating the node parameters, you need to run the dhctl converge command to apply the changes.
Example:
apiVersion: deckhouse.io/v1
kind: OpenStackClusterConfiguration
layout: Standard
sshPublicKey: "<SSH_PUBLIC_KEY>"
zones:
- eu-3a
standard:
internalNetworkDNSServers:
- 8.8.8.8
internalNetworkCIDR: 192.168.195.0/24
internalNetworkSecurity: false
externalNetworkName: external-network
provider:
authURL: "<AUTH_URL>"
domainName: "<DOMAIN_NAME>"
tenantID: "<TENANT_ID>"
username: "<USERNAME>"
password: "<PASSWORD>"
region: eu-3
masterNodeGroup:
replicas: 1
instanceClass:
rootDiskSize: 50
flavorName: m1.large
imageName: debian-11-genericcloud-amd64-20220911-1135
volumeTypeMap:
eu-3a: fast.eu-3a
nodeGroups:
- name: front
replicas: 2
instanceClass:
flavorName: m1.large
imageName: debian-11-genericcloud-amd64-20220911-1135
rootDiskSize: 50
configDrive: false
floatingIPPools:
- public
- shared
additionalSecurityGroups:
- sec_group_1
- sec_group_2
zones:
- eu-1a
- eu-1b
- string
Required value
The way resources are located in the cloud.
Read more about possible provider layouts.
Required value
The definition of the master’s NodeGroup.
For the changes to take effect, run
dhctl converge
after modifying the parameters of themasterNodeGroup
section.- array of strings
Security groups that will be applied to VM’s network ports. Default group should also be added to this list.
They allow you to set firewall rules for provisioned instances.
The
SecurityGroups
may not be supported by the cloud provider. - object
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
- string
Required value
Flavor of OpenStack servers.
To get a list of all available flavors, run the command:
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
- string
Required value
Image to use while provisioning OpenStack servers.
Use this command to get a list of available images:
openstack image list
.The list of OS and their versions supported by Deckhouse can be found in the documentation (take into account the Deckhouse version used).
- integer
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.
- object
Object groups instances together. The instances in the group are placed on the same hypervisor (affinity) or different hypervisors (anti-affinity). This allows you to increase the fault tolerance of the cluster.
- string
Required value
The policy that determines how instances are distributed among hypervisors.
AntiAffinity
— instances are placed on different hypervisors. This policy is managed by Deckhouse.ManuallyManaged
— instances are placed on different hypervisors. This policy is managed outside of Deckhouse.
Allowed values:
AntiAffinity
,ManuallyManaged
- object
Required value
A dictionary of disk types for storing etcd data and Kubernetes configuration files.
Format of dictionary elements:
<AVAILABILITY ZONE>: <VOLUME TYPE>
(see the example).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, ifreplicas: 5
, then master-0, master-2, master-4 will have thefast-eu-1a
disk type, while master-1, master-3 will have thefast-eu-1b
disk type.Master nodes will be created in zones specified at this param following by alphabetical order. Based on the example below,
master-0
will be created in zoneeu-1a
,master-1
will be created in zoneeu-1b
, andmaster-2
will be created in zoneeu-1a
.Useful commands:
openstack availability zone list
— get list of availability zones.openstack volume type list
— get list of volume types.
Example:
volumeTypeMap: eu-1a: fast-eu-1a eu-1b: fast-eu-1b
- array of objects
An array of additional NodeGroups for creating static nodes (e.g., for dedicated front nodes or gateways).
- array of strings
Security groups that will be applied to VM’s network ports. Default group should also be added to this list.
They allow you to set firewall rules for provisioned instances.
The
SecurityGroups
may not be supported by the cloud provider. - object
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
- string
Required value
Flavor of OpenStack servers.
To get a list of all available flavors, run the command:
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
- string
Required value
Image to use while provisioning OpenStack servers.
Use this command to get a list of available images:
openstack image list
.The list of OS and their versions supported by Deckhouse can be found in the documentation (take into account the Deckhouse version used).
- integer
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.
- object
The same as the
metadata.annotations
standard field.Example:
annotations: ai.fleet.com/discombobulate: 'true'
- object
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
- array of objects
The same as the
.spec.taints
field of the Node object.Available fields:
effect
,key
, andvalues
.Example:
taints: - effect: NoExecute key: ship-class value: frigate
- object
A dictionary of disk types for root drive.
Format of dictionary elements:
<AVAILABILITY ZONE>: <VOLUME TYPE>
(see the example).If the value specified in
replicas
exceeds the number of elements in the dictionary, the nodes whose number exceeds the length of the dictionary get the values starting from the beginning of the dictionary. For example, ifreplicas: 5
, then worker-0, worker-2, worker-4 will have thefast-eu-1a
disk type, while worker-1, worker-3 will have thefast-eu-1b
disk type.Caution. Limits by availability zones works only when using the
zones
parameter (nodeGroups.zones
). Ifzones
parameter is not specified, all availability zones will be used.Useful commands:
openstack availability zone list
— get list of availability zones.openstack volume type list
— get list of volume types.
Example:
volumeTypeMap: eu-1a: fast-eu-1a eu-1b: fast-eu-1b
- object
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.- string
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-----
- string
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
command for the changes to take effect.Caution. All cluster nodes must be rebooted after switching work mode from/to VXLAN.
Default:
"VXLAN"
Allowed values:
VXLAN
,DirectRouting
- string
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 editAllowedAddressPairs
on Ports connected to theinternalNetworkName
network. Usually, an OpenStack user doesn’t have such a privilege if the network has theshared
flag set.
- Caution. Make sure that the
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
command for the changes to take effect.Caution. All cluster nodes must be rebooted after switching work mode from/to VXLAN.
Default:
"DirectRoutingWithPortSecurityEnabled"
Allowed values:
VXLAN
,DirectRouting
,DirectRoutingWithPortSecurityEnabled
- object
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
- string
Required value
Image to use while provisioning OpenStack servers.
Use this command to get a list of available images:
openstack image list
.The list of OS and their versions supported by Deckhouse can be found in the documentation (take into account the Deckhouse version used).
- integer
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.
Default:
50
- array of strings
Required value
A list of addresses of the recursive DNSs of the internal cluster network.
- boolean
Defines whether SecurityGroups and AllowedAddressPairs must be configured for ports of the internal network.
Default:
true
- boolean
Defines whether SecurityGroups and AllowedAddressPairs must be configured for ports of the internal network.
Default:
true
- object
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.