Reference: Release notes MAAS 3.3

Errors or typos? Topics missing? Hard to read? Let us know.

These are the release notes for MAAS 3.3.

Release history

This section recaps the version history of MAAS version 3.3.

MAAS 3.3.9 has been released

We are happy to announce that MAAS 3.3.9 has been released.
This is a maintenance release, with no new features, providing the following bug fixes:

• 2004661^: implement exponential backoff retry in the redfish power driver. We retry up to 6 times the requests to redfish before giving up. With this change the rackd is going to be more fault tolerant to whatever failure might happen.
• 2058063^: regiond and rackd showing different versions
• 2040324^: distro_series and osystem check based on node status

MAAS 3.3.8 has been released

We are happy to announce that MAAS 3.3.8 has been released.
This is a maintenance release, with no new features, providing the following bug fixes:

• 2029522^: stacktrace on _reap_extra_connection()
• 2031482^: Subnet changed to wrong fabric, impacting DHCP

MAAS 3.3.7 has been released

We are happy to announce that MAAS 3.3.7 has been released.
This is a maintenance release, with no new features,
providing the following bug fixes:

• 1887558^: multipathd bcache disks do not get picked up by multipath-tools during boot
• 2007297^: LXD REST API connection goes via proxy
• 2012596^: MAAS 3.2 deb package memory leak after upgrading
• 2033632^: New deployments do not take into account the new configurations (ephemeral_deployments, hw_sync etc…))
• 2052958^: PPC64 machines without disk serial fail condense LUNs
• 2054915^: Failed configuring DHCP on rack controller - too many values to unpack (expected 5)
• 2062107^: Failed to reload DNS; serial mismatch on domains maas
• 2066276^: ipv6 test failures: AttributeError: ‘RRHeader’ object has no attribute ‘_address’

MAAS 3.3.6 has been released

We are happy to announce that MAAS 3.3.6 has been released.
This is a maintenance release, with no new features,
providing the following bug fixes:

• 2053033^: Creating MAAS Virsh VM does not work (libvirt: error)
• 2033505^: Failed to update regiond’s processes and endpoints
• 2041276^: Adding subnet sends named into crash loop [rdns zones]
• 2048399^: MAAS LXD VM creation issue (Ensure this value is less than or equal to 0)

MAAS 3.3.5 has been released

We are happy to announce that MAAS 3.3.5 has been released. This is a maintenance release, with no new features, providing the following bug fixes:

• 2013120^: Incorrect Nginx Logging Configuration on MAAS Snap
• 2026802^: MAAS 3.4 installed with deb fails to start the rack due to permission error
• 2027735^: Concurrent API calls don’t get balanced between regiond processes
• 2029481^: MAAS 3.4 RC (Aug 2nd 2023) breaks DNS
• 2046255^: For every interface MAAS is adding an A record for the name .
• 1914812^: curtin fails to deploy centos 8 on nvme with multipath from ubuntu 20.04
• 1996204^: failing metrics cause 500 error
• 1999668^: reverse DNS not working for CIDR with non 0 last octet
• 2012801^: MAAS rDNS returns two hostnames that lead to Services not running…
• 2015411^: StaticIPAddress matching query does not exist.
• 2020397^: Custom images which worked ok is not working with 3.2
• 2022926^: Wrong metadata url in enlist cloud-config
• 2024625^: DNS Forward failures
• 2026824^: Enlistment fail for a machine with BIOS Legacy if PXE interface is the second one
• 2027621^: ipv6 addresses in dhcpd.conf
• 2028284^: LXD vm compose fails with - This “instances” entry already exists
• 2029417^: RPC failure to contact rack/region - operations on closed handler
• 2034014^: Conflict error during w3 request
• 2040188^: MAAS config option for IPMI cipher suite ID is not passed to bmc-config script
• 2045228^: DNS updates are consumed concurrently, leading to an incorrect nsupdate payload
• 1999064^: maas_run_scripts.py does not clean up temporary directory
• 2009045^: WebSocket API to report reasons for failure for machine bulk actions
• 2025468^: maas-dhcp-helper stopped working which gives issues with DNS updates
• 1891900^: Change the logo or theme of the MaaS Dashboard
• 1999827^: DNS entries for MAAS servers change to secondary IPs

MAAS 3.3.4 has been released

We are happy to announce that MAAS 3.3.4 has been released. This is a maintenance release, with no new features, providing the following bug fixes:

• 1998615^: Rack controller status flapping when “ClusterClient connection lost” messages in rackd.log
• 2013476^: 3.3/UI: Machines page is flapping once the machine operation in progress
• 1807725^: Machine interfaces allow ‘_’ character, results on a interface based domain breaking bind (as it doesn’t allow it for the host part).
• 1914762^: test network configuration broken with openvswitch bridge

MAAS 3.3.3 has been released

We are happy to announce that MAAS 3.3.3 has been released. This is a maintenance release, with no new features, providing the following bug fixes:

• 1959648^: Websocket vlan handler should include associated subnet ids
• 1979403^: commission failed with MAAS 3.1 when BMC has multiple channels but the first channel is disabled
• 1990416^: MAAS reports invalid command to run when maas-url is incorrect
• 1999668^: reverse DNS not working for some interfaces
• 2003940^: MAAS 3.3 RC shows incorrect storage amount
• 2011841^: DNS resolution fails
• 2012466^: Fractional value for available CPU cores with an overcommit ratio breaks UI

MAAS 3.3.2 has been released

We are happy to announce that MAAS 3.3.2 has been release with the following bug fixes:

• 1990867^: TestImportBootImages - test_update_last_image_sync_end_to_end_import_not_performed
• 1990872^: Flaky test: TestClusterClient - test_registerRackWithRegion_end_to_end
• 2011822^: Reverse DNS resolution fails for some machines
• 2012139^: maas commands occasionally fail with NO_CERTIFICATE_OR_CRL_FOUND when TLS is enabled
• 1986590^: maas-cli from PPA errors out with traceback - ModuleNotFoundError: No module named ‘provisioningserver’

