Create a management cluster for the OpenStack provider¶

Available since 2.25.0

This section describes how to create an OpenStack-based management cluster using the Container Cloud Bootstrap web UI.

To create an OpenStack-based management cluster:

If you deploy Container Cloud on top of MOSK Victoria with Tungsten Fabric and use the default security group for newly created load balancers, add the following rules for the Kubernetes API server endpoint, Container Cloud application endpoint, and for the MKE web UI and API using the OpenStack CLI:
- direction='ingress'
- ethertype='IPv4'
- protocol='tcp'
- remote_ip_prefix='0.0.0.0/0'
- port_range_max and port_range_min:
  - '443' for Kubernetes API and Container Cloud application endpoints
  - '6443' for MKE web UI and API
Set up a bootstrap cluster.
Open the Container Cloud Bootstrap web UI.

Create a bootstrap region.

Bootstrap region configuration

In the Bootstrap Regions tab, create a bootstrap region:

Set the region name.
Select the required provider.
Optional. Recommended. Leave the Guided Bootstrap Region configuration check box selected. It enables the cluster creation helper in the next window with a series of guided steps for a complete setup of a functional management cluster.

The cluster creation helper contains the same configuration windows as in separate tabs of the left-side menu, but the helper enables the configuration of essential provider components one-by-one inside one modal window.

If you select this option, use the corresponding steps of this procedure described below for description of each tab in Guided Bootstrap Region configuration.
Click Save.

In the Status column of the Bootstrap regions page, monitor the bootstrap region readiness by hovering over the status icon of the bootstrap region.

Once the orange blinking status icon becomes green and Ready, the bootstrap region deployment is complete. If the cluster status is Error, refer to Troubleshooting.

You can monitor live deployment status of the following bootstrap region components:

Component	Status description
Helm	Installation status of bootstrap Helm releases
Provider	Status of provider configuration and installation for related charts and Deployments
Deployments	Readiness of all Deployments in the bootstrap cluster

Configure credentials for the new cluster.
Credentials configuration
In the Credentials tab:
1. Click Add Credential to add your OpenStack credentials. You can either upload your OpenStack clouds.yaml configuration file or fill in the fields manually.
2. Verify that the new credentials status is Ready. If the status is Error, hover over the status to determine the reason of the issue.
Optional. In the SSH Keys tab, click Add SSH Key to upload the public SSH key(s) for VMs creation.

Optional. Enable proxy access to the cluster.

Proxy configuration

In the Proxies tab, configure proxy:

Click Add Proxy.

In the Add New Proxy wizard, fill out the form with the following parameters:

Proxy configuration¶
Parameter	Description
Proxy Name	Name of the proxy server to use during cluster creation.
Region	From the drop-down list, select the required region.
HTTP Proxy	Add the HTTP proxy server domain name in the following format: `http://proxy.example.com:port` - for anonymous access `http://user:password@proxy.example.com:port` - for restricted access
HTTPS Proxy	Add the HTTPS proxy server domain name in the same format as for HTTP Proxy.
No Proxy	Comma-separated list of IP addresses or domain names.

For implementation details, see Proxy and cache support.

If your proxy requires a trusted CA certificate, select the CA Certificate check box and paste a CA certificate for a MITM proxy to the corresponding field or upload a certificate using Upload Certificate.

For the list of Mirantis resources and IP addresses to be accessible from the Container Cloud clusters, see Requirements for an OpenStack-based cluster.

In the Clusters tab, click Create Cluster and fill out the form with the following parameters:

Cluster configuration

Add Cluster name.
Set the provider Service User Name and Service User Password.

A Service User is the initial user to create in Keycloak for access to a newly deployed management cluster. By default, it has the global-admin, operator (namespaced), and bm-pool-operator (namespaced) roles.

You can delete serviceuser after setting up other required users with specific roles or after any integration with an external identity provider, such as LDAP.

Configure general provider settings and Kubernetes parameters:

Provider and Kubernetes configuration

Provider and Kubernetes configuration¶
Section	Parameter	Description
General Settings	Provider	Select OpenStack.
	Provider Credential	From the drop-down list, select the OpenStack credentials name that you have previously created.
	Release Version	The Container Cloud version.
	Proxy	Optional. From the drop-down list, select the proxy server name that you have previously created.
	SSH Keys	From the drop-down list, select the SSH key name(s) that you have previously added for SSH access to VMs.
	Container Registry	From the drop-down list, select the Docker registry name that you have previously added using the Container Registries tab. For details, see Define a custom CA certificate for a private Docker registry.
