core: Custom integrations with requirements fail to start with 2022.7.X

Installation method is in a Kubernetes pod/container using the ghcr.io/home-assistant/home-assistant:2022.7.1 image. There’s no custom configuration or similar around that - I take the container and run it without a mount to my configuration directory /config.

Custom integrations in use are hella_onyx, version 3.0.0, and deebot, version 1.4.1. Both fail with the same error, and worked with 2022.6.X. I added the gardena integration (version 0.2.3) which fails with above posted error.

I see this line when starting home assistant which shows all enabled integrations, i believe:

2022-07-08 09:33:57 INFO (MainThread) [homeassistant.bootstrap] Setting up stage 2: {'mobile_app', 'automation', 'met', 'input_select', 'shell_command', 'prometheus', 'discovery', 'sun', 'sensor', 'input_text', 'tag', 'template', 'hella_onyx', 'history', 'logbook', 'energy', 'tts', 'webhook', 'influxdb', 'switch', 'input_number', 'fronius', 'blueprint', 'adguard', 'ring', 'timer', 'zone', 'scene', 'input_boolean', 'input_datetime', 'denonavr', 'my', 'ffmpeg', 'mqtt', 'heos', 'trace', 'nuki', 'counter', 'broadlink', 'device_tracker', 'forecast_solar', 'apple_tv', 'deebot', 'filesize', 'zwave_js', 'system_health', 'group', 'script', 'ipp'}

The deps directory in /config only contained Python 3.9 packages as 3.10 ones are now installed to /usr/local/lib/python3.10/site-packages now.

When enabling debug logging, I get this command to install the pip dependencies:

2022-07-08 08:53:59 DEBUG (SyncWorker_0) [homeassistant.util.package] Running pip command:
args=['/usr/local/bin/python3',
'-m', 'pip', 'install', '--quiet', 'deebot-client==1.5.1',
'--timeout', '60', '--upgrade',
'--constraint', '/usr/src/homeassistant/homeassistant/package_constraints.txt',
'--find-links', 'https://wheels.home-assistant.io/musllinux/',
'--prefer-binary', '--user', '--prefix=']

For reference, a simplified version (remove annotations, labels, …) of the Kubernetes Deployment is:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: home-assistant
  namespace: home-assistant
spec:
  replicas: 1
  template:
    spec:
      containers:
      - env:
        - name: TZ
          value: UTC
        image: ghcr.io/home-assistant/home-assistant:2022.7.1
        imagePullPolicy: IfNotPresent
        name: home-assistant
        ports:
        - containerPort: 8123
          name: http
          protocol: TCP
        volumeMounts:
        - mountPath: /config
          name: config
      serviceAccount: home-assistant-home-assistant
      serviceAccountName: home-assistant-home-assistant
      terminationGracePeriodSeconds: 30
      volumes:
      - name: config
        persistentVolumeClaim:
          claimName: home-assistant-config

However, others in #74597 use podman or similar container orchestrators as well.

Yay for building a custom non-root home-assistant image?

This project does not support that and thus is not something we consider.

Thanks, @muhlba91 for the reproduction that is helpful. 👍

It’s the --prefix= on the end that breaks it. Run that pip without that, but with PYTHONUSERBASE=/config/deps set, and the deps get installed correctly.

@bootc Yes, that is related probably. The prefix needs to be either removed now, or, replaced by --install-option="--prefix=".

For this use case in this issue, removal should do. But it is in place folder an “older” issue with some distro. So removing it might affect users running Core on such distros.

I lean towards the latter one in that case, but not 100% sure if that works at this point (needs to be tested).

Edit to add a thought: Also, this behavior might be needed to be split more. As we might need a different behavior on Home Assistant Operating System & Supervised installs compared to the container version (They both use the same Docker image).

Awesome, thanks for the fix!

Yes, sure. That’s why I asked if support is needed here as I wasn’t aware if you looked into it already and whether just removing it is safe due to the older issue mentioned.

what‘s the current plan/idea to get this fixed?

A fix was just merged. In general, this is an open source project. Plans are made by contributions.

That’s mighty decisive and fast for something as important as a non-root container. Care to add some arguments or do you just like repeating yourself in all issues?

I don’t think this is the place to defend or argument that. These are design decisions and limitations this project has made and documented. If you want more context, you can check out the architecture repository and the documented ADRs in that repo.