MAAS 3.3.1 has been released

We are happy to announce that MAAS 3.3.1 has been released with the following bug fixes:

• 1773150^: smartctl verify fails due to Unicode in Disk Vendor Name
• 1993618^: Web UI redirection policy can invalidate HAProxy and/or TLS setup
• 1996997^: LXD resources fails on a Raspberry Pi with no Ethernet
• 2003310^: Refresh scripts are not re-run if they pass, but fail to report the results to the region
• 2008275^: Intel AMT support is broken in MAAS 3.3.0
• 2009137^: MAAS OpenApi Schema missing parameters
• 2009140^: MAAS OpenApi Schema cutoff variable names
• 2009186^: CLI results in connection timed out when behind haproxy and 5240 is blocked
• 2009805^: machine deploy install_kvm=True fails

MAAS 3.3 has been released

We are happy to announce that MAAS 3.3 has been released, with one additional bug fix. MAAS 3.3 is a concerted effort to improve MAAS on multiple fronts, including a large number of bug fixes.

Features

New features created for MAAS 3.3 include:

• Improved machine list filtering: MAAS 3.3 enhances the presentation and filtering of the machine list, with a shorter wait to start filtering and a wider range of filter choices.

• Integration of Vault for credential storage: MAAS 3.3 allows you to use Hashicorp Vault^ to protect your secrets, if you wish.

Improved capabilities include the following:

• Native support for 22.04 LTS and core22: We’ve removed the requirement to use snaps on 22.04 (Jammy Jellyfish); you now can load MAAS 3.3 on 22.04 using packages.

• UI performance improvements for large machine counts: We’ve improved the performance of the UI machine list for large (>10000 machines) MAAS instances. The machine list now goes live just a few seconds after the first visible page loads, with the rest of the list loading in background.

• Enhanced MIB support for Windows OS images: The procedure for creating custom Windows OS images has been thoroughly updated and verified.

Greatly expanded documentation sections include:

• MAAS configuration settings reference: There is now one reference page that addresses all MAAS settings in one place. Other references throughout the document are preserved for now.

• Improved MAAS event documentation: MAAS event documentation has been expanded to include much better explanations of MAAS events, including many examples.

• Improved MAAS audit event documentation: MAAS audit event documentation has been greatly expanded to include much better explanations of MAAS audit events, including many examples and use cases.

Several forward-looking improvements are included as well:

• Reliability improvements for simultaneous machine deployments

• The first phase of Nvidia DPU^ support

• Shifting the MAAS API documentation toward OpenAPI standards^

These will be documented later in blog posts.

This release also includes well over one-hundred bug fixes. Read on to catch up with what we’ve done so far this cycle.

Improved machine list filtering

MAAS 3.3 dramatically reduces the latency associated with refreshing large machine lists.

Ten words or less

You can filter machines mere seconds after one page loads.

How list filtering is improved

NOTE that this feature is still in development, so some of the feature-set described in this section may not be fully operational yet. As always, we reserve the right to change this feature-set until the final release of MAAS 3.3. These release notes will be updated as the feature develops.

MAAS 3.3 enhances the way you can filter the machine list, in two ways:

1. You may begin filtering within a very short time after the first page of the machine list loads, even if you have more than 10,000 machines in the list.

2. You have a wider range of filter choices, as described in the table below.

Note that with this version of MAAS, matching machine counts have been removed from the filter list for better performance.

More filter parameters have been added

The following table describes the expanded filter set for the MAAS machine list:

• Items marked “Dyn” are dynamic, populated based on existing data, that is, the “Tags” filter only shows tags that currently exist.
• Items which are not dynamic present the entire range of possible values, regardless of whether that value currently exists in MAAS; for example, all machine status values are available to be filtered, even if no machines currently have that status.
• Items marked “Grp” can be used to group machines, instead of the default machine status.
• Items marked “Man” must be manually entered, i.e., they are not in the UI filter drop-down, but can be entered in the “Search” box if properly formatted (as in the examples given).

See How to search MAAS for more details on how to use these parameters.

Native support for 22.04 LTS and core22

MAAS can now be installed as a PPA, directly on Ubuntu 22.04, without the need to use snaps.

Ten words or less

MAAS packages now run on Ubuntu 22.04, aka Jammy Jellyfish.

Notes on 22.04 LTS MAAS packages

MAAS users want to install MAAS on a 22.04 LTS system via deb packages, as well as upgrade machines currently running MAAS on Ubuntu 20.04 LTS to 22.04 LTS. With the advent of MAAS 3.3, we have created an appropriate PPA with all required dependencies. This PPA can be directly installed on Ubuntu 22.04, Jammy Jellyfish, with no requirement to use snaps.

Note that the upgrade procedure will require a release upgrade from previous Ubuntu versions to Ubuntu 22.04. Also note that, with this version of MAAS, PostgreSQL 12 is deprecated and should be upgraded to PostgreSQL 14. The installation guide provides the necessary details.

UI performance improvements

We wanted to improve the performance of the machine list page for large (>10000 machines) MAASes, and allow users to search and filter machines as quickly as possible.

Ten words or less

We’re working on making large machine lists load in background.

Background performance work

In MAAS 3.2 and earlier, machine search and filter requires that all machines be fetched by the UI client before it becomes usable. For smaller MAASes this may not be an issue, but when considering MAASes with 1000 machines or more this can make the user wait an unacceptably long time before they can search and filter. With the release of MAAS 3.3, when a MAAS UI user wants to find a particular machine, they do not have to wait for all their machines data to load before they can start searching. The user can start searching for machines within a short time after the visible page of the machine list has fully loaded on the UI screen. See Improved machine list filtering, in these release notes, for details on the enhanced filtering capabilities that were included in this work.

