[DOCS] Refactor pip install Docs

This commit refactors the pip_install role docs. Moving forward,
specific project configurations are maintained in the appropriate
role book.

Change-Id: Ic62c7dd8b655a4ef6aa22ca02a599a07996a76f9
This commit is contained in:
Andrew Meserole 2016-08-11 16:35:21 -05:00
parent 3c2dfbcce9
commit a1554a47e3
3 changed files with 41 additions and 33 deletions

View File

@ -1,35 +1,9 @@
=============================
OpenStack-Ansible pip install
#############################
=============================
This role will install pip using the upstream pip installation script. Within
the installation of pip the role will create a .pip directory within the
deploying user's home folder and a blank selfcheck JSON file for pip to use to
keep track of versions.
It can also configure pip links that will restrict the package sources to
the OpenStack-Ansible repository.
Default Variables
=================
.. literalinclude:: ../../defaults/main.yml
:language: yaml
:start-after: under the License.
Required Variables
==================
None
Example Playbook
================
.. code-block:: yaml
- name: Install pip and lock it down
hosts: host_name
user: root
roles:
- role: "pip_install"
pip_lock_to_internal_repo: True
Documentation for the project can be found at:
http://docs.openstack.org/developer/openstack-ansible-pip_install/
The project home is at:
http://launchpad.net/openstack-ansible

View File

@ -1 +1,29 @@
.. include:: ../../README.rst
=============================
OpenStack-Ansible pip install
=============================
This role will install pip using the upstream pip installation script. Within
the installation of pip the role will create a .pip directory within the
deploying user's home folder and a blank selfcheck JSON file for pip to use to
keep track of versions.
It can also configure pip links that will restrict the package sources to
the OpenStack-Ansible repository.
Default variables
~~~~~~~~~~~~~~~~~
.. literalinclude:: ../../defaults/main.yml
:language: yaml
:start-after: under the License.
Required variables
~~~~~~~~~~~~~~~~~~
None
Example playbook
~~~~~~~~~~~~~~~~
.. literalinclude:: ../../examples/playbook.yml
:language: yaml

6
examples/playbook.yml Normal file
View File

@ -0,0 +1,6 @@
- name: Install pip and lock it down
hosts: host_name
user: root
roles:
- role: "pip_install"
pip_lock_to_internal_repo: True