openstack-ansible-ops/bootstrap-embedded-ansible/README.rst
Kevin Carter 7491b6df8e Update the embedded-ansible-setup process to be configurable
This change allows the embedded ansible process to be configurable by
the end user.
  * Python requirements and ansible roles will all now be user
    configurable.
  * Setup is now a local only playbook. This playbook replaces the bash
    commands we were rerunning when the `bootstrap-embedded-ansible.sh`
    script was executed.
  * Embedded ansible version is now 2.7.5 as default.
  * Deprecation warnings have been resolved.
  * Tests impacted by this change have been updated.

Change-Id: I4303c44e249cda31457a4f05a681e298d225a8b7
Signed-off-by: Kevin Carter <kevin.carter@rackspace.com>
2019-01-04 11:46:19 -06:00

44 lines
1.2 KiB
ReStructuredText

Create an embedded Ansible runtime
##################################
:tags: embedded, ansible
About this repository
---------------------
The embedded ansible script will create an ansible runtime within the users home folder.
This ansible runtime will be within a virtual envrionment and have all of the plugins
required to run ansible standalone or in an OpenStack-Ansible compatible envrionment.
Usage
^^^^^
.. code-block:: bash
source bootstrap-embedded-ansible.sh
With the script sourced, the ansible environment will create a virtual environment at
`${HOME}/ansible_venv` if it does not already exist.
To leave the embedded ansible environment run the function `deactivate`.
Options
^^^^^^^
All options are passed in using environment variables.
ANSIBLE_VERSION:
Allows for the Ansible XXX to be overridden. When set the full ansible version is required.
ANSIBLE_EMBED_HOME:
Allows for the Ansible XXX to be overridden. When set the full path is required.
ANSIBLE_ROLE_REQUIREMENTS:
Allows for the Ansible XXX to be overridden. When set the full path to the role requirements file is required.
ANSIBLE_PYTHON_REQUIREMENTS:
Allows for the Ansible XXX to be overridden. When set the full path to the python requirements file is required.