Enhanced MIB support for Windows OS images

The procedure for creating custom Windows OS images has been thoroughly updated and verified.

Ten words or less

MAAS custom Windows images now support most releases and options.

What has been added to Windows custom images

Specifically, MIB now supports a much wider range of Windows images. Previously, only 2012 and 2106 Windows versions were supported with MIB. Now the list is much longer, bringing deployable MAAS versions up to date with the current Windows releases:

• win2008r2
• win2008hvr2
• win2012
• win2012hv
• win2012r2
• win2012hvr2
• win2016
• win2016-core
• win2016hv
• win2016dc
• win2016dc-core
• win2019
• win2019-core
• win2019dc
• win2019dc-core
• win10ent
• win10ent-eval
• win2022
• win2022-core

There are also special instructions for using both UEFI and BIOS bootloaders, as well as instructions for using LXD containers with custom-built Windows images.

Finally, MIB has been extended to accept a much wider range of options for windows builds. Some of the new Windows-specific options include:

• –windows-iso: path to the Windows ISO image.
• –windows-edition: identifier for the Windows edition/option being installed (see above).
• –windows-license-key: Windows license key (required with non-evaluation editions)
• –windows-language: Windows installation language (default: en-US)
• –windows-updates: download and install Windows Updates (requires internet access; might require a larger --disk-size option)
• –windows-drivers: path to directory with Windows drivers to be installed (requires internet access; uses the Windows Driver Kit, by default)
• –driver-store: combined with --windows-drivers, uses the Windows Driver Store to install drivers early into Windows Setup and image (does not require internet access; does not use the Windows Driver Kit).

Some news Windows-specific platform options include:

• –uefi: use UEFI partition layout and firmware
• –virtio: use paravirtualized VirtIO SCSI and VirtIO NET devices (instead of emulated devices) for installation (requires --windows-drivers)
• –disk-size: specify the (virtual) disk size for Windows setup (must be larger for --windows-updates; increases deployment/copy-to-disk time, and is expanded to physical disk size during deployment)

This update should make it much simpler to use custom-built Windows images with MAAS.

Shifting the MAAS API documentation to OpenAPI standards

MAAS API User want to experience the MAAS API in a more standard way, along the lines of the OpenAPI definition. MAAS 3.3 begins this process by providing most of the MAAS API functionality in a discover-able form. You should now be able to easily retrieve human-readable service documentation and API definitions using standard methods. Consult the API documentation^ for details.

MAAS configuration settings reference

MAAS 3.3 documentation consolidates configuration settings in one article, in addition to their other mentions throughout the documentation set.

Ten words or less

“Settings” now has its own page, and some new options.

What is new about this update

MAAS configuration settings are scattered in various (generally relevant) places throughout the documentation, but there has never been one reference page that addresses all settings in one place. MAAS 3.3 remedies this by adding the Configuration settings reference.

A minor new feature added with MAAS 3.3 is MAAS site identity, which enables some new configuration parameters:

• MAAS name: The “* MAAS name” is a text box that sets the text which appears at the bottom of every MAAS screen, in front of the version descriptor.

• MAAS name emoji: You may also paste a suitable emoji in front of the MAAS name to help identify it.

• MAAS theme main colour: You may also help identify your MAAS instance by changing the colour of the top bar; several colour choices are available.

These enhancements were made available to assist users who have more than one instance (e.g., production and staging), and have issues with operations accidentally making changes to the wrong instance.

Improved MAAS event documentation

MAAS event documentation has been expanded to include much better explanations of MAAS events, including many examples.

Ten words or less

We’ve finally documented MAAS events, making them easier to decode.

Understanding MAAS events

Events are state changes that happen to MAAS elements, caused by MAAS itself, an external agent, or a users. Understanding events is an essential debugging skill. But events appear in three different places in MAAS, each presentation providing slightly different information. These screens are usually dense and hard to search.

In this major documentation update, we’ve standardised on the MAAS CLI events query command as the best way to review, filter, and summarise events. We’ve summarised the six main event types:

• INFO: the default, used if no level= is specified; shows INFO and ERROR events. A typical INFO event is “Ready”, indicating that a machine has reached the “Ready” state.

• CRITICAL: critical MAAS failures; shows only CRITICAL events. These events usually represent severe error conditions that should be immediately remedied.

• ERROR: MAAS errors; shows only ERROR events. Typical ERROR events include such things as power on/off failures, commissioning timeouts, and image import failures.

• WARNING: failures which may or may not affect MAAS performance; shows WARNING and ERROR events. A typical warning event, for example, might include the inability to find and boot a machine.

• DEBUG: information which would help debug MAAS behaviour; shows DEBUG and INFO events. Typical DEBUG events involve routine image import activities, for example.

• AUDIT: information which helps determine settings and user actions in MAAS; shows only AUDIT events. They are covered in more detail elsewhere.

In addition, the new document explains how these event types tend to overlap when queried. We’ve also provide detailed instructions on how to use the most common filters:

• hostname: Only events relating to the node with the matching hostname will be returned. This can be specified multiple times to get events relating to more than one node.

• mac_address: Only nodes with matching MAC addresses will be returned. Note that MAC address is not part of the standard output, so you’d need to look it up elsewhere.

• id: Only nodes with matching system IDs will be returned. This corresponds to the node parameter in the JSON listing, not the id parameter there, which is a serial event number.

• zone: Only nodes in the zone will be returned. Note that zones are not part of the standard output, so you’d need to look these up elsewhere.

• level: The event level to capture. You can choose from AUDIT, CRITICAL, DEBUG, ERROR, INFO, or WARNING. The default is INFO.

• limit: Number of events to return. The default is 100, the maximum in one command is 1000.

