As of MAAS 3.0 Beta1, this page has been deprecated and the content moved to the CLI sections of other, relevant MAAS documents. The contents may or may not diverge from the latest information over time.
The following is a list of image management tasks to perform with the MAAS CLI.
Nine questions you may have:
- How do I get started with the MAAS CLI?
- What might I need to know about images?
- How do I list boot sources?
- How do I select images?
- How do I list image selections?
- How do I import newly-selected images?
- How do I list currently available images?
- How do I delete a boot source?
- How do I edit a boot source?
List boot sources
If you want to download boot sources, i.e., the locations from which you may download images, try the following:
maas $PROFILE boot-sources read
NOTE:
Although multiple boot sources may be listed, MAAS can only practically work with a single boot source.
Select images
Use the boot-source-selections command to select images from a boot source. After selecting new images, you will need to import them.
maas $PROFILE boot-source-selections create $SOURCE_ID \
os="ubuntu" release="$SERIES" arches="$ARCH" \
subarches="$KERNEL" labels="*"
For example, to select all kernels for 64-bit Trusty from a boot source with an id of ‘1’:
maas $PROFILE boot-source-selections create 1 \
os="ubuntu" release="trusty" arches="amd64" \
subarches="*" labels="*"
Hardware enablement (HWE)
For example, to get just the latest amd64 HWE kernel available for Trusty, which, at time of writing, is from Xenial:
maas $PROFILE boot-source-selections create 1 \
os="ubuntu" release="trusty" arches="amd64" \
subarches="hwe-x" labels="*"
For Xenial kernels (and starting with MAAS 2.1), notation has changed. To select the latest amd64 HWE kernel available for Xenial:
maas $PROFILE boot-source-selections create 1 \
os="ubuntu" release="xenial" arches="amd64" \
subarches="hwe-16.04" labels="*"
List image selections
To list image selections for a boot source:
maas $PROFILE boot-source-selections read $SOURCE_ID
Import newly-selected images
To import newly-selected images (boot resources):
maas $PROFILE boot-resources import
Once newly-selected images are imported, a sync mechanism is enabled (by default) to keep them up to date. The refresh time interval is 60 minutes.
Available images resulting from this action are reflected in the web UI.
List currently available images
To list currently available/imported images (boot resources):
maas $PROFILE boot-resources read
Delete a boot source
To delete a boot source (the location from which you can download images):
maas $PROFILE boot-source delete $SOURCE_ID
If you delete the sole boot source, then the fields ‘Sync URL’ and ‘Keyring Path’ in the web UI will take on null values.
Edit a boot source
You can edit an existing boot source by changing the GPG keyring file ($KEYRING_FILE) and the location ($URL).
Update the boot source:
maas $PROFILE boot-source update $SOURCE_ID \
url=$URL keyring_filename=$KEYRING_FILE
At this time MAAS only supports a boot source containing official MAAS images. As a result, you can only edit a boot source if you have set up a mirror of its images. The location can change, but the keyring remains constant:
KEYRING_FILE=/usr/share/keyrings/ubuntu-cloudimage-keyring.gpg
Add a boot source
NOTE:
To avoid unnecessary complexity, you should probably delete any existing boot sources before adding a new one.
Presented below are two use cases for adding a boot source:
- Use a local image mirror (official images)
- If you deleted the default image, recreate it
The general syntax is:
maas $PROFILE boot-sources create \
url=$URL keyring_filename=$KEYRING_FILE
The output will include a new numeric ID that identifies the boot source ($SOURCE_ID).
Since MAAS can only practically work with a single boot source, so you will need to delete any existing sources. Note that the location (URL) is the only variable. The only supported keyring is:
KEYRING_FILE=/usr/share/keyrings/ubuntu-cloudimage-keyring.gpg
If you added a sole boot source, then the fields ‘Sync URL’ and ‘Keyring Path’ in the web UI will reflect its values.
Once the source is added, proceed to the Select and import images step.
Using a local image mirror
Once the mirror is set up according to Local image mirror it is just a matter of specifying the mirror location (URL). Since the images come from the default source, you should use the default keyring. If you are following the above mirror document, the variable values should be:
- URL=https://$MIRROR/maas/images/ephemeral-v3/stable/
- KEYRING_FILE=/usr/share/keyrings/ubuntu-cloudimage-keyring.gpg
Where $MIRROR is the mirror server’s hostname or IP address.
Recreate the default boot source
Recreate the default boot source if it was ever deleted using the following variable values:
- URL=https://images.maas.io/ephemeral-v3/stable/
- KEYRING_FILE=/usr/share/keyrings/ubuntu-cloudimage-keyring.gpg