libra/doc/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

2.4 KiB

API Configuration

These options are specific to the API in addition to the common options </config>.

Configuration File

The [api] section is specific to the libra_api utility. Below is an example:

[api]
db_host=localhost
db_user=root
db_pass=
db_schema=lbaas
gearman=127.0.0.1:4730
keystone_module=keystoneclient.middleware.auth_token:AuthProtocol
swift_basepath=lbaaslogs
swift_endpoint=https://host.com:443/v1/
ssl_certfile=/opt/certfile.crt
ssl_keyfile=/opt/keyfile.key

In addition to this any options that are specific to the given keystone module should be stored in the [keystone] section.

Command Line Options

libra_api

--host <IP ADDRESS>

The IP address to bind the frontend to, default is 0.0.0.0

--port <PORT NUMBER>

The port number to listen on, default is 443

--disable_keystone

Do not use keystone authentication, for testing purposes only

--db_host <HOSTNAME>

The host name for the MySQL database server

--db_user <USERNAME>

The username for the MySQL database server

--db_pass <PASSWORD>

The password for the MySQL database server

--db_schema <SCHEMA>

The schema containing the LBaaS tables in the MySQL database server

--gearman <HOST:POST>

Used to specify the Gearman job server hostname and port. This option can be used multiple times to specify multiple job servers.

--keystone_module <MODULE:CLASS>

A colon separated module and class to use as the keystone authentication module. The class should be compatible with keystone's AuthProtocol class.

--swift_basepath <CONTAINER>

The default container to be used for customer log uploads.

--swift_endpoint <URL>

The default endpoint for swift. The user's tenant ID will automatically be appended to this unless overridden at the log archive request.

--ssl_certfile <PATH>

The path for the SSL certificate file to be used for frontend of the API server

--ssl_keyfile <PATH>

The path for the SSL key file to be used for the frontend of the API server