Provider	External Network	Type of the external network in the OpenStack cloud provider.
	DNS Name Servers	Comma-separated list of the DNS hosts IPs for the OpenStack VMs configuration.
	Configure Bastion	Optional. Configuration parameters for the Bastion node: Flavor Image Availability Zone Server Metadata For the parameters description, see Add a machine. Select Boot From Volume to boot the Bastion node from a block storage volume and select the required amount of storage (80 GB is enough).
Kubernetes	Node CIDR	The Kubernetes nodes CIDR block. For example, `10.10.10.0/24`.
	Services CIDR Blocks	The Kubernetes Services CIDR block. For example, `10.233.0.0/18`.
	Pods CIDR Blocks	The Kubernetes Pods CIDR block. For example, `10.233.64.0/18`. Note The network subnet size of Kubernetes pods influences the number of nodes that can be deployed in the cluster. The default subnet size `/18` is enough to create a cluster with up to 256 nodes. Each node uses the `/26` address blocks (64 addresses), at least one address block is allocated per node. These addresses are used by the Kubernetes pods with `hostNetwork: false`. The cluster size may be limited further when some nodes use more than one address block.

Configure StackLight:

StackLight configuration

Section	Parameter name	Description
StackLight	Enable Monitoring	Enabled by default, cannot be disabled. Enables StackLight monitoring deployment.
	Enable Logging	Enabled by default, cannot be disabled. Enables StackLight logging stack. For details about the logging components, see Deployment architecture. Note The logging mechanism performance depends on the cluster log load. In case of a high load, you may need to increase the default resource requests and limits for `fluentdLogs`. For details, see StackLight configuration parameters: Resource limits.
	HA Mode	Enabled by default, cannot be disabled. Enables StackLight monitoring in the HA mode. For the differences between HA and non-HA modes, see Deployment architecture.
	StackLight Default Logs Severity Level	Log severity (verbosity) level for all StackLight components. The default value for this parameter is Default component log level that respects original defaults of each StackLight component. For details about severity levels, see Log verbosity.
	StackLight Component Logs Severity Level	The severity level of logs for a specific StackLight component that overrides the value of the StackLight Default Logs Severity Level parameter. For details about severity levels, see Log verbosity. Expand the drop-down menu for a specific component to display its list of available log levels.
OpenSearch	Logstash Retention Time	Available if you select Enable Logging. Specifies the `logstash-*` index retention time.
	Events Retention Time	Available if you select Enable Logging. Specifies the `kubernetes_events-*` index retention time.
	Notifications Retention	Available if you select Enable Logging. Specifies the `notification-*` index retention time and is used for Mirantis OpenStack for Kubernetes.
	Persistent Volume Claim Size	Available if you select Enable Logging. The OpenSearch persistent volume claim size.
	Collected Logs Severity Level	Available if you select Enable Logging. The minimum severity of all Container Cloud components logs collected in OpenSearch. For details about severity levels, see Logging.
Prometheus	Retention Time	The Prometheus database retention period.
	Retention Size	The Prometheus database retention size.
	Persistent Volume Claim Size	The Prometheus persistent volume claim size.
	Enable Watchdog Alert	Select to enable the Watchdog alert that fires as long as the entire alerting pipeline is functional.
	Custom Alerts	Specify alerting rules for new custom alerts or upload a YAML file in the following exemplary format: - alert: HighErrorRate expr: job:request_latency_seconds:mean5m{job="myjob"} > 0.5 for: 10m labels: severity: page annotations: summary: High request latency For details, see Official Prometheus documentation: Alerting rules. For the list of the predefined StackLight alerts, see Operations Guide: Available StackLight alerts.
StackLight Email Alerts	Enable Email Alerts	Select to enable the StackLight email alerts.
	Send Resolved	Select to enable notifications about resolved StackLight alerts.
	Require TLS	Select to enable transmitting emails through TLS.
	Email alerts configuration for StackLight	Fill out the following email alerts parameters as required: To - the email address to send notifications to. From - the sender address. SmartHost - the SMTP host through which the emails are sent. Authentication username - the SMTP user name. Authentication password - the SMTP password. Authentication identity - the SMTP identity. Authentication secret - the SMTP secret.
