Add Portainer integration #142875

erwindouna · 2025-04-13T19:14:46Z

Breaking change

Proposed change

The main goal is to bring in better support for Portainer. Are you just like me who has a separate set of external Docker containers running on which Home Assistant depends? Yet, want a bit more control and monitor options within Home Assistant, then this PR is for you!

This PR will utilize a brand new library/package to support the heavyliftying: https://github.com/erwindouna/pyportainer

Current scope:

Monitor multiple endpoints (hosts, if you will)
Monitor all the containers linked per host (status, stats for performance and monitoring usage, etc.)
Binary sensor platform to keep the PR in line with: new integration? Use one platform.

Documentation: home-assistant/home-assistant.io#39268

Planned scope:

Recreate containers
Buttons to perform actions
Services, so you can automate, however you deem fit
Loads more sensor to be added! The current list of both datasets of Portainer and Docker alike is huge. Up to the community to decide what should be made available.
Whatever nifty features the community can think of. 😉

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New integration (thank you!)
New feature (which adds functionality to an existing integration)
Deprecation (breaking change to happen in the future)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Additional information

This PR fixes or closes issue: fixes #
This PR is related to issue:
Link to documentation pull request:
Link to developer documentation pull request:
Link to frontend pull request:

Checklist

The code change is tested and works locally.
Local tests pass. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist
I have followed the perfect PR recommendations
The code has been formatted using Ruff (ruff format homeassistant tests)
Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

The manifest file has all fields filled out correctly.
Updated and included derived files by running: python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt.
Updated by running python3 -m script.gen_requirements_all.
For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

I have reviewed two other open pull requests in this repository.

homeassistant/components/portainer/__init__.py

homeassistant/components/portainer/config_flow.py

homeassistant/components/portainer/const.py

homeassistant/components/portainer/coordinator.py

tr4nt0r

you should add an icon translation file

homeassistant/components/portainer/binary_sensor.py

homeassistant/components/portainer/__init__.py

tests/components/portainer/test_config_flow.py

tests/components/portainer/test_binary_sensor.py

Co-authored-by: Manu <4445816+tr4nt0r@users.noreply.github.com>