Better doc string

mkts_backup
Tyler Goodlet 2022-02-22 15:20:33 -05:00
parent 6e37ab6bf9
commit 4402b2dc73
1 changed files with 9 additions and 0 deletions

View File

@ -298,7 +298,16 @@ async def start_ahab(
task_status: TaskStatus[trio.Event] = trio.TASK_STATUS_IGNORED, task_status: TaskStatus[trio.Event] = trio.TASK_STATUS_IGNORED,
) -> None: ) -> None:
'''
Start a ``docker`` container supervisor with given service name.
Currently the actor calling this task should normally be started
with root permissions (until we decide to use something that doesn't
require this, like docker's rootless mode or some wrapper project) but
te root perms are de-escalated after the docker supervisor sub-actor
is started.
'''
cn_ready = trio.Event() cn_ready = trio.Event()
async with tractor.open_nursery( async with tractor.open_nursery(
loglevel='runtime', loglevel='runtime',