more-info pages for unsupported systems (#15229)

Co-authored-by: Franck Nijhof <git@frenck.dev>
Co-authored-by: Fabian Affolter <mail@fabian-affolter.ch>
Co-authored-by: Kevin Cathcart <kevincathcart@gmail.com>
Co-authored-by: Pascal Vizeli <pvizeli@syshack.ch>
This commit is contained in:
Joakim Sørensen 2020-10-20 11:50:45 +02:00 committed by GitHub
parent 26f441cc37
commit 62022d3a4a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 234 additions and 0 deletions

View File

@ -0,0 +1,17 @@
---
title: "Containers known to cause issues"
description: "More information on why certain containers marks the installation as unsupported."
---
## The issue
The Supervisor needs to be the only manager of the containers that it manages, unfortunately, some other containers also take on this role. Worst case, those will auto-update the existing containers to development builds without consideration of the channel you have chosen. Because of this, a few containers known to cause issues, have been added to a denylist that will flag your installation as unsupported.
As stated in [ADR-0014](https://github.com/home-assistant/architecture/blob/master/adr/0014-home-assistant-supervised.md), running additional software on the host is not supported,
and more containers or other software can be added to the denylist without any notice.
## The solution
You will find a list of offending containers in your Supervisor log.
If you remove all offending containers from your host and then reload the Supervisor, it will no longer be marked as unsupported for this reason.

View File

@ -0,0 +1,18 @@
---
title: "D-Bus issues"
description: "More information on why missing D-Bus marks the installation as unsupported."
---
## The issue
D-Bus is how the Supervisor does most of the communication with the host,
without this, multiple things that the Supervisor needs to do will fail.
## The solution
If the D-Bus daemon is not running, start it.
If that does not help, reboot your operating system.
As a last resort, you need to reinstall the host running the Supervisor
with one of the supported operating systems, [see instructions here](/more-info/unsupported/os).

View File

@ -0,0 +1,32 @@
---
title: "Docker Configuration"
description: "More information on why Docker configuration marks the installation as unsupported."
---
## The issue
The Supervisor has some expectations of how the Docker daemon is configured to maintain the stability and performance of the host running the Supervisor.
The logging driver for the Docker daemon needs to be set to `journald` and the storage driver
needs to be set to `overlay2`.
## The solution
If you are running an older version of our Home Assistant OS, update it to the latest version in the Supervisor panel.
If you are running Home Assistant Supervised, you need to modify the Docker daemon
configuration on the host. The configuration is located at `/etc/docker/daemon.json`.
If that file doesn't exist, you can create it and make sure it at least has the
following contents:
```json
{
"log-driver": "journald",
"storage-driver": "overlay2"
}
```
When the Docker configuration file is changed and saved, you need to restart the
Docker service on the host machine.
You can also just re-run our [convenience installation script](https://github.com/home-assistant/supervised-installer).

View File

@ -0,0 +1,24 @@
---
title: "Docker Version"
description: "More information on why Docker version marks the installation as unsupported."
---
## The issue
The version that is needed by the Supervisor, depends on the features it needs
for it to work properly.
The current minimum supported version of Docker is: `19.03.0`.
However, the future set changes and improves over time and therefore, the minimal
required version may change in the future. When that happens, it will be communicated
before we publish a version that will require you to upgrade Docker.
## The solution
If you are running an older version of our Home Assistant OS, update it the
supervisor panel.
If this is not our Home Assistant OS, you need to manually update Docker on your
host for instructions on how to do that, check the official
[Docker documentation](https://docs.docker.com/engine/install/debian/).

View File

@ -0,0 +1,15 @@
---
title: "LXC"
description: "More information on why LXC marks the installation as unsupported."
---
## The issue
Running the Supervisor in an LXC virtual machine will cause issues both with
performance and with container management in general. Using LXC in combination
with the Supervisor is not supported.
## The solution
You need to reinstall the host operating system that runs the Supervisor,
for instructions on how to prosed with that [have a look here](/more-info/unsupported/os).

View File

@ -0,0 +1,69 @@
---
title: "Network Manager"
description: "More information on why the Network Manager marks the installation as unsupported."
---
## The issue
The Supervisor utilizes the Network Manager on the host to offer network information
to add-ons and to give you the option to manage the network interfaces using the UI
or via the command-line.
This requires the the Network Manager to be installed, active
and in control of at least one network interface on the host.
## The solution
If you have not already, install Network Manager on the host.
When it is installed, you need to make sure it manages at least one interface
[see the documentation for the network manager](https://wiki.debian.org/NetworkManager).
Here are some example files that can be used to make the Network Manager control all
physical interfaces.
`/etc/NetworkManager/NetworkManager.conf`:
```txt
[main]
dns=default
plugins=keyfile
autoconnect-retries-default=0
rc-manager=file
[keyfile]
unmanaged-devices=type:bridge;type:tun;type:veth
[logging]
backend=journal
```
`/etc/NetworkManager/system-connections/default`:
```txt
[ipv4]
method=auto
[ipv6]
addr-gen-mode=stable-privacy
method=auto
```
`/etc/network/interfaces`:
```txt
source /etc/network/interfaces.d/*
auto lo
iface lo inet loopback
```
You can also just re-run our
[convenience installation script](https://github.com/home-assistant/supervised-installer).
If you haven't done anything manually with the network on the host, you should just
re-run the convenience installation script.
When you have changed your network configuration manually or with the script,
you should restart the host so the change will be populated to all services that
needs it.

View File

@ -0,0 +1,28 @@
---
title: "Operating System"
description: "More information on why the OS marks the installation as unsupported."
---
## The issue
There are only two supported operating systems to run the Supervisor on:
- Home Assistant OS
- Debian 10 (Buster)
These operating systems are actively tested and maintained, for use with the Supervisor.
## The solution
You need to reinstall the host machine running the Supervisor on one of the supported
operating systems.
The best approach here is to take a full snapshot of your current installation
from the Supervisor panel, then reinstall your host with one of the supported
operating systems.
If the host is a virtual machine or a supported board, you can use our [appliance images](/hassio/installation/).
If not, you can get [Debian from here](https://www.debian.org/) and use our [convenience installation script](https://github.com/home-assistant/supervised-installer). Make sure you make it compliant with [ADR-0014](https://github.com/home-assistant/architecture/blob/master/adr/0014-home-assistant-supervised.md), the convenience script will handle most of that for you.
When the new host is set up and you can reach the Home Assistant frontend, you can upload and restore the snapshot you made earlier.

View File

@ -0,0 +1,17 @@
---
title: "Privileged"
description: "More information on why not running with privileged marks the installation as unsupported."
---
## The issue
The Supervisor needs to have privileged access to the docker runtime on your host
to be able to do everything it needs to do.
## The solution
If you are running an older version of our Home Assistant OS, update it the
supervisor panel.
If this is not our Home Assistant OS, you need to re-run our
[convenience installation script](https://github.com/home-assistant/supervised-installer).

View File

@ -0,0 +1,14 @@
---
title: "Systemd"
description: "More information on why systemd marks the installation as unsupported."
---
## The issue
The Supervisor uses systemd over DBus to control the Host system and get information.
Without systemd, we miss a lot of information and functionality.
## The solution
You need to reinstall the host running the Supervisor with one of the supported
operating systems, [see instructions here](/more-info/unsupported/os).