MAAS documentation

Docs
#1

MAAS is Metal As A Service, a service that treats physical servers like virtual machines (instances) in the cloud.

No need to manage servers individually: MAAS turns bare metal into an elastic, cloud-like resource. Enlist and deploy standard or customised operating systems to hardware and virtual machines – remotely. Monitor, manage, and secure your metal infrastructure easily and efficiently.

MAAS comprehensively meets the need to rapidly deploy, destroy, and reconfigure constellations of bare metal. Any application that requires frequently rearranging the server topology will benefit.

MAAS is applicable to nearly any situation. It is currently deployed in banking, telecom, and industrial environments, as well as niche uses as diverse as national lotteries, supercomputer front-end validation, streaming music services, disaster recovery, and computer security risk analysis.

In this documentation
Tutorials
Hands-on introduction to MAAS features for new users		 How-to guides
Step-by-step guides covering key operations and common tasks
Reference
Technical information - specifications, APIs, architecture		 Explanation
Detailed theory on the inner workings of MAAS

Project and community

MAAS is a member of the Ubuntu family. It’s an open source project that warmly welcomes community projects, contributions, suggestions, fixes and constructive feedback.

Our roadmap

Here’s a view of our current roadmap:

Considering MAAS for your next project? Get in touch↗

Navigation

Navigation items
Level Path Navlink
0 / MAAS Documentation
0
1 tutorials Tutorials
2 bootstrap-maas Bootstrap MAAS
2 try-out-the-maas-cli Try out the MAAS CLI
2 create-custom-images Create custom images
2 get-fancy-cli-output Get fancy CLI output
0
1 how-to-guides How-to guides
2 how-to-get-started-with-maas Get started with MAAS
3 how-to-do-a-fresh-install-of-maas Do a fresh install of MAAS
3 how-to-upgrade-maas Upgrade MAAS
3 how-to-spin-up-maas-with-ansible Spin up MAAS with Ansible
2 how-to-set-up-networks Set up networks
3 how-to-connect-maas-networks Connect MAAS networks
3 how-to-enable-dhcp Enable DHCP
3 how-to-use-availability-zones Use availability zones
2 how-to-use-images Use images
3 how-to-use-standard-images Use standard images
3 how-to-mirror-images-locally Mirror images locally
3 how-to-customise-images Customise images
3 how-to-employ-vmware-images Employ VMWare images
3 how-to-deploy-a-rt-kernel Deploy a RT kernel
2 how-to-manage-controllers Manage controllers
3 how-to-configure-controllers Configure controllers
3 how-to-enable-high-availability Enable high availability
2 how-to-manage-machines Manage machines
3 how-to-make-machines-available Make machines available
3 how-to-customise-machines Customise machines
3 how-to-put-machines-to-work Put machines to work
2 how-to-use-virtual-machines Use virtual machines
3 how-to-set-up-lxd Set up LXD
3 how-to-manage-vm-hosts Manage VM hosts
3 how-to-manage-vms Manage virtual machines
2 how-to-label-devices Label devices
3 how-to-tag-machines Tag machines
3 how-to-annotate-machines Annotate machines
3 how-to-use-machine-tags Use machine tags
3 how-to-use-controller-tags Use controller tags
3 how-to-use-storage-tags Use storage tags
3 how-to-use-network-tags Use network tags
3 how-to-find-machines Find machines
2 how-to-secure-maas Secure MAAS
3 how-to-improve-maas-security Improve MAAS security
3 how-to-manage-user-accounts Manage user accounts
3 how-to-enable-maas-native-tls Enable MAAS native TLS
3 how-to-enable-vault Enable Vault
3 how-to-unseal-vault Unseal Vault
3 how-to-set-up-an-air-gapped-maas Set up an air-gapped MAAS
2 how-to-operate-maas Operate MAAS
3 how-to-back-up-maas Back up MAAS
3 how-to-monitor-maas Monitor MAAS
3 how-to-gauge-maas-performance Gauge MAAS performance
3 how-to-audit-maas Audit MAAS
3 how-to-terraform-with-maas Terraform with MAAS
3 how-to-troubleshoot-maas Troubleshoot MAAS
2 how-to-give-and-receive-help Give and receive help
3 how-to-use-our-discourse-forum Use our Discourse forum
3 how-to-get-support Get support
3 how-to-request-new-features Request new features
3 how-to-review-and-report-bugs Review and report bugs
3 how-to-contribute-code Contribute code
3 how-to-help-improve-the-doc Improve the doc
0
1 reference Reference
2 general-reference General reference
3 release-notes Release notes
3 installation-requirements Installation requirements
3 maas-settings MAAS settings
3 maas-glossary Glossary
3 code-of-conduct Code of conduct
2 api-reference API reference
3 api-authentication-reference API authentication
3 python-api-client-reference Python API client
3 maas-api-documentation API documentation
2 scripts-reference Scripts reference
3 commissioning-scripts-reference Commissioning scripts
3 testing-scripts-reference Hardware test scripts
2 log-reference Log reference
3 event-logs-reference Event logs
3 audit-event-logs-reference Audit event logs
3 commissioning-logs-reference Commissioning logs
3 testing-logs-reference Testing logs
2 machine-parameters-reference Machine parameters reference
2 power-drivers-reference Power drivers
2 storage-layouts-reference Storage layouts
0
1 explanation Explanation
2 about-maas About MAAS
2 about-maas-networks About MAAS networks
2 about-images About images
2 about-controllers About controllers
2 about-machines About machines
2 about-maas-events About MAAS events
2 about-maas-logging About MAAS logging
about-ansible About Ansible

