How to install MicroCloud¶
Pre-deployment requirements¶
The requirements in this section apply to all MicroCloud deployments.
A physical or virtual machine intended for use as a MicroCloud cluster member must meet the following prerequisites:
Software:
Ubuntu 22.04 or newer (LTS version recommended)
If you intend to use ZFS storage, use a non-HWE (Hardware Enabled) variant of Ubuntu 22.04
snapd 2.59 or newer
Networking:
Fixed IP addresses (DHCP not supported)
At least two network interfaces per cluster member: one for intra-cluster communication and one for external connectivity to the uplink network
Partially or fully disaggregated networking setups require more interfaces; see: How to configure Ceph networking
To use a dedicated underlay network for OVN traffic, an additional interface per cluster member is required
Uplink network must support both broadcast and multicast
Intra-cluster interface must have IPs assigned; external connectivity interface (to uplink) must not have any IPs assigned
Storage:
Disks should be free of existing partitions or file systems
For local storage, each cluster member must have at least one local disk
If you intend to use full disk encryption on a cluster member, it must have
snapdversion2.59.1or newer installed and thedm-cryptkernel module availableTo check if the module exists, run:
sudo modinfo dm-crypt
Important
These requirements are in addition to those listed in the General tab.
Physical or virtual machines can be used
Minimum cluster size:
1 member
Memory:
Minimum 8 GiB RAM per cluster member
Storage:
If high availability is required, use distributed storage with:
a minimum of 3 cluster members
a minimum of 3 separate disks located across 3 different members
Otherwise, local storage is sufficient
Important
These requirements are in addition to those listed in the General tab.
Physical machines only (no VMs)
Minimum cluster size:
3 members
For critical deployments, we recommend a minimum of 4 members
Memory:
Minimum 32 GiB RAM per cluster member
Software:
For production deployments subscribed to Ubuntu Pro, each cluster member must use a LTS version of Ubuntu
Networking:
For each cluster member, we recommend dual-port network cards with a minimum 10 GiB capacity, or higher if low latency is essential
Storage:
For each cluster member, we recommend at least 3 NVMe disks:
1 for OS
1 for local storage
1 for distributed storage
For detailed information, see: Requirements.
Installation¶
To install MicroCloud, install all required Snaps on all machines that you want to include in your cluster.
To do so, enter the following commands on all machines:
sudo snap install lxd --channel=5.21/stable --cohort="+"
sudo snap install microceph --channel=squid/stable --cohort="+"
sudo snap install microovn --channel=24.03/stable --cohort="+"
sudo snap install microcloud --channel=2/stable --cohort="+"
Note
Make sure to install the same version of the snaps on all machines. See How to manage the snaps for more information.
If you don’t want to use MicroCloud’s full functionality, you can install only some of the snaps. However, this is not recommended.
After installing the snaps make sure to hold any automatic updates to keep the used snap versions across MicroCloud in sync. See Hold updates for more information.