devstack/lib/neutron_thirdparty/README.md
armando-migliaccio ef1e08022b Add sanity check framework to verify neutron server/backend integration
Some Neutron plugins require controllers and multiple backend services
to operate correctly. This patch adds the framework for third party
plugins to run sanity checks after Neutron Server has started.

This simple addition may reveal potential configuration pitfalls
much earlier in the dev/test cycle, thus speeding up the build
churn process.

The first plugin that uses this framework is the VMware NSX one.

Closes-bug: #1265671

Change-Id: I17f9c5c8e828316ff03f0eff42ae4ae6c6c58733
2014-01-14 08:14:25 -08:00

40 lines
1.1 KiB
Markdown

Neutron third party specific files
==================================
Some Neutron plugins require third party programs to function.
The files under the directory, ``lib/neutron_thirdparty/``, will be used
when their service are enabled.
Third party program specific configuration variables should be in this file.
* filename: ``<third_party>``
* The corresponding file name should be same to service name, ``<third_party>``.
functions
---------
``lib/neutron`` calls the following functions when the ``<third_party>`` is enabled
functions to be implemented
* ``configure_<third_party>``:
set config files, create data dirs, etc
e.g.
sudo python setup.py deploy
iniset $XXXX_CONF...
* ``init_<third_party>``:
initialize databases, etc
* ``install_<third_party>``:
collect source and prepare
e.g.
git clone xxx
* ``start_<third_party>``:
start running processes, including screen
e.g.
screen_it XXXX "cd $XXXXY_DIR && $XXXX_DIR/bin/XXXX-bin"
* ``stop_<third_party>``:
stop running processes (non-screen)
* ``check_<third_party>``:
verify that the integration between neutron server and third-party components is sane