Skip to content

Commit e818a42

Browse files
ShrewsAkasurde
andauthored
Clarify automount of SSH dir in docs (#1462)
* Clarify automount of SSH dir in docs Co-authored-by: Abhijeet Kasurde <[email protected]>
1 parent 877b584 commit e818a42

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/execution_environments.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -82,13 +82,13 @@ at a later time (e.g., to stop the container when the job is canceled).
8282
~/.ssh/ symlinks
8383
^^^^^^^^^^^^^^^^
8484

85-
In order to make the ``run`` container execution of Ansible
86-
easier, Ansible Runner will automatically bind mount your local ssh agent
87-
UNIX-domain socket (``SSH_AUTH_SOCK``) into the container runtime. However, this
88-
does not work if files in your ``~/.ssh/`` directory happen to be symlinked to
89-
another directory that is also not mounted into the container runtime. The Ansible
90-
Runner ``run`` subcommand provides the ``--container-volume-mount``
91-
option to address this, among other things.
85+
When using the ``run_command()`` Python API method, Ansible Runner will automatically
86+
bind mount your local SSH agent UNIX-domain socket (``SSH_AUTH_SOCK``) into the container runtime.
87+
However, this does not work if files in your ``~/.ssh/`` directory happen to be symlinked to
88+
another directory that is also not mounted into the container runtime.
89+
To address this, or to manually mount your SSH directory, you may utilize the ``--container-volume-mount``
90+
CLI option, or the ``container_volume_mounts`` API parameter for the ``run_command()``, ``run()``, or ``run_async()``
91+
API methods.
9292

9393
Here is an example of an ssh config file that is a symlink:
9494

0 commit comments

Comments
 (0)