libra/doc/admin_api/config.rst
Andrew Hutchings b495f628dc DOCS: config and Admin API updates
* Split out config documentation to per-service with a common config doc
* Admin API now resembles reality, updated all the calls
* Customer API now has some internal links

Change-Id: Ie7b57d95b5ecda9f1327b7cb97195f0927a2a877
2013-06-12 17:19:23 +01:00

61 lines
1.3 KiB
ReStructuredText

PI Configuration
=================
These options are specific to the Admin API in addition to the
:doc:`common options </config>`.
Configuration File
------------------
The ``[admin_api]`` section is specific to the libra_admin_api utility.
Below is an example:
.. code-block:: ini
[admin_api]
db_host=localhost
db_user=root
db_pass=
db_schema=lbaas
ssl_certfile=/opt/server.crt
ssl_keyfile=/opt/server.key
Command Line Options
--------------------
.. program:: libra_admin_api
.. option:: --host <IP ADDRESS>
The IP address to bind the frontend to, default is 0.0.0.0
.. option:: --port <PORT NUMBER>
The port number to listen on, default is 8889
.. option:: --db_host <HOSTNAME>
The host name for the MySQL database server
.. option:: --db_user <USERNAME>
The username for the MySQL database server
.. option:: --db_pass <PASSWORD>
The password for the MySQL database server
.. option:: --db_schema <SCHEMA>
The schema containing the LBaaS tables in the MySQL database server
.. option:: --ssl_certfile <PATH>
The path for the SSL certificate file to be used for frontend of the API
server
.. option:: --ssl_keyfile <PATH>
The path for the SSL key file to be used for the frontend of the API
server