Labelling devices in MAAS

Make sense of your MAAS machine landscape with tags and filters

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

For small clusters of machines, the idea of extensively tagging and annotating might seem overkill. But as your infrastructure scales, you'll need tools to simplify navigation and management. Enter tags, annotations, and filters.

Automatic tagging is available starting in MAAS v3.2.

Key attributes for your machines

1. Tags & Annotations: They're not just for identification; they also steer machine behavior during commissioning and deployment. Learn more with these guides:

• Tagging guide
• Annotation guide
• Usage guides for machines, storage, controllers, and network interfaces.

2. Filtering: A UI-based tool for narrowing down your machine subsets.

Dig into tags

Tags are short descriptors that can be linked to various MAAS entities:

• Machines (physical and virtual)
• VM hosts
• Controllers (rack and region)
• Storage and network interfaces
• Devices and nodes (CLI only)

Annotations offer a more in-depth description of machines. They can be static (always visible) or dynamic (state-dependent).

Tags and scripts: Tags can also cluster scripts for tasks like commissioning and testing.

For example:

maas $PROFILE node-script add-tag $SCRIPT_NAME tag=$TAG
maas $PROFILE machine commission commissioning_scripts=$SCRIPT_NAME,$SCRIPT_TAG

Harness the power of automatic tags

Automatic tags bring definitions, allowing for automated machine tagging based on your set criteria through XPath expressions. These tags can identify unique hardware features and automatically apply to newly discovered machines that meet the criteria.

XPath expressions: These are mapped against lshw's XML output to define automatic tags.

Node capabilities: These can vary from CPU features to network speeds. Most capabilities are auto-documented by lshw.

Kernel options: Tags can also carry kernel options that activate during the boot or commissioning/deployment processes. If a machine has multiple tags, kernel options from all tags combine alphabetically.