New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ADR: Home Assistant OS as supported installation method #395
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| # 0015. Installation method: Home Assistant OS | ||
|
|
||
| Date: 2020-06-08 | ||
|
|
||
| ## Status | ||
|
|
||
| Accepted | ||
|
|
||
| ## Context | ||
|
|
||
| Define a supported installation method as per [ADR-0012](https://github.com/home-assistant/architecture/blob/master/adr/0012-define-supported-installation-method.md). | ||
|
|
||
| ## Decision | ||
|
|
||
| Home Assistant OS is the full installation of our all-inclusive home automation system. Best in class home automation is complemented with a UI for configuring your system, making backups and safe updates with automatic rollback. | ||
|
|
||
| This is the generally recommended installation method and the one that our website and documentation should be focused on. | ||
|
|
||
| ### Supported boards/hardware/machines | ||
|
|
||
| - Raspberry Pi 3 Model B and B+ 32bit | ||
| - Raspberry Pi 3 Model B and B+ 64bit | ||
| - Raspberry Pi 4 Model B 32bit | ||
| - Raspberry Pi 4 Model B 64bit | ||
| - Tinkerboard | ||
| - ODROID-C2 | ||
| - ODROID-N2 | ||
| - ODROID-XU4 | ||
| - Intel NUC | ||
| - Virtual Machine (64 bits intel-based) | ||
|
|
||
| ### Supported Operating Systems and versions | ||
|
|
||
| This installation method is only available and supported using the Home Assistant Operating System. Only the latest major version is supported (Currently, 4.x). | ||
|
|
||
| When a new major version is released, the previous major version will be dropped with a deprecation period of 2 months. The last 3 minor releases are supported. | ||
|
|
||
| ### Supported Hypervisors | ||
|
|
||
| The Home Assistant Operating System can be run on a Hypervisor and thus be run as a virtual machine. The following Hypervisors are supported: | ||
|
|
||
| - VirtualBox | ||
| - VMWare | ||
| - Xen | ||
| - Qemu | ||
|
|
||
| We will provide documentation for the following systems build on top of these technologies: | ||
|
|
||
| - VirtualBox | ||
| - VMWare | ||
| - Proxmox | ||
| - UnRaid | ||
|
|
||
| ### Required Expertise | ||
|
|
||
| - **Installation** | ||
| Installation requires the user to install the disk image for their device, install an image flasher (Etcher) and flash the image to the disk. Then insert image and boot their device. | ||
|
|
||
| * **Start when the system is started:** Managed by installer | ||
| * **Run with full network access:** Managed by installer | ||
| * **Access USB devices:** Managed by supervisor | ||
|
|
||
| * **Maintaining the Home Assistant installation** | ||
| Ongoing maintenance can be done via the user interface. User will be notified if an update is available for the operating system or for Home Assistant. Updates will be automatically rolled back if they fail. | ||
|
|
||
| - **Python upgrades:** Managed via HA updates | ||
| - **Installing Python dependencies:** Managed via HA updates | ||
| - **Updating Home Assistant:** Via a UI | ||
|
|
||
| - **Maintaining the Operating System** | ||
| Ongoing maintenance can be done via the user interface. User will be notified if an update is available for the operating system. Updates will be automatically rolled back if they fail. | ||
|
|
||
| * **Security updates for OS:** Managed via HA OS updates | ||
|
|
||
| * **Maintaining the components required for the Supervisor:** Managed via HA OS updates | ||
|
|
||
| **Conclusion:** low expertise required. Besides the installation methods, everything is done via the UI. | ||
|
|
||
| ## Consequences | ||
|
|
||
| Update documentation on how to install this method, the required experience and the expected maintenance. | ||
|
|
||
| Move existing related documentation that does not match the requirements to the community guides wiki. | ||
|
|
||
| Add checks to Home Assistant to warn (but not forbid) when not all requirements are met for this installation method. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am not sure what this means?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm reading it as ATM
4.10,4.09,4.08are supported and 3.13 will be dropped within 2 month. But it is not clear whether 3.13 if it is still supported in this period.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I understand what 3 minor releases is but I do not understand what supported means here.