Install OpenStack yourself

This tutorial shows how to install MicroStack in the simplest way possible. It will deploy an OpenStack 2023.1 (Antelope) cloud.

The cloud will only allow access to its VMs from the local host. To enable access from any host on your network, follow the Single-node guided tutorial instead.

Requirements

You will need a single machine whose requirements are:

• physical or virtual machine running Ubuntu 22.04 LTS
• a multi-core amd64 processor ideally with 4+ cores
• a minimum of 16 GiB of free memory

Deploy the cloud

Install the openstack snap

Begin by installing the openstack snap:

sudo snap install openstack --channel 2023.1

Prepare the machine

Sunbeam can generate a script to ensure that the machine has all of the required dependencies installed and is configured correctly for use in MicroStack - you can review this script using:

sunbeam prepare-node-script

or the script can be directly executed in this way:

sunbeam prepare-node-script | bash -x && newgrp snap_daemon

The script will ensure some software requirements are satisfied on the host. In particular, it will:

• install openssh-server if it is not found
• configure passwordless sudo for all commands for the current user (NOPASSWD:ALL)

Bootstrap the cloud

Deploy the OpenStack cloud using the cluster bootstrap command and accept software defaults:

sunbeam cluster bootstrap --accept-defaults

Configure the cloud and obtain credentials

Now configure the deployed cloud using the configure command:

sunbeam configure --accept-defaults --openrc demo-openrc

The above command provides normal user credentials (file demo-openrc). Admin credentials can be obtained in this way (file admin-openrc):

sunbeam openrc > admin-openrc

Launch a VM

Verify the cloud by launching a VM called ‘test’ based on the ‘ubuntu’ image (Ubuntu 22.04 LTS). The launch command is used:

sunbeam launch ubuntu --name test

Sample output:

Launching an OpenStack instance ...
Access instance with `ssh -i /home/ubuntu/.config/openstack/sunbeam ubuntu@10.20.20.200`

Connect to the VM over SSH using the provided command. Note that the VM will not be ready instantaneously; waiting time is mostly determined by the cloud’s available resources.

Related howtos

Now that OpenStack is set up, be sure to check out the following howto guides:

• Accessing the OpenStack dashboard
• Using the OpenStack CLI

This tutorial shows how to install a multi-node MicroStack cluster. It will deploy an OpenStack 2023.1 (Antelope) cloud.

Requirements

You will need three machines, each of which has the following requirements:

• physical machine running Ubuntu 22.04 LTS
• a multi-core amd64 processor (ideally with 4+ cores)
• a minimum of 32 GiB of free memory
• 200 GiB of free disk on the root filesystem
• a least one un-partitioned disk of at least 200 GiB in size
• two network interfaces
  • primary: for access to the OpenStack control plane
  • secondary: for remote access to cloud VMs

Machine names

For the purpose of this tutorial, the following machine names are used:

Control plane networking

The network associated with the primary interface requires a ranage of approximately ten IP addresses that will be used for API service endpoints.

For the purposes of this tutorial, the following configuration is in place:

External networking

The network associated with the secondary interface requires a range of IP addresses that will be sufficient for allocating floating IP addresses to VMs. This will in turn allow them to be contacted by remote hosts.

For the purposes of this tutorial, the following external network configuration is in place:

Boostrap the first machine

Commands in this section are performed on sunbeam01.

Install the openstack snap

Begin by installing the openstack snap:

sudo snap install openstack --channel 2023.1

Prepare the machine

Sunbeam can generate a script to ensure that the machine has all of the required dependencies installed and is configured correctly for use in MicroStack - you can review this script using:

sunbeam prepare-node-script

or the script can be directly executed in this way:

sunbeam prepare-node-script | bash -x && newgrp snap_daemon

The script will ensure some software requirements are satisfied on the host. In particular, it will:

• install openssh-server if it is not found
• configure passwordless sudo for all commands for the current user (NOPASSWD:ALL)

Bootstrap the cloud

Deploy the OpenStack cloud using the cluster bootstrap command:

sunbeam cluster bootstrap --role control --role compute --role storage

This first node will therefore be a control node, a compute node, and a storage node.

When prompted, enter the control plane address range. Here we use the values given earlier:

MetalLB address allocation range (10.20.21.10-10.20.21.20): 10.249.148.200-10.249.148.210

The un-partitioned disk(s) will be detected and allocated for cloud storage (Ceph).

Configure the cloud

Now configure the deployed cloud using the configure command:

sunbeam configure --openrc demo-openrc

A series of questions will now be asked. Below is sample output of an entire interactive session. The values in square brackets, when present, provide acceptable values. A value in parentheses is the default value.

