Add README in the devstack folder

This adds a README.rst in the devstack folder with information
about DevStack and how to install Patrole plugin in Devstack.

Change-Id: I31a92351211a2f37403c08406215bc10f3c3222e
This commit is contained in:
Felipe Monteiro 2018-07-18 20:41:10 +01:00
parent e0c5c24e3b
commit f6ffb8b1e0
2 changed files with 26 additions and 7 deletions

25
devstack/README.rst Normal file
View File

@ -0,0 +1,25 @@
====================
Enabling in Devstack
====================
.. warning::
The ``stack.sh`` script must be run in a disposable VM that is not
being created automatically. See the `README file`_ in the DevStack
repository for more information.
1. Download DevStack::
git clone https://git.openstack.org/openstack-dev/devstack.git
cd devstack
2. Patrole can be installed like any other DevStack plugin by including the
``enable_plugin`` directive inside local.conf::
> cat local.conf
[[local|localrc]]
enable_plugin patrole https://git.openstack.org/openstack/patrole
3. Run ``stack.sh`` found in the DevStack repo.
.. _README file: https://github.com/openstack-dev/devstack/blob/master/README.rst

View File

@ -26,10 +26,4 @@ Or to install from the source::
DevStack Installation
=====================
Patrole can be installed like any other DevStack plugin by including the
``install_plugin`` directive inside local.conf::
[[local|localrc]]
...
enable_plugin patrole git://git.openstack.org/openstack/patrole
.. include:: ../../devstack/README.rst