StackLight Slack Alerts	Enable Slack alerts	Select to enable the StackLight Slack alerts.
	Send Resolved	Select to enable notifications about resolved StackLight alerts.
	Slack alerts configuration for StackLight	Fill out the following Slack alerts parameters as required: API URL - The Slack webhook URL. Channel - The channel to send notifications to, for example, #channel-for-alerts.
StackLight optional settings	Enable Reference Application	Available since Container Cloud 2.22.0. Enables Reference Application that is a small microservice application that enables workload monitoring on non-MOSK managed clusters.

Click Create.

Add machines to the bootstrap cluster:

Machines configuration

In the Clusters tab, click the required cluster name. The cluster page with Machines list opens.
On the cluster page, click Create Machine.

Fill out the form with the following parameters:

Container Cloud machine configuration¶
Parameter	Description
Count	Specify the odd number of machines to create. Only Manager machines are allowed. Caution The required minimum number of manager machines is three for HA. A cluster can have more than three manager machines but only an odd number of machines. In an even-sized cluster, an additional machine remains in the `Pending` state until an extra manager machine is added. An even number of manager machines does not provide additional fault tolerance but increases the number of node required for etcd quorum.
Flavor	From the drop-down list, select the required hardware configuration for the machine. The list of available flavors corresponds to the one in your OpenStack environment. For the hardware requirements, see Requirements for an OpenStack-based cluster.
Image	From the drop-down list, select the required cloud image: CentOS 7.9 Ubuntu 20.04 If you do not have the required image in the list, add it to your OpenStack environment using the Horizon web UI by downloading it from: Ubuntu official website CentOS-7-x86_64-GenericCloud-2009.qcow2 Warning A Container Cloud cluster based on both Ubuntu and CentOS operating systems is not supported.
Availability Zone	From the drop-down list, select the availability zone from which the new machine will be launched.
Configure Server Metadata	Optional. Select Configure Server Metadata and add the required number of string key-value pairs for the machine `meta_data` configuration in `cloud-init`. Prohibited keys are: `KaaS`, `cluster`, `clusterID`, `namespace` as they are used by Container Cloud.
Boot From Volume	Optional. Select to boot a machine from a block storage volume. Use the Up and Down arrows in the Volume Size (GiB) field to define the required volume size. This option applies to clouds that do not have enough space on hypervisors. After enabling this option, the Cinder storage is used instead of the Nova storage.

Click Create.

Optional. Using the Container Cloud CLI, modify the provider-specific and other cluster settings as described in Configure optional cluster settings.
Select from the following options to start cluster deployment:
If you use the Guided Bootstrap Region configuration

Click Deploy.

If you use the left-side web UI menu
Approve the previously created bootstrap region using the Container Cloud CLI:
./kaas-bootstrap/container-cloud bootstrap approve <bootstrapRegionName>
Caution

Once you approve the bootstrap region, no cluster or machine modification is allowed.

Monitor the deployment progress of the cluster and machines.

Monitoring of the cluster readiness

To monitor the cluster readiness, hover over the status icon of a specific cluster in the Status column of the Clusters page.

Once the orange blinking status icon becomes green and Ready, the cluster deployment or update is complete.

You can monitor live deployment status of the following cluster components:

Component	Description
Bastion	For the OpenStack-based management or regional clusters, the Bastion node IP address status that confirms the Bastion node creation
Helm	Installation or upgrade status of all Helm releases
Kubelet	Readiness of the node in a Kubernetes cluster, as reported by kubelet
Kubernetes	Readiness of all requested Kubernetes objects
Nodes	Equality of the requested nodes number in the cluster to the number of nodes having the `Ready` LCM status
OIDC	Readiness of the cluster OIDC configuration
StackLight	Health of all StackLight-related objects in a Kubernetes cluster
Swarm	Readiness of all nodes in a Docker Swarm cluster
LoadBalancer	Readiness of the Kubernetes API load balancer
ProviderInstance	Readiness of all machines in the underlying infrastructure (virtual or bare metal, depending on the provider type)
Graceful Reboot	Readiness of a cluster during a scheduled graceful reboot, available since Container Cloud 2.24.0 for non-MOSK clusters
Infrastructure Status	Available since Container Cloud 2.25.0 for bare metal and OpenStack providers. Readiness of the following cluster components: Bare metal: the `MetalLBConfig` object along with MetalLB and DHCP subnets. OpenStack: cluster network, routers, load balancers, and Bastion along with their ports and floating IPs.

