Files
supervisor/supervisor/docker/cli.py
Mike Degatano 1611beccd1 Add job group execution limit option (#4457)
* Add job group execution limit option

* Fix pylint issues

* Assign variable before usage

* Cleanup jobs when done

* Remove isinstance check for performance

* Explicitly raise from None

* Add some more documentation info
2023-08-08 16:49:17 -04:00

67 lines
1.9 KiB
Python

"""HA Cli docker object."""
import logging
from ..coresys import CoreSysAttributes
from ..exceptions import DockerJobError
from ..jobs.const import JobExecutionLimit
from ..jobs.decorator import Job
from .const import ENV_TIME, ENV_TOKEN
from .interface import DockerInterface
_LOGGER: logging.Logger = logging.getLogger(__name__)
CLI_DOCKER_NAME: str = "hassio_cli"
class DockerCli(DockerInterface, CoreSysAttributes):
"""Docker Supervisor wrapper for HA cli."""
@property
def image(self):
"""Return name of HA cli image."""
return self.sys_plugins.cli.image
@property
def name(self) -> str:
"""Return name of Docker container."""
return CLI_DOCKER_NAME
@Job(limit=JobExecutionLimit.GROUP_ONCE, on_condition=DockerJobError)
async def run(self) -> None:
"""Run Docker image."""
if await self.is_running():
return
# Cleanup
await self.stop()
# Create & Run container
docker_container = await self.sys_run_in_executor(
self.sys_docker.run,
self.image,
entrypoint=["/init"],
tag=str(self.sys_plugins.cli.version),
init=False,
ipv4=self.sys_docker.network.cli,
name=self.name,
hostname=self.name.replace("_", "-"),
detach=True,
security_opt=self.security_opt,
extra_hosts={
"supervisor": self.sys_docker.network.supervisor,
"observer": self.sys_docker.network.observer,
},
environment={
ENV_TIME: self.sys_timezone,
ENV_TOKEN: self.sys_plugins.cli.supervisor_token,
},
)
self._meta = docker_container.attrs
_LOGGER.info(
"Starting CLI %s with version %s - %s",
self.image,
self.version,
self.sys_docker.network.cli,
)