From 341c453eaad05deecc1ab4fe68a052dcaa8c351e Mon Sep 17 00:00:00 2001
From: David Wilson <dw@botanicus.net>
Date: Thu, 15 Aug 2019 02:00:48 +0100
Subject: [PATCH] issue #595: add buildah to docs and changelog.

---
 docs/ansible_detailed.rst | 16 +++++++++++++++-
 docs/api.rst              | 14 ++++++++++++++
 docs/changelog.rst        |  6 ++++++
 3 files changed, 35 insertions(+), 1 deletion(-)

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 <https://docs.ansible.com/ansible/2.6/plugins/connection/docker.html>`_,
+* The `buildah <https://docs.ansible.com/ansible/latest/plugins/connection/buildah.html>`_,
+  `docker <https://docs.ansible.com/ansible/2.6/plugins/connection/docker.html>`_,
   `jail <https://docs.ansible.com/ansible/2.6/plugins/connection/jail.html>`_,
   `kubectl <https://docs.ansible.com/ansible/2.6/plugins/connection/kubectl.html>`_,
   `local <https://docs.ansible.com/ansible/2.6/plugins/connection/local.html>`_,
@@ -722,6 +723,19 @@ establishment of additional reuseable interpreters as necessary to match the
 configuration of each task.
 
 
+.. _method-buildah:
+
+Buildah
+~~~~~~~
+
+Like `buildah
+<https://docs.ansible.com/ansible/2.6/plugins/connection/buildah.html>`_ 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 <https://github.com/dw/mitogen/pull/595>`_: the :meth:`Router.buildah
+   <mitogen.parent.Router.buildah>` connection method is available to connect
+   to Buildah containers, and is exposed to Ansible as the ``buildah``
+   transport.
+
 * `d6faff06 <https://github.com/dw/mitogen/commit/d6faff06>`_,
   `807cbef9 <https://github.com/dw/mitogen/commit/807cbef9>`_,
   `e93762b3 <https://github.com/dw/mitogen/commit/e93762b3>`_,
@@ -230,6 +235,7 @@ bug reports, testing, features and fixes in this release contributed by
 `El Mehdi CHAOUKI <https://github.com/elmchaouki>`_,
 `Florent Dutheil <https://github.com/fdutheil>`_,
 `James Hogarth <https://github.com/hogarthj>`_,
+`Jordan Webb <https://github.com/jordemort>`_,
 `Marc Hartmayer <https://github.com/marc1006>`_,
 `Nigel Metheringham <https://github.com/nigelm>`_,
 `Orion Poplawski <https://github.com/opoplawski>`_,