An Opinionated Setup of a MAAS Dev Environment

Goals of this project

To make the setup of a MAAS development environment super simple. Think of this as a one click installer.

Requirements

• Ubuntu (maybe Debian)
• sudo and the ability to run commands as root
• To use MAAS a decent amount of RAM would be good (> 8GB)

In the best case LXD is not configured on your system. However, if you have running containers and network configurations, this is not ab problem but make sure that the following names/network ranges are not yet used by LXD (or change values in config.sh).

• a profile in LXDs default project called $MAAS_CONTAINER_NAME
• two networks named maas-ctrl and maas-kvm
  • these networks will use the IP ranges $MAAS_CONTROL_IP_RANGE and MAAS_MANAGEMENT_IP_RANGE

How to run this script?

1. Edit the config.sh file according to your needs.
2. Run this to see your options

./setup-dev-env.sh

3. Run this to start

./setup-dev-env.sh --ok

If you would like to tear down your MAAS dev environment completely, do the following:

• remove everything from LXD (e.g. containers, profiles, networks, ...) for all projects
  • you can use LXD Delete All for this job
• remove your libvirt network definitions (virsh net-destroy and virsh net-undefine for all networks)
• delete (or move) your current maas source code

What happens if I run this script?

Attention

This script was carefully crafted and does not contain any destructive commands. Still it may install dependencies that might break your system.

The script was tested on Ubuntu 22:10.

No, really. What happens?

The script will:

• DISABLE YOUR UFW FIREWALL (to make sure lxd connections work)
• Install git, make, lxd, snapcraft, libvirt with qemu
• Clone the source code and (if configured) add a branch for your launcpad account
• Setup LXD to have a MAAS development container, profiles and networks
• Setup bridges so that MAAS can reach your network
• Will prepare to connect your local LXD to the MAAS development container, so that MAAS can provision virtual machines on your local host
  • You will still have to do a single manual step here, but you will be guided by the script

Basically the script mimics the steps described in this discourse post and configures your maas-dev host to be able to connect to your local LXD.

The script will stop on any error, so please be sure to skip stages, if you have already done them.

You can skip some of those stages using the -sX arguments. Run ./setup-dev-env.sh --help to see your options.