Installation and Configuration Checklist

This is a guide that you can use to achieve a working MAAS environment. Once you perform a step come back here (using the menu in the left pane) to continue on to the next one.

Software installation

As explained here, the installation of MAAS consists of the installation of a rack controller and a region controller which, in turn, provide a multitude of services. Go ahead and install MAAS!

Access the web UI

You will be using the web UI so now is the time to log in and take a look around! Proceed to the web UI now. This will involve the creation of an administrator user. Notice how the web UI (API server) is accessed via port 5240 and not port 80.



For zones, many people won't need to change anything as a default zone is provided out of the box. However, they are still worth reading about, especially if the default one does not suffice.


Firstly, in terms of IP addresses, understand what a reserved range is by reading Concepts and terms. Create one (not reserved dynamic range) if you need one.

Secondly, configure a default gateway and a nameserver that your nodes will use. See Networking for how to do this.

Import boot images

While you were in the web UI you may have seen a hint to import boot images. Read up on images as they're quite important. Continue reading until you have discovered how to import them. You will see that you have the choice to use the CLI to do this. Either way: achievement unlocked!


Access the MAAS CLI

Even if you've imported images with the web UI, it would be wise (and cool?) to give the CLI a spin in case you ever need to use it later. Although we strive to make the web UI feature-equivalent to the CLI, some things can still only be done with the CLI.

Enable DHCP

You won't get far without DHCP since it is required in order to make PXE work, which, in turn, is necessary to introduce your systems to MAAS. But you knew that. Anyway, DHCP is installed - it just needs enabling. Read about DHCP and continue until you have enabled it.

Users and SSH keys

You already have an administrative user but MAAS can also have regular users (who log in to the interface or use the CLI). What users you create depends on how you intend to use MAAS.

Additionally, in order for a user to log into a MAAS-deployed machine that user must have their public SSH key installed on it.

Study user accounts to learn about how to create more users and how to add their SSH keys to MAAS. Once that's done, every deployed machine will automatically have that key installed.

Add a node

It's time to actually do something! MAAS manages nodes, but at this time it doesn't have any. Go forth and add a node now. Obviously, you need a spare physical system (but KVM works too). In the web UI, confirm that the import of images has finished!

Go to the 'Nodes' page in the web UI. A successfully added node will soon appear there with a status of New. It will also have a funny name. Whatever, you're still a rock star!

Edit power type

A node needs to power cycle while being managed by MAAS. The next step is therefore to tell MAAS how to do this. That is, you need to edit the power type of the node's BMC.

Commission a node

Commissioning a node involves MAAS testing it to ensure that it is able to communicate properly with the region API server. Commission your node now.

Deploy a node

Lots of folks would have [Juju][about juju] take over at this point. Juju acts as a sort of command & control centre for adding services/applications on top of MAAS nodes (among other "clouds"). If you're just not there and/or you want to quickly test things out you can use the web UI to deploy a node directly.

SSH to the node

If you imported your SSH key then you should now be able to ssh to the deployed node by connecting to the 'ubuntu' account. The node's page in the web UI will inform you of its IP address. Mission accomplished!