Merge "Updated the testing doc" into stable/fraser
[doctor.git] / devstack / README.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. (c) 2017 OPNFV.
4
5 ====================================
6 Enabling OPNFV Doctor using DevStack
7 ====================================
8
9 This directory contains the files necessary to run OpenStack with enabled
10 OPNFV Doctor in DevStack.
11
12 1. To configure DevStack to enable OPNFV Doctor edit
13 ``${DEVSTACK_DIR}/local.conf`` file and add::
14
15     enable_plugin aodh http://git.openstack.org/openstack/aodh
16     enable_plugin panko https://git.openstack.org/openstack/panko
17     enable_plugin ceilometer https://git.openstack.org/openstack/ceilometer
18     enable_plugin osprofiler https://git.openstack.org/openstack/osprofiler
19     enable_plugin doctor https://git.opnfv.org/doctor
20
21 to the ``[[local|localrc]]`` section.
22
23 .. note:: The order of enabling plugins matters.
24
25 2. To enable Python 3 in DevStack, please add::
26
27    USE_PYTHON3=True
28
29 3. To enable Congress as Doctor Inspector, please add::
30
31    enable_plugin congress https://git.openstack.org/openstack/congress
32
33 4. To enable Neutron port data plane status, please also add::
34
35    Q_ML2_PLUGIN_EXT_DRIVERS=data_plane_status
36
37 5. Run DevStack as normal::
38
39     $ ./stack.sh