devstack/lib/neutron_thirdparty/README.md
Mark McClain b05c876994 update for name change to Neutron
Note: Nova and Horizon are not updated until those projects have
migrated.

Change-Id: I256ef20e7caadd9c96e6dd908c5d8b69ca5c4aeb
2013-07-07 00:15:11 -04:00

37 lines
1.0 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)