For the history of a cluster deployment or update, refer to Inspect the history of a cluster and machine deployment or update.

Monitoring of machines readiness

To monitor machines readiness, use the status icon of a specific machine on the Clusters page.

Quick status
On the Clusters page, in the Managers column. The green status icon indicates that the machine is Ready, the orange status icon indicates that the machine is Updating.
Detailed status
In the Machines section of a particular cluster page, in the Status column. Hover over a particular machine status icon to verify the deploy or update status of a specific machine component.

You can monitor the status of the following machine components:

Component	Description
Kubelet	Readiness of a node in a Kubernetes cluster.
Swarm	Health and readiness of a node in a Docker Swarm cluster.
LCM	LCM readiness status of a node.
ProviderInstance	Readiness of a node in the underlying infrastructure (virtual or bare metal, depending on the provider type).
Graceful Reboot	Readiness of a machine during a scheduled graceful reboot of a cluster, available since Container Cloud 2.24.0 for non-MOSK clusters.
Infrastructure Status	Available since Container Cloud 2.25.0 for the bare metal provider only. Readiness of the `IPAMHost`, `L2Template`, `BareMetalHost`, and `BareMetalHostProfile` objects associated with the machine.

The machine creation starts with the Provision status. During provisioning, the machine is not expected to be accessible since its infrastructure (VM, network, and so on) is being created.

Other machine statuses are the same as the LCMMachine object states:

Uninitialized - the machine is not yet assigned to an LCMCluster.
Pending - the agent reports a node IP address and host name.
Prepare - the machine executes StateItems that correspond to the prepare phase. This phase usually involves downloading the necessary archives and packages.
Deploy - the machine executes StateItems that correspond to the deploy phase that is becoming a Mirantis Kubernetes Engine (MKE) node.
Ready - the machine is being deployed.
Upgrade - the machine is being upgraded to the new MKE version.
Reconfigure - the machine executes StateItems that correspond to the reconfigure phase. The machine configuration is being updated without affecting workloads running on the machine.

Once the status changes to Ready, the deployment of the cluster components on this machine is complete.

You can also monitor the live machine status using API:

kubectl get machines <machineName> -o wide

Example of system response since Container Cloud 2.23.0:

NAME   READY LCMPHASE  NODENAME              UPGRADEINDEX  REBOOTREQUIRED  WARNINGS
demo-0 true  Ready     kaas-node-c6aa8ad3    1             false

For the history of a machine deployment or update, refer to Inspect the history of a cluster and machine deployment or update.

Alternatively, verify machine statuses from the seed node on which the bootstrap cluster is deployed:

Log in to the seed node.
Export KUBECONFIG to connect to the bootstrap cluster:
```
export KUBECONFIG=~/.kube/kind-config-clusterapi
```
Verify the statuses of available LCMMachine objects:
```
kubectl get lcmmachines -o wide
```
Verify the statuses of available cluster machines:
```
kubectl get machines -o wide
```

Verify that network addresses used on your clusters do not overlap with the following default MKE network addresses for Swarm and MCR:
- 10.0.0.0/16 is used for Swarm networks. IP addresses from this network are virtual.
- 10.99.0.0/16 is used for MCR networks. IP addresses from this network are allocated on hosts.
Verification of Swarm and MCR network addresses
To verify Swarm and MCR network addresses, run on any master node:
docker info
Example of system response:
Server: ... Swarm: ... Default Address Pool: 10.0.0.0/16 SubnetSize: 24 ... Default Address Pools: Base: 10.99.0.0/16, Size: 20 ...
Not all of Swarm and MCR addresses are usually in use. One Swarm Ingress network is created by default and occupies the 10.0.0.0/24 address block. Also, three MCR networks are created by default and occupy three address blocks: 10.99.0.0/20, 10.99.16.0/20, 10.99.32.0/20.

To verify the actual networks state and addresses in use, run:
docker network ls docker network inspect <networkName>