Redirects

Mapping table
PATH LOCATION
/docs/about-rbac /docs/how-to-protect-your-secrets
/docs/maas-terraform-provider /docs/maas-terraform-provider-reference
/docs/commissioning-script-reference /docs/commissioning-scripts-tech-reference
/docs/technical-reference /docs/maas-technical-reference
/docs/how-to-set-up-maas-metrics /docs/how-to-observe-a-live-maas
/docs/how-to-back-up-maas /docs/how-to-keep-maas-backed-up
/docs/how-to-use-maas-in-an-air-gapped-environment /docs/how-to-set-up-an-air-gapped-maas
/docs/how-to-enable-tls-encryption /docs/how-to-enable-maas-native-tls
/docs/how-to-secure-maas /docs/how-to-improve-maas-security
/docs/maas-logging-reference /docs/how-to-work-with-log-files
/docs/how-to-search-maas /docs/how-to-find-machines
/docs/how-to-work-with-annotations /docs/how-to-annotate-machines
/docs/how-to-work-with-tags /docs/how-to-tag-machines
/docs/how-to-use-tags /docs/how-to-label-and-find-machines
/docs/how-to-manage-vms /docs/how-to-create-and-manage-vms
/docs/how-to-manage-vm-hosts /docs/how-to-create-vm-hosts
/docs/how-to-use-lxd /docs/how-to-set-up-lxd
/docs/how-to-deploy-machines /docs/how-to-put-machines-to-work
/docs/how-to-manage-machines /docs/how-to-make-machines-available
/docs/how-to-deploy-maas /docs/how-to-deploy-physical-machines
/docs/how-to-manage-controllers /docs/how-to-adjust-your-controllers
/docs/how-to-manage-vmware-images /docs/how-to-employ-vmware-images
/docs/how-to-create-custom-images /docs/how-to-build-custom-images
/docs/how-to-import-images /docs/how-use-standard-images
/docs/how-to-choose-images /docs/how-to-acquire-images
/docs/how-to-manage-ip-addresses /docs/how-to-enable-dhcp
/docs/how-to-manage-networks /docs/how-to-connect-maas-networks
/docs/how-to-configure-networking /docs/how-to-set-up-networks
/docs/report-a-bug /docs/how-to-report-a-bug
/docs/request-a-feature /docs/how-to-request-a-feature
/docs/how-to-get-help /docs/how-to-ask-for-help
/docs/configuration-settings-reference /docs/how-to-change-maas-settings
/docs/ansible-playbooks-reference /docs/how-to-spin-up-maas-with-ansible
/docs/how-to-get-maas-running /docs/how-to-get-started-with-maas
/docs/create-a-custom-image /docs/custom-image-tutorial
/docs/how-to-use-the-maas-cli /docs/try-out-the-maas-cli
/docs/maas-bootstrap-tutorial /docs/get-started-with-maas
/docs/tutorials /docs/basic-tutorials
/docs/maas-concepts-and-terms-reference /docs/maas-glossary
/docs/installation-requirements /docs/maas-installation-requirements
/docs/whats-new-in-maas /docs/what-is-new-with-maas
/docs/vmware-images /docs/how-to-employ-vmware-images
/docs/about-tags /docs/how-to-label-and-find-machines
/docs/ssl /docs/how-to-enable-maas-native-tls
/docs/stp /docs/how-to-connect-maas-networks
/docs/subnet-management /docs/how-to-connect-maas-newtorks
/docs/deploy-nodes /docs/how-to-put-machines-to-work
/docs/storage /docs/about-machines#heading–machine-storage
/docs/how-to-manage-regions /docs/how-to-adjust-your-controllers
/docs/how-to-manage-racks /docs/how-to-adjust-your-controllers
/docs/how-to-create-a-custom-ubuntu-image /docs/how-to-build-custom-images
/docs/how-to-build-maas-images/docs/how-to-build-custom-images
/docs/how-to-use-image-streams /docs/how-use-standard-images
/docs/how-to-manage-dhcp /docs/how-to-enable-dhcp
/docs/how-to-manage-ip-ranges /docs//docs/how-to-enable-dhcp
/docs/how-to-set-up-ntp-services /docs/how-to-connect-maas-networks
/docs/how-to-manage-machine-interfaces /docs/how-to-connect-maas-networks
/docs/how-to-manage-proxies /docs/how-to-connect-maas-networks
/docs/deb/3.0/cli/how-to-work-with-tags /docs/how-to-tag-machines
/docs/deb/3.0/ui/how-to-work-with-tags /docs/how-to-tag-machines
/docs/deb/3.1/cli/how-to-work-with-tags /docs/how-to-tag-machines
/docs/deb/3.1/ui/how-to-work-with-tags /docs/how-to-tag-machines
/docs/snap/2.7/cli/how-to-upgrade-maas /docs/how-to-upgrade-maas
/docs/snap/2.7/cli/installation-tech-reference /docs/how-to-install-maas
/docs/snap/2.7/cli/interactive-search /docs/how-to-find-machines
/docs/snap/2.7/ui/how-to-upgrade-maas /docs/how-to-upgrade-maas
/docs/snap/2.7/ui/installation-tech-reference /docs/how-to-install-maas
/docs/snap/2.7/ui/interactive-search /docs/how-to-find-machines
/docs/snap/2.8/cli/how-to-upgrade-maas /docs/how-to-upgrade-maas
/docs/snap/2.8/cli/installation-tech-reference /docs/how-to-install-maas
/docs/snap/2.8/cli/interactive-search /docs/how-to-find-machines
/docs/snap/2.8/ui/how-to-upgrade-maas /docs/how-to-upgrade-maas
/docs/snap/2.8/ui/installation-tech-reference /docs/how-to-install-maas
/docs/snap/2.8/ui/interactive-search /docs/how-to-find-machines
/docs/snap/2.9/cli/how-to-work-with-tags /docs/how-to-tag-machiness
/docs/snap/2.9/ui/how-to-work-with-tags /docs/how-to-tag-machines
/docs/snap/3.0/cli/how-to-work-with-tags /docs/how-to-tag-machines
/docs/snap/3.0/ui/how-to-work-with-tags /docs/how-to-tag-machines
/docs/snap/3.1/cli/how-to-work-with-tags /docs/how-to-tag-machines
/docs/snap/3.1/ui/how-to-work-with-tags /docs/how-to-tag-machines