Seeing the thumbs down is OK. You don’t have to agree. I’m not saying I agree or disagree either. It’s a decision for this project on what it supports and what not.

You are free to run Home Assistant any way you like, however, unsupported/out of scope setups are in the projects scope right now.

But this a discussion for another place and time.

Agree non of that is for this issue report.

Yay for building a custom non-root home-assistant image?

This project does not support that and thus is not something we consider.

Yes, I know. Maybe one day ™ Docker and containers in general should give you enough controls with with Container capabilities to have what you need without going full-root. But this a discussion for another place and time.

Same here with containerd as runtime.

Using official docker image:

2022-07-09 14:55:43 ERROR (MainThread) [homeassistant.components.media_player] Error while setting up braviatv_psk platform for media_player
Traceback (most recent call last):
  File "/usr/src/homeassistant/homeassistant/helpers/entity_platform.py", line 250, in _async_setup_platform
    await asyncio.shield(task)
  File "/config/custom_components/braviatv_psk/media_player.py", line 221, in async_setup_platform
    device = await hass.async_add_executor_job(
  File "/usr/local/lib/python3.10/concurrent/futures/thread.py", line 58, in run
    result = self.fn(*self.args, **self.kwargs)
  File "/config/custom_components/braviatv_psk/media_player.py", line 296, in __init__
    from braviapsk import sony_bravia_psk
ModuleNotFoundError: No module named 'braviapsk'
2022-07-09 14:55:46 ERROR (MainThread) [homeassistant.components.camera] The mjpeg platform for the camera integration does not support platform setup. Please remove it from your config.
2022-07-09 14:56:07 ERROR (MainThread) [homeassistant.setup] Setup failed for custom integration landroid_cloud: Unable to import component: No module named 'pyworxcloud'

Testing with linuxservers image:

2022-07-09 14:42:21 ERROR (SyncWorker_2) [homeassistant.util.package] Unable to install package pyworxcloud==2.1.10: ERROR: Could not install packages due to an OSError: [Errno 13] Permission denied: '/lib/python3.10'
Check the permissions.

WARNING: You are using pip version 22.0.4; however, version 22.1.2 is available.
You should consider upgrading via the '/usr/bin/python3 -m pip install --upgrade pip' command.

2022-07-09 14:43:28 ERROR (MainThread) [homeassistant.setup] Setup failed for custom integration landroid_cloud: Requirements for landroid_cloud not found: ['pyworxcloud==2.1.10'].

2022-07-09 14:44:03 ERROR (SyncWorker_1) [homeassistant.util.package] Unable to install package pySonyBraviaPSK==0.2.4: ERROR: Could not install packages due to an OSError: [Errno 13] Permission denied: '/lib/python3.10'
Check the permissions.

WARNING: You are using pip version 22.0.4; however, version 22.1.2 is available.
You should consider upgrading via the '/usr/bin/python3 -m pip install --upgrade pip' command.

2022-07-09 14:44:37 ERROR (SyncWorker_1) [homeassistant.util.package] Unable to install package pySonyBraviaPSK==0.2.4: ERROR: Could not install packages due to an OSError: [Errno 13] Permission denied: '/lib/python3.10'
Check the permissions.

WARNING: You are using pip version 22.0.4; however, version 22.1.2 is available.
You should consider upgrading via the '/usr/bin/python3 -m pip install --upgrade pip' command.

2022-07-09 14:45:13 ERROR (MainThread) [homeassistant.config] Platform error: media_player - Requirements for braviatv_psk not found: ['pySonyBraviaPSK==0.2.4'].

2022-07-09 15:03:32 INFO (SyncWorker_5) [homeassistant.util.package] Attempting install of pySonyBraviaPSK==0.2.4
2022-07-09 15:03:32 DEBUG (SyncWorker_5) [homeassistant.util.package] Running pip command: args=['/usr/local/bin/python3', '-m', 'pip', 'install', '--quiet', 'pySonyBraviaPSK==0.2.4', '--timeout', '60', '--upgrade', '--constraint', '/usr/src/homeassistant/homeassistant/package_constraints.txt', '--find-links', 'https://wheels.home-assistant.io/musllinux/', '--prefer-binary', '--user', '--prefix=']