Skip to content

Commit

Permalink
Fix some typos on documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
beeankha committed Oct 2, 2020
1 parent 49d4c9b commit 3ecef66
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions docs/execution_environments.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
Using Runner with Execution Environmnets
========================================

**Execution Environments** are meant to be a consistent, reproducable, portable,
**Execution Environments** are meant to be a consistent, reproducible, portable,
and sharable method to run Ansible Automation jobs in the exact same way on
your laptop as they are executed in `Ansible AWX <https://github.com/ansible/awx/`_.
your laptop as they are executed in `Ansible AWX <https://github.com/ansible/awx/`_.
This aids in the development of automation jobs and Ansible Content that is
meant to be run in **Ansible AWX**, `Ansible Tower <https://www.ansible.com/products/tower>`_,
or via `Red Hat Ansible Automation Platform <https://www.ansible.com/products/automation-platform>`_
Expand Down Expand Up @@ -35,7 +35,7 @@ As previously mentioned, a primary goal of adding the Execution Environment CLI
interface is to aid in the creation of Ansible Automation jobs and content. The
approach here is to make it as similar as possible to the way **Ansible** users
are accustomed to using Ansible today. There are two subcommands, ``adhoc`` and
``playbook`` that have been added to accomodate this. The ``adhoc`` subcommand
``playbook`` that have been added to accommodate this. The ``adhoc`` subcommand
to ``ansible-runner`` is synonymous with ``ansible`` and the ``playbook``
subcommand to ``ansible-runner`` is synonymous with ``ansible-playbook``.
Examples are below.
Expand All @@ -45,9 +45,9 @@ Running Ansible adhoc

An example invocation using the ``ping`` module and ``localhost`` as target::

$ ansible-runner adhoc localhost -m ping
$ ansible-runner adhoc localhost -m ping

Something to note here is that implicit ``localhost`` in this context is a containerized instantiation of an Ansible Execution Environment and as such you will not get Ansible Facts about your system if using the ``setup`` module.
Something to note here is that implicit ``localhost`` in this context is a containerized instantiation of an Ansible Execution Environment and as such you will not get Ansible Facts about your system if using the ``setup`` module.

Running Ansible ansible-playbook
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -58,18 +58,18 @@ An example invocation using the ``demo.yml`` playbook and ``inventory.ini`` inve

Something to note here is that implicit ``localhost`` in this context is a containerized instantiation of an Ansible Execution Environment and as such you will not get Ansible Facts about your system if using ``gather_facts: true`` and targeting ``localhost`` in your playbook without explicit host definition in your inventory.

Notes an Considerations
-----------------------
Notes and Considerations
------------------------

There are some differences between running Ansible directly from the command
that have to do with configuration, content locality, and secret data.
There are some differences between using Ansible Runner and running Ansible directly from the
command line that have to do with configuration, content locality, and secret data.

Secrets
^^^^^^^

Typically with Ansible you are able to provide secret data via a series of
machanisms, many of which are pluggable and configurable. However when using
Ansible Runner certain considerations need to be made, these are analogous to
mechanisms, many of which are pluggable and configurable. When using
Ansible Runner, however, certain considerations need to be made; these are analogous to
how Ansible AWX and Tower manage this information.

See :ref:`inputdir` for more information
Expand All @@ -82,23 +82,23 @@ which is also the name of the artifacts subfolder where results are saved to.
When a container for job isolation is launched, it will be given a name
of ``ansible_runner_<job identifier>``. Some characters from the job
identifier may be replaced with underscores for compatibility with
names that podman and docker allow.
names that Podman and Docker allow.

This name is used internally if a command needs to be ran against the container
at a later time, for instance, to stop the container when the job is canceled.
at a later time (e.g., to stop the container when the job is canceled).

~/.ssh/ symlinks
^^^^^^^^^^^^^^^^

In order to make the ``adhoc`` and ``playbook`` container execution of Ansible
easier, Ansible Runner will automatically bind mount your local ssh agent
easier, Ansible Runner will automatically bind mount your local ssh agent
UNIX-domain socket (``SSH_AUTH_SOCK``) into the container runtime. However, this
does not work if files in your ``~/.ssh/`` directory happen to be symlink'd to
does not work if files in your ``~/.ssh/`` directory happen to be symlinked to
another directory that is also not mounted into the container runtime. Ansible
Runner ``adhoc`` and ``playbook`` subcommands provide the ``--container-volume-mount``
option to address this, among other things.

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

::

Expand Down

0 comments on commit 3ecef66

Please sign in to comment.