• before: Defines an event id to start returning older events. This is the “id” part of the JSON, not the system ID or “node”. Note that before and after cannot be used together, as the results are unpredictable.

• after: Defines an event id to start returning newer events. This is the “id” part of the JSON, not the system ID or “node”. Note that before and after cannot be used together, as the results are unpredictable.

Since the MAAS CLI returns JSON – which is hard to humans to parse – we’ve included some exemplary jq predicates of the form:

maas $PROFILE events query limit=20 \
| jq -r '(["USERNAME","NODE","HOSTNAME","LEVEL","DATE","TYPE","EVENT"] | 
(., map(length*"-"))),
(.events[] | [.username,.node,.hostname,.level,.created,.type,.description]) 
| @tsv' | column -t -s\t'

And finally, we provided some detailed usage examples. For instance, we walked a MAAS machine called fun-zebra through the following states:

• Commissioning
• Allocation
• Deployment
• Releasing
• Testing (with a premature manual abort)
• Rescue mode

We used this example command:

 maas $PROFILE events query level=INFO hostname=fun-zebra limit=1000 | jq -r '(["USERNAME","NODE","HOSTNAME","LEVEL","DATE","TYPE","EVENT"] | (., map(length*"-"))),(.events[] | [.username,.node,.hostname,.level,.created,.type,.description]) | @tsv' | column -t -s\t'

This gave us a reasonably thorough report of what happened to the machine:

USERNAME  NODE    HOSTNAME   LEVEL  DATE                        TYPE                   EVENT
--------  ----    --------   -----  ----                        ----                   -----
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 21:29:53  Exited rescue mode     
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 21:29:52  Powering off           
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 21:28:58  Rescue mode            
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 21:27:18  Loading ephemeral      
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 21:26:40  Performing PXE boot    
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 21:26:23  Power cycling          
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 21:26:23  Entering rescue mode   
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 21:26:14  Powering off           
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 21:26:14  Aborted testing        
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 21:24:08  Performing PXE boot    
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 21:23:51  Powering on            
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 21:23:51  Testing                
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 21:23:38  Released               
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 21:23:37  Powering off           
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 21:23:37  Releasing              
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 21:22:41  Deployed               
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 21:21:49  Rebooting              
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 21:18:42  Configuring OS         
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 21:17:42  Installing OS          
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 21:17:30  Configuring storage    
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 21:15:31  Loading ephemeral      
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 21:14:48  Performing PXE boot    
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 21:14:31  Powering on            
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 21:14:27  Deploying              
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 20:04:17  Ready                  
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 20:04:07  Running test           smartctl-validate on sda
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 20:01:27  Gathering information  
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 20:01:10  Loading ephemeral      
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 20:00:35  Performing PXE boot    
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 20:00:16  Powering on            
unknown   bk7mg8  fun-zebra  INFO   Thu, 29 Sep. 2022 20:00:16  Commissioning          

Additional examples and techniques are provided as part of this new documentation.

Improved MAAS audit event documentation

MAAS audit event documentation has been greatly expanded to include much better explanations of MAAS audit events, including detailed examples of how to reconstruct machine life-cycles in the updated version of “How to work with audit event logs”.

Ten words or less

We’ve finally offered details about how you should audit MAAS.

Understanding how audit events explain MAAS internal operations

There’s probably no limit to what you can figure out if you use audit events properly. The problems are: (1) a lot goes on in MAAS, and (2) you need more than just the explicit audit events to get a clear picture of what’s happening. We’ve tried to address this by taking a deeper look at the auditing process (not just the events).

As you may know, an audit event is just a MAAS event tagged with AUDIT. It generally captures changes to the MAAS configuration and machine states. These events provide valuable oversight of user actions and automated updates – and their effects – especially when multiple users are interacting with multiple machines.

Viewing events

Audit events are examined using the MAAS CLI with the level=AUDIT parameter set:

$ maas $PROFILE events query level=AUDIT

You’ll probably get better results by appending a jq filter, to prettify the output:

$ maas $PROFILE events query level=AUDIT after=0 limit=20 \
| jq -r '(["USERNAME","HOSTNAME","DATE","EVENT"] | 
(., map(length*"-"))),
(.events[] | [.username,.hostname,.created,.description]) 
| @tsv' | column -t -s\t'

By itself, such a command might produce output similar to this:

USERNAME  HOSTNAME     DATE                        EVENT
--------  --------     ----                        -----
unknown   valued-moth  Thu, 21 Apr. 2022 19:45:14  pci device 2 was updated on node 8wmfx3
unknown   valued-moth  Thu, 21 Apr. 2022 19:45:14  pci device 1 was updated on node 8wmfx3
unknown   valued-moth  Thu, 21 Apr. 2022 19:45:14  pci device 1 was updated on node 8wmfx3
unknown   valued-moth  Thu, 21 Apr. 2022 19:45:14  pci device 1 was updated on node 8wmfx3
unknown   valued-moth  Thu, 21 Apr. 2022 19:45:14  pci device 1 was updated on node 8wmfx3
unknown   valued-moth  Thu, 21 Apr. 2022 19:45:14  pci device 1 was updated on node 8wmfx3
unknown   valued-moth  Thu, 21 Apr. 2022 19:45:14  pci device 1 was updated on node 8wmfx3
unknown   valued-moth  Thu, 21 Apr. 2022 19:45:14  pci device 1 was updated on node 8wmfx3
unknown   valued-moth  Thu, 21 Apr. 2022 19:45:14  pci device 1 was updated on node 8wmfx3
unknown   valued-moth  Thu, 21 Apr. 2022 19:45:14  pci device 0 was updated on node 8wmfx3
unknown   valued-moth  Thu, 21 Apr. 2022 19:45:14  block device sda was updated on node 8wmfx3
unknown   valued-moth  Thu, 21 Apr. 2022 19:45:14  interface enp5s0 was updated on node 8wmfx3
unknown   valued-moth  Thu, 21 Apr. 2022 19:45:14  0 bytes of memory was removed on node 8wmfx3
admin     valued-moth  Thu, 21 Apr. 2022 19:36:48  Started deploying 'valued-moth'.
admin     valued-moth  Thu, 21 Apr. 2022 19:36:21  Acquired 'valued-moth'.
admin     unknown      Thu, 21 Apr. 2022 19:21:46  Updated configuration setting 'completed_intro' to 'True'.
admin     unknown      Thu, 21 Apr. 2022 19:20:49  Updated configuration setting 'upstream_dns' to '8.8.8.8'.
admin     unknown      Thu, 21 Apr. 2022 19:20:49  Updated configuration setting 'maas_name' to 'neuromancer'.
admin     unknown      Thu, 21 Apr. 2022 19:20:47  Updated configuration setting 'http_proxy' to ''.
admin     unknown      Thu, 21 Apr. 2022 19:20:24  Logged in admin.

