Include ansible-role-ara's README in the docs

We don't have proper documentation for the role other than the README
right now, let's at least use that.

Change-Id: I27bd0dccce2ffb61c4d6d0adb3e400836141af3c
This commit is contained in:
David Moreau Simard 2019-03-06 17:39:52 -05:00
parent b0858abde1
commit 63d0120ae2
No known key found for this signature in database
GPG Key ID: CBEB466764A9E621
4 changed files with 22 additions and 6 deletions

View File

@ -0,0 +1 @@
.. include:: ../../roles/ara/README.rst

View File

@ -13,3 +13,8 @@ Table of Contents
API authentication and security <api-security> API authentication and security <api-security>
API usage with built-in clients <api-usage> API usage with built-in clients <api-usage>
Architecture and workflows <architecture> Architecture and workflows <architecture>
.. toctree::
:maxdepth: 1
ansible-role-ara <ansible-role-ara>

View File

@ -3,6 +3,9 @@
Installing ARA Installing ARA
============== ==============
Manually with pip
-----------------
ARA should work on any Linux distributions as long as python3 is available. ARA should work on any Linux distributions as long as python3 is available.
It is recommended to use a python `virtual environment <https://docs.python.org/3/tutorial/venv.html>`_ It is recommended to use a python `virtual environment <https://docs.python.org/3/tutorial/venv.html>`_
@ -13,3 +16,10 @@ in order to avoid conflicts with your Linux distribution python packages::
# Install ARA 1.0 from source # Install ARA 1.0 from source
~/.ara/venv/bin/pip install git+https://git.openstack.org/openstack/ara@feature/1.0 ~/.ara/venv/bin/pip install git+https://git.openstack.org/openstack/ara@feature/1.0
Using ansible-role-ara
----------------------
An Ansible role is available to install and configure ARA.
For more details, refer to the role documentation: :ref:`ansible-role-ara`.

View File

@ -8,12 +8,12 @@ deployment topologies.
It is currently tested and supported against Ubuntu 18.04 and Fedora 29. It is currently tested and supported against Ubuntu 18.04 and Fedora 29.
Role Variables Role Variables
============== --------------
See ``defaults/main.yaml``. See `defaults/main.yaml <https://github.com/openstack/ara/blob/feature/1.0/roles/ara/defaults/main.yaml>`_.
TL;DR TL;DR
===== -----
Playbook that runs the role with defaults:: Playbook that runs the role with defaults::
@ -39,7 +39,7 @@ What the role ends up doing by default:
- Collects static files (``ara-manage collectstatic``) into ``~/.ara/www`` - Collects static files (``ara-manage collectstatic``) into ``~/.ara/www``
About deployment topologies About deployment topologies
=========================== ---------------------------
This Ansible role is designed to support different opinionated topologies that This Ansible role is designed to support different opinionated topologies that
can be selected with role variables. can be selected with role variables.
@ -62,7 +62,7 @@ with apache, mod_wsgi and postgresql.
Or any combination of any of those. Or any combination of any of those.
Example playbooks Example playbooks
================= -----------------
Install ARA and set up the API to be served by a persistent gunicorn service:: Install ARA and set up the API to be served by a persistent gunicorn service::
@ -96,7 +96,7 @@ Install ARA and set up the API to be served by nginx in front of gunicorn::
- ara - ara
Copyright Copyright
========= ---------
:: ::