Add local.conf.sample for devstack deployment of Doctor

[doctor.git] / devstack / README.rst

diff --git a/devstack/README.rst b/devstack/README.rst
index cd836f1..aaa18a7 100644 (file)
--- a/devstack/README.rst
+++ b/devstack/README.rst
@@ -9,7 +9,7 @@ Enabling OPNFV Doctor using DevStack
 This directory contains the files necessary to run OpenStack with enabled
 OPNFV Doctor in DevStack.
 
 This directory contains the files necessary to run OpenStack with enabled
 OPNFV Doctor in DevStack.
 

-To configure DevStack to enable OPNFV Doctor edit
+1. To configure DevStack to enable OPNFV Doctor edit

 ``${DEVSTACK_DIR}/local.conf`` file and add::
 
     enable_plugin aodh http://git.openstack.org/openstack/aodh
 ``${DEVSTACK_DIR}/local.conf`` file and add::
 
     enable_plugin aodh http://git.openstack.org/openstack/aodh


@@ -18,10 +18,24 @@ To configure DevStack to enable OPNFV Doctor edit
     enable_plugin osprofiler https://git.openstack.org/openstack/osprofiler
     enable_plugin doctor https://git.opnfv.org/doctor
 
     enable_plugin osprofiler https://git.openstack.org/openstack/osprofiler
     enable_plugin doctor https://git.opnfv.org/doctor
 

-to the ``[[local|localrc]]`` section.
+to the ``[[local|localrc]]`` section. Or, you can copy the local.conf.sample::
+
+    cp /<path-to-doctor>/devstack/local.conf.sample ${DEVSTACK_DIR}/local.conf

 
 .. note:: The order of enabling plugins matters.
 
 
 .. note:: The order of enabling plugins matters.
 

-Run DevStack as normal::
+2. To enable Python 3 in DevStack, please add::
+
+   USE_PYTHON3=True
+
+3. To enable Congress as Doctor Inspector, please add::
+
+   enable_plugin congress https://git.openstack.org/openstack/congress
+
+4. To enable Neutron port data plane status, please also add::
+
+   Q_ML2_PLUGIN_EXT_DRIVERS=data_plane_status
+
+5. Run DevStack as normal::

 
     $ ./stack.sh
 
     $ ./stack.sh