lib/neutron_thirdparty/README.md
b05c8769
 Neutron third party specific files
0dd34df4
 ==================================
b05c8769
 Some Neutron plugins require third party programs to function.
 The files under the directory, ``lib/neutron_thirdparty/``, will be used
0dd34df4
 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
 ---------
5a9739a4
 ``lib/neutron-legacy`` calls the following functions when the ``<third_party>`` is enabled
0dd34df4
 
 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>``:
2f27a0ed
   start running processes, including screen if USE_SCREEN=True
0dd34df4
   e.g.
2f27a0ed
   run_process XXXX "$XXXX_DIR/bin/XXXX-bin"
0dd34df4
 
 * ``stop_<third_party>``:
   stop running processes (non-screen)
2f27a0ed
   e.g.
   stop_process XXXX
ef1e0802
 
 * ``check_<third_party>``:
   verify that the integration between neutron server and third-party components is sane