af9131cd10
Prefer the containerd snapshotter by using it by default for new installs and when no Docker data is present (e.g. after datadisk wipe). The snapshotter is enabled by a dockerd flag which is set when a flag file is present in the data partition. This flag file can be used also to opt-in for this snapshotter on legacy installs (high level API through OS Agent and Supervisor TBD), to migrate to the containerd snapshotter this file can be simply created manually. Testing shown no major problems when migrating, the old overlay2 folder can be (and should be - to avoid situations where the data disk might run out of space) deleted before the docker.service is started in the docker-prepare script. Note that there's no offline migration path, OS needs to be connected to the internet to re-download the images when migrating. This could be theoretically possible through docker image save/load functions but guarding for enough of space and other edge cases would be probably too complex to justify it. Refs #4252 Refs #4253 - easier opt-in method is still needed Closes #4254 - migration is handled seamlessly by Docker
Home Assistant Operating System
Home Assistant Operating System (formerly HassOS) is a Linux based operating system optimized to host Home Assistant and its Add-ons.
Home Assistant Operating System uses Docker as its container engine. By default it deploys the Home Assistant Supervisor as a container. Home Assistant Supervisor in turn uses the Docker container engine to control Home Assistant Core and Add-Ons in separate containers. Home Assistant Operating System is not based on a regular Linux distribution like Ubuntu. It is built using Buildroot and it is optimized to run Home Assistant. It targets single board compute (SBC) devices like the Raspberry Pi or ODROID but also supports x86-64 systems with UEFI.
Features
- Lightweight and memory-efficient
- Minimized I/O
- Over The Air (OTA) updates
- Offline updates
- Modular using Docker container engine
Supported hardware
The list of supported hardware is defined by ADR-0015. Every new hardware addition must meet at least requirements defined in ADR-0017 and pass through an architecture design proposal.
For documentation explaining details of the individual supported boards, see Board support section of the Home Assistant Developer Docs.
Getting Started
If you just want to use Home Assistant the official getting started guide and installation instructions take you through how to download Home Assistant Operating System and get it running on your machine.
If you're interested in finding out more about Home Assistant Operating System and how it works read on...
Development
If you don't have experience with embedded systems, Buildroot or the build process for Linux distributions it is recommended to read up on these topics first (e.g. Bootlin has excellent resources).
The Home Assistant Operating System documentation can be found on the Home Assistant Developer Docs website.
Components
- Bootloader:
- Operating System:
- Buildroot LTS Linux
- File Systems:
- Container Platform:
- Docker Engine for running Home Assistant components in containers
- Updates:
- RAUC for Over The Air (OTA) and USB updates
- Security:
- AppArmor Linux kernel security module
Development builds
The Development build GitHub Action Workflow is a manually triggered workflow which creates Home Assistant OS development builds. The development builds are available at https://os-artifacts.home-assistant.io/index.html.