MAAS Documentation

MAAS is Metal As A Service, a service that lets you treat physical servers like virtual machines – instances – in the cloud. No need to manage servers individually: MAAS turns your bare metal into an elastic, cloud-like resource.

Quick questions you might have:

Part of the machine list from Metaphorical General Hospital, our example datacentre.


New version of MAAS


Getting support


Contribute

Navigation

Introduction

Installing MAAS

Controllers

Machines

Images

Networking

VM hosting

Operations

Concepts & terms

CLI

API documentation

Troubleshoot

Release notes

Help improve these docs

Contact us

URLs

Mapping table
TOPIC PATH
Adding a VM host /docs/add-a-vm-host
VM host storage pools /docs/vm-host-storage-pools
VM host networking /docs/vm-host-networking
"Give me an example of MAAS" /docs/maas-example-config
Non-snap MAAS installs /docs/non-snap-maas-installs
Concepts and terms /docs/network-tutorial
MAAS Documentation /docs
API authentication /docs/api-authentication
Contact us /docs/contact-us
Tips, tricks, and traps /docs/tips-tricks-and-traps
Writing guide /docs/writing-guide
Block Devices /docs/block-devices
Installation and Configuration Checklist /docs/installation-and-configuration-checklist
Select and import images /docs/select-and-import-images
Local image mirror /docs/local-image-mirror
VMWare images /docs/vmware-images
Images /docs/images
Installation /docs/install-from-a-snap
MAAS installation from ISO /docs/install-from-iso
Install with LXD /docs/install-with-lxd
Network discovery /docs/network-discovery
Managing DHCP /docs/dhcp
IP ranges /docs/ip-ranges
IPv6 addressing /docs/ipv6
NTP services /docs/ntp
Proxy /docs/proxy
Configuring TLS encryption /docs/ssl
Managing STP /docs/stp
Subnet management /docs/subnet-management
Configure Networking /docs/networking
Networking /docs/networking
MAAS installation from packages /docs/install-from-packages
Partitions /docs/partitions
Rack controllers /docs/rack-controller
Region controllers /docs/region-controller
MAAS installation from a snap /docs/install-from-a-snap
Disk Erasure /docs/disk-erasure
Storage /docs/storage
MAAS logging /docs/logging
Commissioning logs /docs/commissioning-logs
Upgrade 2.3 to 2.4 from Ubuntu 16.04 /docs/upgrade-2-3-to-2-4-from-ubuntu-16-04
Upgrade from 1.9 to 2.x /docs/upgrade-from-1-9-to-2-x
Upgrading MAAS /docs/upgrading-maas
VMware VMFS datastores /docs/vmware-vmfs-datastores
Configuration journey /docs/configuration-journey
Accessing MAAS /docs/web-ui
MAAS communication /docs/maas-communication
Zone Examples /docs/zone-examples
Concepts and terms /docs/concepts-and-terms
Introduction to controllers /docs/introduction-to-controllers
https://discourse.maas.io/t/explore-maas/787/ /docs/explore-maas
https://discourse.maas.io/t/whats-new-in-2-6/788/ /docs/whats-new-in-2-6
https://discourse.maas.io/t/maas-requirements/789/ /docs/maas-requirements
https://discourse.maas.io/t/what-is-maas/840/ /docs/what-is-maas
https://discourse.maas.io/t/user-accounts/790/ /docs/user-accounts
https://discourse.maas.io/t/audit-event-logs/791/ /docs/audit-event-logs
https://discourse.maas.io/t/backup/792/ /docs/backup
https://discourse.maas.io/t/advanced-cli-tasks/793/ /docs/advanced-cli-tasks
https://discourse.maas.io/t/common-cli-tasks/794/ /docs/common-cli-tasks
https://discourse.maas.io/t/cli-composable-machines-management/795/ /docs/composable-hardware
https://discourse.maas.io/t/cli-dhcp-snippet-management/796/ /docs/cli-dhcp-snippet-management
https://discourse.maas.io/t/cli-image-management/797/ /docs/cli-image-management
https://discourse.maas.io/t/cli-interface-management/798/ /docs/cli-interface-management
https://discourse.maas.io/t/cli-kernel-management/799/ /docs/cli-kernel-management
https://discourse.maas.io/t/cli-resource-pool-management/800/ /docs/cli-resource-pool-management
https://discourse.maas.io/t/cli-tag-management/801/ /docs/cli-tag-management
https://discourse.maas.io/t/maas-cli/802/ /docs/maas-cli
https://discourse.maas.io/t/postgresql-ha-hot-standby/803/ /docs/postgresql-ha-hot-standby
https://discourse.maas.io/t/high-availability/804/ /docs/high-availability
https://discourse.maas.io/t/creating-and-deleting-new-vms/806/ /docs/creating-and-deleting-new-vms
https://discourse.maas.io/t/introduction-to-vm-hosting/1524 /docs/intro-to-vm-hosting
https://discourse.maas.io/t/api-client/810/ /docs/api-client
https://discourse.maas.io/t/hardening-your-maas-installation/1381 /docs/security
https://discourse.maas.io/t/prometheus-metrics/813/ /docs/prometheus-metrics
https://discourse.maas.io/t/package-repositories/814/ /docs/package-repositories
https://discourse.maas.io/t/add-an-rsd-host/815/ /docs/add-an-rsd-host
https://discourse.maas.io/t/creating-and-deleting-machines/816/ /docs/creating-and-deleting-machines
https://discourse.maas.io/t/intel-rack-scale-design-rsd-introduction/817/ /docs/intel-rack-scale-design-rsd-introduction
https://discourse.maas.io/t/rsd-storage/818/ /docs/rsd-storage
https://discourse.maas.io/t/interactive-search/819/ /docs/interactive-search
https://discourse.maas.io/t/availability-zones/820/ /docs/availability-zones
https://discourse.maas.io/t/documentation-index/839/ /docs/documentation-index
https://discourse.maas.io/t/add-nodes/821/ /docs/add-nodes
https://discourse.maas.io/t/commission-nodes/822/ /docs/commission-nodes
https://discourse.maas.io/t/custom-node-setup-preseed/824/ /docs/custom-node-setup-preseed
https://discourse.maas.io/t/deploy-nodes/825/ /docs/deploy-nodes
https://discourse.maas.io/t/hardware-testing/826/ /docs/hardware-testing
https://discourse.maas.io/t/kernel-boot-options/827/ /docs/kernel-boot-options
https://discourse.maas.io/t/ubuntu-kernels/828/ /docs/ubuntu-kernels
https://discourse.maas.io/t/node-overview/829/ /docs/machine-overview
https://discourse.maas.io/t/bmc-power-types/830/ /docs/bmc-power-types
https://discourse.maas.io/t/resource-pools/831/ /docs/resource-pools
https://discourse.maas.io/t/cli-testing-scripts/832/ /docs/cli-testing-scripts
/t/cli-commissioning-and-hardware-testing-scripts/832 /docs/cli-testing-scripts
https://discourse.maas.io/t/commissioning-and-hardware-testing-scripts/833/ /docs/commissioning-and-hardware-testing-scripts
https://discourse.maas.io/t/tags/834/ /docs/tags
https://discourse.maas.io/t/historical-release-notes/835/ /docs/historical-release-notes
https://discourse.maas.io/t/troubleshooting/837/ /docs/troubleshooting
https://discourse.maas.io/t/getting-help/838/ /docs/getting-help
https://discourse.maas.io/t/historical-release-notes/835/ /docs/whats-new-in-2-6
https://discourse.maas.io/t/historical-release-notes/835/ /docs/whats-new-in-2-7
https://discourse.maas.io/t/historical-release-notes/835/ /docs/maas-2-7-release-notes
https://discourse.maas.io/t/whats-new-in-maas-2-8/1655 /docs/release-notes
https://discourse.maas.io/t/network-testing/1267 /docs/network-testing
https://discourse.maas.io/t/markdown-test/1561 /docs/markdown-test
https://discourse.maas.io/t/maas-image-builder/1112 /docs/image-builder
POTENTIALLY ORPHANED TOPIC (NEEDS CHECKING) PATH
https://discourse.maas.io/t/language-details-contributing-to-maas-docs/745/ /docs/language-details-contributing-to-maas-docs
DEPRECATED TOPIC (MAY NEED MARKING AS SUCH) PRESERVED PATH
https://discourse.maas.io/t/building-the-docs/744/ /docs/building-the-docs
https://discourse.maas.io/t/working-with-git-and-github/746/ /docs/working-with-git-and-github

