diff --git a/docs/ansible_detailed.rst b/docs/ansible_detailed.rst index c3bbad59..fba7a86a 100644 --- a/docs/ansible_detailed.rst +++ b/docs/ansible_detailed.rst @@ -175,7 +175,8 @@ Noteworthy Differences your_ssh_username = (ALL) NOPASSWD:/usr/bin/python -c* -* The `docker `_, +* The `buildah `_, + `docker `_, `jail `_, `kubectl `_, `local `_, @@ -722,6 +723,19 @@ establishment of additional reuseable interpreters as necessary to match the configuration of each task. +.. _method-buildah: + +Buildah +~~~~~~~ + +Like `buildah +`_ except +connection delegation is supported. + +* ``ansible_host``: Name of Buildah container (default: inventory hostname). +* ``ansible_user``: Name of user within the container to execute as. + + .. _doas: Doas diff --git a/docs/api.rst b/docs/api.rst index 09aa8582..7ab3274e 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -87,6 +87,20 @@ Router Class Connection Methods ================== +.. currentmodule:: mitogen.parent +.. method:: Router.buildah (container=None, buildah_path=None, username=None, \**kwargs) + + Construct a context on the local machine over a ``buildah`` invocation. + Accepts all parameters accepted by :meth:`local`, in addition to: + + :param str container: + The name of the Buildah container to connect to. + :param str doas_path: + Filename or complete path to the ``buildah`` binary. ``PATH`` will be + searched if given as a filename. Defaults to ``buildah``. + :param str username: + Username to use, defaults to unset. + .. currentmodule:: mitogen.parent .. method:: Router.fork (on_fork=None, on_start=None, debug=False, profiling=False, via=None) diff --git a/docs/changelog.rst b/docs/changelog.rst index 77c311c0..8468e7bb 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -52,6 +52,11 @@ Enhancements place to support future removal of the final round-trip between a target fully booting and receiving its first function call. +* `#595 `_: the :meth:`Router.buildah + ` connection method is available to connect + to Buildah containers, and is exposed to Ansible as the ``buildah`` + transport. + * `d6faff06 `_, `807cbef9 `_, `e93762b3 `_, @@ -230,6 +235,7 @@ bug reports, testing, features and fixes in this release contributed by `El Mehdi CHAOUKI `_, `Florent Dutheil `_, `James Hogarth `_, +`Jordan Webb `_, `Marc Hartmayer `_, `Nigel Metheringham `_, `Orion Poplawski `_,