Local or remote access to VMs [local/remote] (local): remote
CIDR of network to use for external networking (10.20.20.0/24): 10.246.112.0/21
IP address of default gateway for external network (10.246.112.1):
Populate OpenStack cloud with demo user, default images, flavors etc [y/n] (y):
Username to use for access to OpenStack (demo):
Password to use for access to OpenStack (mt********):
Network range to use for project network (192.168.122.0/24):
Enable ping and SSH access to instances? [y/n] (y):
Start of IP allocation range for external network (10.246.112.2): 10.246.116.41
End of IP allocation range for external network (10.246.119.254): 10.246.116.51
Network type for access to external network [flat/vlan] (flat):
Writing openrc to demo-openrc ... done
Free network interface that will be configured for external traffic [eno3/eno2] (eno3): eno2

Any remote hosts intending to connect to VMs on this node must have connectivity with the interface selected for external traffic (last question above).

These questions are explained in more detail on the Interactive configuration prompts page in the reference section.

Add the second machine

To add second machine sunbeam02, some commands are performed on the first machine (sunbeam01) and some are performed on the new machine (sunbeam02) itself.

Create a registration token

Run the below command on sunbeam01.

A registration token is needed before adding a new member. Run the cluster add command against the FQDN of the new node:

sunbeam cluster add --name sunbeam02.example.com

Sample output (token):

YmRlODViYjYtMGFlNy00MmFjLWE4NzMtNjI0ODg4YmUzZTM0Cg==

Keep the token in a safe place. It will be used in a future step.

Install the openstack snap

Run the below command on sunbeam02.

Install the openstack snap:

sudo snap install openstack --channel 2023.1/edge

Prepare the machine

Run the below command on sunbeam02.

Sunbeam can generate a script to ensure that the machine has all of the required dependencies installed and is configured correctly for use in MicroStack - you can review this script using:

sunbeam prepare-node-script

or the script can be directly executed in this way:

sunbeam prepare-node-script | bash -x && newgrp snap_daemon

The script will ensure some software requirements are satisfied on the host. In particular, it will:

• install openssh-server if it is not found
• configure passwordless sudo for all commands for the current user (NOPASSWD:ALL)

Add the new node

Run the below command on sunbeam02.

Add the machine as a new cluster member by using the cluster join command. Refer to the registration token obtained earlier:

sunbeam cluster join --role control --role compute --role storage \
   --token YmRlODViYjYtMGFlNy00MmFjLWE4NzMtNjI0ODg4YmUzZTM0Cg==

The final part of the join process will prompt for a free network interface to use for external networking:

Free network interface that will be configured for external traffic [eno3/eno2] (eno3): eno2

Any remote hosts intending to connect to VMs on this node must have connectivity with the interface selected for external traffic.

Add the third machine

To add the third machine, we repeat the steps that were taken to add the second machine.

Create a registration token

Run the below command on sunbeam01.

A registration token is needed before adding a new member. Run the cluster add command against the FQDN of the new node:

sunbeam cluster add --name sunbeam02.example.com

Sample output (token):

NGI0Mzg2NzktODA5OC00ZTRmLWIyZWEtNmU2NmQ2MjgxZmU1Cg==

Install the openstack snap

Run the below command on sunbeam03.

Install the openstack snap:

sudo snap install openstack --channel 2023.1/edge

Prepare the machine

Run the below command on sunbeam03.

sunbeam prepare-node-script | bash -x && newgrp snap_daemon

Join the machine to the cluster

Run the below command on sunbeam03.

Join the machine to the cluster by using the cluster join command. Refer to the registration token obtained earlier:

sunbeam cluster join --role control --role compute --role storage \
   --token NGI0Mzg2NzktODA5OC00ZTRmLWIyZWEtNmU2NmQ2MjgxZmU1Cg==

The final part of the join process will prompt for a free network interface to use for external networking:

Free network interface that will be configured for external traffic [eno3/eno2] (eno3): eno2

Any remote hosts intending to connect to VMs on this node must have connectivity with the interface selected for external traffic.

Resize the control plane

Run the below command on either of the three nodes.

Finally the control plane of the cloud must be resized to make use of the second and third nodes, providing resilience and expanded capacity:

sunbeam cluster resize

Obtain credentials

Run the below command on either of the three nodes.

The previous configure command performed on sunbeam01 provided normal user credentials via file demo-openrc. Admin credentials can be obtained in this way (file admin-openrc):

sunbeam openrc > admin-openrc

Launch a VM

Run the below command on either of the three nodes.

Verify the cloud by launching a VM called ‘test’ based on the ‘ubuntu’ image (Ubuntu 22.04 LTS). The launch command is used:

sunbeam launch ubuntu --name test

Sample output:

Launching an OpenStack instance ...
Access instance with `ssh -i /home/ubuntu/.config/openstack/sunbeam ubuntu@10.20.20.200`

Connect to the VM over SSH. Because remote VM access has been enabled, you will need the private SSH key given in the above output from the launching node. Copy it to the connecting host. Note that the VM will not be ready instantaneously; waiting time is mostly determined by the cloud’s available resources.

Related howtos

Now that OpenStack is set up, be sure to check out the following howto guides:

• Accessing the OpenStack dashboard
• Using the OpenStack CLI

Check the OpenStack Charms Deployment Guide for detailed instructions on how to set up OpenStack in multi-node mode with bare metal automation using OpenStack Charms.