You can, of course, use the various event filters with level=AUDIT to further restrict your output.

The meaning of audit events

Later on in the documentation, we walk through a sample of audit events and demonstrate how to interpret and use them. This includes detailed examples of various audit event queries, walking through real-world examples to answer questions like:

1. Who deployed comic-muskox?

2. What happened to sweet-urchin?

3. Why is fleet-calf in rescue mode?

4. Where did these changes come from in setup.sh?

5. What caused ruling-bobcat to be marked as broken?

6. Who’s responsible for the DHCP snippet called foo?

Auditing with finesse

As part of the updates to our “How to work with audit event logs”, we’ve tried to offer you some finesse in reconstructing machine life-cycles. We’ve shown how to combine various levels of MAAS event queries with standard command line utilities to produce clear audit trails such as this one:

418606  ERROR    Marking node broken               Wed, 17 Nov. 2021 00:02:52  A Physical Interface requires a MAC address.
418607  DEBUG    Node changed status               Wed, 17 Nov. 2021 00:02:52  From 'New' to 'Broken'
418608  DEBUG    Marking node fixed                Wed, 17 Nov. 2021 00:04:24  
418609  DEBUG    Node changed status               Wed, 17 Nov. 2021 00:04:24  From 'Broken' to 'Ready'
418613  DEBUG    User acquiring node               Wed, 17 Nov. 2021 00:04:51  (admin)
418614  DEBUG    Node changed status               Wed, 17 Nov. 2021 00:04:51  From 'Ready' to 'Allocated' (to admin)
418615  DEBUG    User starting deployment          Wed, 17 Nov. 2021 00:04:51  (admin)
418616  DEBUG    Node changed status               Wed, 17 Nov. 2021 00:04:51  From 'Allocated' to 'Deploying'
418617  INFO     Deploying                         Wed, 17 Nov. 2021 00:04:51  
418618  AUDIT    Node                              Wed, 17 Nov. 2021 00:04:51  Started deploying 'ruling-bobcat'.
418619  INFO     Powering on                       Wed, 17 Nov. 2021 00:04:55  
418625  ERROR    Marking node failed               Wed, 17 Nov. 2021 00:05:32  Power on for the node failed: Failed talking to node's BMC: Failed to power pbpncx. BMC never transitioned from off to on.
418626  DEBUG    Node changed status               Wed, 17 Nov. 2021 00:05:32  From 'Deploying' to 'Failed deployment'
418627  ERROR    Failed to power on node           Wed, 17 Nov. 2021 00:05:32  Power on for the node failed: Failed talking to node's BMC: Failed to power pbpncx. BMC never transitioned from off to on.

In this case, we managed to recognise, rather quickly, that no physical interface had been defined for ruling-bobcat, hence deployment fails because MAAS can’t communicate with the node’s BMC. There are many other issues you can recognise with careful use of MAAS events to audit machine behaviours. We welcome your feedback on this new documentation endeavour.

Installation

MAAS will run on just about any modern hardware configuration, even a development laptop. If you’re not sure whether your target server will handle MAAS, you can always double-check.

NOTE that PostgreSQL 12 is deprecated with the release of MAAS 3.3, in favour of PostgreSQL 14. Support for PostgreSQL 12 will be discontinued in MAAS 3.4. Also note, though, that Postgres 14 does not run on Focal 20.04 LTS.

How to do a fresh snap install of MAAS 3.3

To install MAAS 3.3 from a snap, simply enter the following:

$ sudo snap install --channel=3.3 maas

After entering your password, the snap will download and install from the 3.3 channel.

How to upgrade from an earlier snap version to MAAS 3.3

Maybe instead of a fresh install, you want to upgrade from a earlier snap version to the 3.3 snap, and you are using a region+rack configuration, use this command:

$ sudo snap refresh --channel=3.3 maas

After entering your password, the snap will refresh from the 3.3 candidate channel. You will not need to re-initialise MAAS.

If you are using a multi-node maas deployment with separate regions and racks, you should first run the upgrade command above for rack nodes, then for region nodes.

How to initialise MAAS 3.3 snap for a test or POC environment

You can initialise MAAS as a compact version for testing. To achieve this, we provide a separate snap, called maas-test-db, which contains a PostgreSQL database for use in testing and evaluating MAAS. The following instructions will help you take advantage of this test configuration.

Once MAAS is installed, you can use the --help flag with maas init to get relevant instructions:

$ sudo maas init --help
usage: maas init [-h] {region+rack,region,rack} . . .

Initialise MAAS in the specified run mode.

optional arguments:
  -h, --help            show this help message and exit

run modes:
  {region+rack,region,rack}
    region+rack         Both region and rack controllers
    region              Region controller only
    rack                Rack controller only