Redirects

Mapping table
PATH LOCATION
/docs/pods /docs/intro-to-vm-hosting
/docs/manage-composable-machines /docs/intro-to-vm-hosting
/docs/kvm-introduction /docs/intro-to-vm-hosting
/docs/manage-kvm-intro /docs/intro-to-vm-hosting
/docs/add-a-kvm-host /docs/add-a-vm-host
/docs/manage-kvm-add-host /docs/add-a-vm-host
/docs/manage-kvm-storage /docs/vm-host-storage-pools
/docs/kvm-host-storage-pools /docs/vm-host-storage-pools
/docs/kvm-host-networking /docs/vm-host-networking
/docs/manage-kvm-host-networking /docs/vm-host-networking
-------------------------------------- -----------------------------------------
/docs/language-details-contributing-to-juju-docs /docs/language-details-contributing-to-maas-docs
/docs/contributing-build /docs/building-the-docs
/docs/contributing-en-GB /docs/language-details-contributing-to-juju-docs
/docs/contributing-git /docs/working-with-git-and-github
/docs/contributing-writing /docs/writing-guide
/docs/installconfig-block /docs/block-devices
/docs/installconfig-checklist /docs/installation-and-configuration-checklist
/docs/installconfig-images-import /docs/select-and-import-images
/docs/installconfig-images-mirror /docs/local-image-mirror
/docs/installconfig-images-vmware /docs/vmware-images
/docs/installconfig-images /docs/images
/docs/installconfig-install /docs/install-from-a-snap
/docs/installation /docs/install-from-a-snap
/docs/installconfig-iso-install /docs/install-from-iso
/docs/installconfig-lxd-install /docs/install-with-lxd
/docs/installconfig-network-dev-discovery /docs/network-discovery
/docs/installconfig-network-dhcp /docs/dhcp
/docs/installconfig-network-ipranges /docs/ip-ranges
/docs/installconfig-network-ipv6 /docs/ipv6
/docs/installconfig-network-ntp /docs/ntp
/docs/installconfig-network-proxy /docs/proxy
/docs/installconfig-network-ssl /docs/ssl
/docs/installconfig-network-stp /docs/stp
/docs/installconfig-network-subnet-management /docs/subnet-management
/docs/installconfig-networking-config /docs/networking
/docs/configure-networking /docs/networking
/docs/installconfig-networking /docs/networking
/docs/installconfig-package-install /docs/install-from-packages
/docs/installconfig-partitions /docs/partitions
/docs/installconfig-rack /docs/rack-controller
/docs/installconfig-region /docs/region-controller
/docs/installconfig-snap-install /docs/install-from-a-snap
/docs/installconfig-storage-erasure /docs/disk-erasure
/docs/installconfig-storage /docs/storage
/docs/installconfig-syslog /docs/syslog
/docs/installconfig-upgrade-postgres /docs/upgrade-2-3-to-2-4-from-ubuntu-16-04
/docs/installconfig-upgrade-to-2 /docs/upgrade-from-1-9-to-2-x
/docs/installconfig-upgrade /docs/upgrading-maas
/docs/installconfig-vmfs-datastores /docs/vmware-vmfs-datastores
/docs/installconfig-webui-conf-journey /docs/configuration-journey
/docs/installconfig-webui /docs/web-ui
/docs/intro-communication /docs/maas-communication
/docs/maas-communcation /docs/maas-communication
/docs/intro-concepts-zones /docs/zone-examples
/docs/intro-concepts /docs/concepts-and-terms
/docs/intro-controllers /docs/introduction-to-controllers
/docs/intro-explore /docs/explore-maas
/docs/intro-new /docs/whats-new-in-maas-2-7
/docs/intro-requirements /docs/what-is-maas
/docs/intro-what-is-maas /docs/what-is-maas
/docs/maas-security /docs/security
/docs/manage-account /docs/user-accounts
/docs/manage-audit-events /docs/audit-event-logs
/docs/manage-backup /docs/backup
/docs/manage-cli-advanced /docs/advanced-cli-tasks
/docs/manage-cli-common /docs/common-cli-tasks
/docs/manage-cli-comp-hw /docs/cli-composable-machines-management
/docs/manage-cli-dhcp-snippets /docs/cli-dhcp-snippet-management
/docs/manage-cli-images /docs/cli-image-management
/docs/manage-cli-interfaces /docs/cli-interface-management
/docs/manage-cli-kernels /docs/cli-kernel-management
/docs/manage-cli-resource-pools /docs/cli-resource-pool-management
/docs/manage-cli-tags /docs/cli-tag-management
/docs/manage-cli /docs/maas-cli
/docs/manage-ha-postgresql /docs/postgresql-ha-hot-standby
/docs/manage-ha /docs/high-availability
/docs/manage-kvm-create-vms /docs/creating-and-deleting-new-vms
/docs/manage-libmaas /docs/api-client
/docs/manage-maas-security /docs/security
/docs/manage-pods-webui /docs/manage-composable-machines
/docs/manage-prometheus-metrics /docs/prometheus-metrics
/docs/manage-repos /docs/package-repositories
/docs/manage-rsd-add /docs/add-an-rsd-host
/docs/manage-rsd-create /docs/creating-and-deleting-machines
/docs/manage-rsd-intro /docs/intel-rack-scale-design-rsd-introduction
/docs/manage-rsd-storage /docs/rsd-storage
/docs/manage-search /docs/interactive-search
/docs/manage-zones /docs/availability-zones
/docs/metadata.y /docs/documentation-index
/docs/nodes-add /docs/add-nodes
/docs/nodes-commission /docs/commission-nodes
/docs/nodes-comp-hw /docs/intro-to-vm-hosting
/docs/nodes-custom /docs/custom-node-setup-preseed
/docs/nodes-deploy /docs/deploy-nodes
/docs/nodes-hw-testing /docs/hardware-testing
/docs/nodes-kernel-options /docs/kernel-boot-options
/docs/nodes-kernels /docs/ubuntu-kernels
/docs/nodes-overview /docs/machine-overview
/docs/node-overview /docs/machine-overview
/docs/nodes-power-types /docs/bmc-power-types
/docs/nodes-resource-pools /docs/resource-pools
/docs/nodes-scripts-cli /docs/cli-testing-scripts
/docs/nodes-scripts /docs/commissioning-and-hardware-testing-scripts
/docs/syslog /docs/logging
/docs/nodes-tags /docs/tags
/docs/release-notes-all /docs/historical-release-notes
/docs/release-notes /docs/maas-2-7-release-notes
/docs/troubleshoot-faq /docs/troubleshooting
/docs/troubleshoot-getting-help /docs/getting-help