When installing region or rack+region modes, MAAS needs a
PostgreSQL database to connect to.

If you want to set up PostgreSQL for a non-production deployment on
this machine, and configure it for use with MAAS, you can install
the maas-test-db snap before running 'maas init':
    sudo snap install maas-test-db
    sudo maas init region+rack --database-uri maas-test-db:///

We’ll quickly walk through these instructions to confirm your understanding. First, install the maas-test-db snap:

sudo snap install maas-test-db

Note that this step installs a a running PostgreSQL and a MAAS-ready database instantiation. When it’s done, you can double check with a built-in PostgreSQL shell:

$ sudo maas-test-db.psql
psql (12.4)
Type "help" for help.

postgres=# \l

This will produce a list of databases, one of which will be maasdb, owned by maas. Note that this database is still empty because MAAS is not yet initialised and, hence, is not yet using the database. Once this is done, you can run the maas init command:

sudo maas init region+rack --database-uri maas-test-db:///

After running for a moment, the command will prompt you for a MAAS URL; typically, you can use the default:

MAAS URL [default=http://10.45.222.159:5240/MAAS]:

When you’ve entered a suitable URL, or accepted the default, the following prompt will appear:

MAAS has been set up.

If you want to configure external authentication or use
MAAS with Canonical RBAC, please run

  sudo maas configauth

To create admins when not using external authentication, run

  sudo maas createadmin

Let’s assume you just want a local testing user named admin:

$ sudo maas createadmin
Username: admin
Password: ******
Again: ******
Email: admin@example.com
Import SSH keys [] (lp:user-id or gh:user-id): gh:yourusername

At this point, MAAS is basically set up and running. You can confirm this with sudo maas status. If you need an API key, you can obtain this with sudo maas apikey --username yourusername. Now you will be able to test and evaluate MAAS by going to the URL you entered or accepted above and entering your admin username and password.

Initialise MAAS for a production configuration

To install MAAS in a production configuration, you need to setup PostgreSQL, as described below.

Setting up PostgreSQL from scratch

To set up PostgreSQL, even if it’s running on a different machine, you can use the following procedure:

1. You will need to install PostgreSQL on the machine where you want to keep the database. This can be the same machine as the MAAS region/rack controllers or a totally separate machine. If PostgreSQL (version 14) is already running on your target machine, you can skip this step. To install PostgreSQL, run these commands:

    sudo apt update
    sudo apt install -y postgresql
   

2. You want to make sure you have a suitable PostgreSQL user, which can be accomplished with the following command, where $MAAS_DBUSER is your desired database username, and $MAAS_DBPASS is the intended password for that username. Note that if you’re executing this step in a LXD container (as root, which is the default), you may get a minor error, but the operation will still complete correctly.

    sudo -u postgres psql -c "CREATE USER \"$MAAS_DBUSER\" WITH ENCRYPTED PASSWORD '$MAAS_DBPASS'"
   

3. Create the MAAS database with the following command, where $MAAS_DBNAME is your desired name for the MAAS database (typically known as maas). Again, if you’re executing this step in a LXD container as root, you can ignore the minor error that results.

    sudo -u postgres createdb -O "$MAAS_DBUSER" "$MAAS_DBNAME"
   

4. Edit /etc/postgresql/14/main/pg_hba.conf and add a line for the newly created database, replacing the variables with actual names. You can limit access to a specific network by using a different CIDR than 0/0.

    host    $MAAS_DBNAME    $MAAS_DBUSER    0/0     md5
   

5. You can then initialise MAAS via the following command:

    sudo maas init region+rack --database-uri "postgres://$MAAS_DBUSER:$MAAS_DBPASS@$HOSTNAME/$MAAS_DBNAME"
   

You should use localhost for $HOSTNAME if you’re running PostgreSQL on the same box as MAAS.

Don’t worry; if you leave out any of the database parameters, you’ll be prompted for those details.

How to do a fresh install of MAAS 3.3 from packages

MAAS 3.3 from packages runs on 22.04 LTS only. The recommended way to set up an initial MAAS environment is to put everything on one machine:

sudo apt-add-repository ppa:maas/3.3
sudo apt update
sudo apt-get -y install maas

Executing this command leads you to a list of dependent packages to be installed, and a summary prompt that lets you choose whether to continue with the install. Choosing “Y” proceeds with a standard apt package install.

Distributed environment

For a more distributed environment, you can place the region controller on one machine:

sudo apt install maas-region-controller

and the rack controller on another:

sudo apt install maas-rack-controller
sudo maas-rack register

These two steps will lead you through two similar apt install sequences.

How to upgrade from 3.2 or lower to MAAS 3.3

If you are running MAAS 3.2 or lower, you can upgrade directly to MAAS 3.3. You must first make sure that the target system is running Ubuntu 22.04 LTS by executing the following command:

lsb_release -a

The response should look something like this:

Distributor ID:	Ubuntu
Description:	Ubuntu xx.yy
Release:	xx.yy
Codename:	$RELEASE_NAME

The required “xx.yy” required for MAAS 3.3 is “22.04,” code-named “jammy”.

If you are currently running Ubuntu focal 20.04 LTS, you can upgrade to jammy 22.04 LTS with the following procedure:

Upgrade the release:

sudo do-release-upgrade --allow-third-party

Accept the defaults for any questions asked by the upgrade script.

Reboot the machine when requested.

Check whether the upgrade was successful:

lsb_release -a

A successful upgrade should respond with output similar to the following:

Distributor ID:	Ubuntu
Description:	Ubuntu 20.04(.nn) LTS
Release:	20.04
Codename:	focal

If you’re upgrading from MAAS version 2.8 or lower to version 3.3: While the following procedures should work, note that they are untested. Use at your own risk. Start by making a verifiable backup; see step 1, below.

Back up your MAAS server completely; the tools and media are left entirely to your discretion. Just be sure that you can definitely restore your previous configuration, should this procedure fail to work correctly.

Add the MAAS 3.3 PPA to your repository list with the following command, ignoring any apparent error messages:

sudo apt-add-repository ppa:maas/3.3

Run the release upgrade like this, answering any questions with the given default values:

sudo do-release-upgrade --allow-third-party

Check whether your upgrade has been successful by entering:

lsb_release -a

If the ugprade was successful, this command should yield output similar to the following:

No LSB modules are available.
Distributor ID:	Ubuntu
Description:	Ubuntu 20.04(.nn) LTS
Release:	20.04
Codename:	focal

Check your running MAAS install (by looking at the information on the bottom of the machine list) to make sure you’re running the 3.3 release.

If this didn’t work, you will need to restore from the backup you made in step 1, and consider obtaining separate hardware to install MAAS 3.3.

Bugs fixed

The following sections enumerate the bugs we’ve fixed in MAAS 3.3.

MAAS 3.3 Beta 1 bug list

So far in MAAS 3.3, we’ve fixed well over 100 bugs:

• 1762673^: maas insists on running the proxy, even when it’s disabled
• 1802505^: [ui][2.4][2.5] maas ignores ttl parameter for address records
• 1806707^: [2.5] Composing a VM with an interface attached to a (macvtap) network (on a KVM host NIC that is not a bridge) resulted in disconnect interface
• 1811109^: [2.5, UI, RBAC] Normal users can unmount the root file system, but not remount it
• 1818004^: Slow response in the UI
• 1822640^: [websocket, UI] Admins should be able to change ownership of resources over the UI
• 1822840^: [UI, feature] Add ability to edit/delete (manage) tags over the UI
• 1825255^: TestPostgresListenerService test fails erroneously in CI
• 1826011^: [UI] Compose machine from pod misaligned message
• 1826789^: stress-ng-cpu-long times out in bionic
• 1826967^: Exiting rescue mode shows ‘loading ephemeral’
• 1833545^: After removing a controller rackd still tries to update DNS
• 1840049^: [UI] When changing configuration of an Interface, one has to enter the config twice
• 1852360^: Validate network configuration button selects all network scripts that accept an interface parameter
• 1863395^: 2.6.2 Unable to change power type to manual via UI
• 1871605^: Updating controller name shouldn’t be allowed in the UI
• 1874355^: Controller details page not updated to match machine details page designs
• 1881948^: IPv6 address for power control fails
• 1882633^: Logical volume size is required
• 1883232^: UI: UI application cached after upgrade
• 1890262^: UI: Error message with a custom image URL doesn’t clear
• 1893226^: Machine-specific minimal commissioning kernel resets to MAAS wide default
• 1893670^: UI: display bios_boot_mode in the web UI
• 1898131: IP address gets hidden, instead of subnet when window is resized
• 1905636^: UI: CentOS 7 is the default over CentOS 8
• 1909348^: MAAS 2.9.0 DNS zone remove @ labels impossible
• 1913800^: PCI and USB information missing from controllers page
• 1918963^: Controllers page out of sync with nodes
• 1918978^: doesn’t detect the subarchitecture xgene-uboot for a HP m400 cartridge
• 1927748^: Need additional form inputs for DHCP Snippets associated with ipranges
• 1929478^: Commissioning fails with binary data in IPMI Lan_Conf_Security_Keys
• 1929973^: “Controllers have different installation sources.” is not shown on the controllers page
• 1931654^: domain.set_default error handling just returns id
• 1933408^: Setting discovery parent returns cryptic error
• 1938296^: MAAS 3.0 incorrectly calculates the amount of free space on drive
• 1940909^: UI: Allow to create a machine as deployed from the UI
• 1951229^: CLI: Uninformative errors when adding non-existent tags to machines
• 1955671^: support for rocky linux UEFI
• 1956766^: UI: Unable to deploy CentOS7 - centos/focal not a supported combination
• 1958817^: Cannot delete a tag from multiple machines in a bulk with Web UI
• 1959856^: newly added tags in UI don’t show until refresh/page change
• 1960571^: Domain name should be checked for duplicate against maas_internal_domain
• 1961627^: confusing UI to add the first network space
• 1964024^: smartctl-validate test runs even when explicitly removed from commissioning step
• 1965172^: [3.1] Setting interface into unconfigured does not reset auto-assign IP mode
• 1967577^: commissioning fails w/ 3.2-beta1: “please fill out the field”
• 1970803^: CLI event filters give extraneous results with more than one filter
• 1971152^: Authentication broken with MASS using Candid
• 1973236^: MAAS reports failure to detect storage that it already detected
• 1973617^: refresh a lxd KVM host resources after it was added
• 1976194^: init rack can’t find secrets
• 1976196^: Controller WebSocket handler contains unimplemented methods
• 1977820^: Some tests are skipped due to the “perf” filtering
• 1977822^: ERROR: Redfish ‘Redfish’ object has no attribute ‘_get_network_interface’
• 1977864^: 30-maas-01-bmc-config: ERROR: Redfish string indices must be integers
• 1977866^: 30-maas-01-bmc-config: ERROR: 169.254.95.120/16 has host bits set
• 1977895^: Certificate metadata missing from controller websocket model
• 1977942^: 30-maas-01-bmc-config: ERROR: Redfish ‘Redfish’ object has no attribute ‘_bmc_config’
• 1977951^: 30-maas-01-bmc-config: ERROR: Redfish nonnumeric port: ‘None’
• 1978024^: maas auto-creates interface name for docker bridge on controller, which breaks bind
• 1978037^: Drop legacy /l/ UI prefix
• 1978072^: 30-maas-01-bmc-config: ERROR: Redfish ‘dict’ object has no attribute ‘split’
• 1978121^: 30-maas-01-bmc-config: ERROR: ERROR: Unable to add BMC user!
• 1978154^: MAAS 3.1 introduces breaking changes for custom centos7 images
• 1978922^: MAAS 3.1 - Missing button “Create datastore” in VMFS7 storage layout
• 1979039^: TLS certificates are not recognised by CLI maas boot-resources create action
• 1979256^: Add config option for UI theme
• 1979316^: UI stuck at the initial configuration page
• 1979317^: Initial configuration form doesn’t allow proxy URL with hostname
• 1980347^: MAAS snap fails to parse supervisor STOPPING state
• 1980436^: MAAS CLI with anonymous access fails when TLS is enabled
• 1980490^: MAAS regiond IPC crash due to a machine-resources binary crash when parsing some VPDs
• 1980818^: Configure DHCP for VLAN
• 1980846^: IP Address tooltip on Machines page blocks access to everything underneath and doesnt disappear until mouse-off
• 1981536^: volume group creation fails on md device - MAAS 3.2
• 1981560^: upgrade from 3.1 to 3.2 using debian packages missing steps
• 1982208^: agent.yaml.example is missing when maas is installed via deb package
• 1982315^: MAAS not sending correct metadata_url
• 1982328^: update docstring to include informative not found change
• 1982846^: Missing update_interface method on controller websocket handler
• 1982866^: MAAS Breaks historical custom images
• 1982984^: reverse-proxy service is not displayed for region controller
• 1983624^: Fresh MAAS 3.2 install failed to find controller
• 1984141^: duplicate tag results in failed deployment for KVM host
• 1984852^: machine.filter_options returns empty, duplicate and mis-typed options
• 1984994^: machine.list fails for some group_key values
• 1985741^: Commissioning script ‘maas-kernel-cmdline’ fails with bonded interfaces
• 1986372^: UI: Setting Default minimum kernel version for commissioning blocks deployments
• 1987874^: interface.update_ip_addresses raise an Exception when exsits multiple StaticIPAddress
• 1988543^: VM Discovery fails, resulting in " Error: An architecture is required." when composing a LXD VM
• 1988759^: Provisioning LXD vmhost fails
• 1988769^: The ppc64 machine in our lab fails during commissioning
• 1988874^: Release command is failing for ppc64 machine in our lab
• 1989949^: provisioningserver TestGetSourceAddress.test_returns_none_if_no_route_found sometimes fails locally
• 1989970^: Can’t enlist machines on subnets with DNS set
• 1989974^: rackd fails on CIS-hardened machine with “Failed to update and/or record network interface configuration: Expecting value: line 1 column 1 (char 0)”
• 1990014^: regiond.conf “debug_http: true” causes image downloads from regiond to fail with 500 error code
• 1990649^: Kernel parameters form resets to previous value after save
• 1990873^: TestKeys - test_get_launchpad_crashes_for_user_not_found
• 1991106^: vCenter password field text is visible in settings
• 1991210^: Color theme resets with page reload
• 1991229^: Selecting all machines in a state in the UI causes traceback in backend
• 1991372^: websocket config update notifications are no longer sent
• 1991410^: wildcard DNS entry is not allowed
• 1991792^: machine.action clone does not accept filter
• 1991795^: machine.action does not always throw errors for failed machines
• 1992332^: websocket machine.list parent group label should return hostname
• 1992686^: MAAS 3.3 alpha missing two existing filters
• 1992975^: Grouping by parents fails if there’s more than one page

More bug-fixes are planned for later 3.3 releases.

MAAS 3.3 Beta 2 bug list

• 1990289^: allocate call with system_id can allocate a new machine
• 1991784^: [needs-packaging] GL Excess
• 1992185^: unable to deploy a machine with vmhost if a bond interface was created
• 1992494^: Jammy KVM host support
• 1992791^: Info icons appear/disappear based on checked options in subnet page
• 1993289^: Pod storage pool path can’t be blank

MAAS 3.3 Beta 3 bug list

• 1835271^: Ephemeral deployment keeps cloud-inits autogenerated netplan config
• 1843268^: maas become unresponsive with maasserver_notification stuck at concurrent update
• 1886045^: Error message mentions Pods when trying to release a machine
• 1886850^: Encrypt the BMC credentials
• 1937138^: Calling mark_intro_complete doesn’t respond correctly
• 1955709^: Metadata field may_reboot not working correctly in 20.04
• 1988229^: dhcp snippet create fails when dhcp subnet is relayed regression
• 1990383^: Link subnet on new machine
• 1992330^: Use the rack controller IP as DNS when relaying DHCP
• 1993032: maas_hardware_sync creds are readable to local users on deployed OS and can give a super user access to MAAS itself
• 1993152^: Updating a VM host through API unset tags
• 1994899^: MAAS cannot mark “broken” VMs as fixed without recommissioning
• 1995397^: Sentry blocked by CORS
• 1995624^: suppressing script results no longer available on machine listing
• 1996065^: CLI errors when redirecting the output to a file
• 1996074^: Machine details stuck at “Loading” for machines with no disks
• 1996419^: renaming a DNS record to a previous name fails with error: list.remove(x): x not in list
• 1996935^: agent.yaml.example is missing when maas is installed via snap
• 1997190^: Power parameters access attempt from non-db thread
• 1997191^: Uncaught exception when configuring DNS
• 1997281^: machine.count fails for new filter options
• 1997599^: Losing LXD certificate

MAAS 3.3 RC1 bug list

• 1997975^: Update grafana_agent/agent.yaml.example

MAAS 3.3 RC3 bug list

• 1990172^: “20-maas-03-machine-resources” commissioning script improperly reports a Pass when the test fails

MAAS 3.3.0 bug list

• 2003888^: Grouped machine list view: Inconsistent display when machine state changes

---

Last updated a month ago.