openstack-manuals/doc/common/tables/neutron-lbaas.xml

<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
  <!-- Warning: Do not edit this file. It is automatically
     generated and your changes will be overwritten.
     The tool to do so lives in openstack-doc-tools repository. -->
  <table rules="all" xml:id="config_table_neutron_lbaas">
    <caption>Description of Load-Balancer-as-a-Service configuration options</caption>
    <col width="50%"/>
    <col width="50%"/>
    <thead>
      <tr>
        <th>Configuration option = Default value</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <th colspan="2">[DEFAULT]</th>
      </tr>
      <tr>
        <td><option>interface_driver</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) The driver used to manage the virtual interface.</td>
      </tr>
      <tr>
        <td><option>loadbalancer_pool_scheduler_driver</option> = <replaceable>neutron_lbaas.services.loadbalancer.agent_scheduler.ChanceScheduler</replaceable></td>
        <td>(StrOpt) Driver to use for scheduling pool to a default loadbalancer agent</td>
      </tr>
      <tr>
        <td><option>loadbalancer_scheduler_driver</option> = <replaceable>neutron_lbaas.agent_scheduler.ChanceScheduler</replaceable></td>
        <td>(StrOpt) Driver to use for scheduling to a default loadbalancer agent</td>
      </tr>
      <tr>
        <td><option>periodic_interval</option> = <replaceable>40</replaceable></td>
        <td>(IntOpt) Seconds between running periodic tasks</td>
      </tr>
      <tr>
        <td><option>loadbalancer_scheduler_driver</option> = <replaceable>neutron_lbaas.agent_scheduler.ChanceScheduler</replaceable></td>
        <td>(StrOpt) Driver to use for scheduling to a default loadbalancer agent</td>
      </tr>
      <tr>
        <td><option>loadbalancer_pool_scheduler_driver</option> = <replaceable>neutron_lbaas.services.loadbalancer.agent_scheduler.ChanceScheduler</replaceable></td>
        <td>(StrOpt) Driver to use for scheduling pool to a default loadbalancer agent</td>
      </tr>
      <tr>
        <th colspan="2">[service_auth]</th>
      </tr>
      <tr>
        <td><option>auth_url</option> = <replaceable>http://127.0.0.1:5000/v2.0</replaceable></td>
        <td>(StrOpt) Authentication endpoint</td>
      </tr>
      <tr>
        <td><option>admin_tenant_name</option> = <replaceable>admin</replaceable></td>
        <td>(StrOpt) The service admin tenant name</td>
      </tr>
      <tr>
        <td><option>admin_user</option> = <replaceable>admin</replaceable></td>
        <td>(StrOpt) The service admin user name</td>
      </tr>
      <tr>
        <td><option>admin_password</option> = <replaceable>password</replaceable></td>
        <td>(StrOpt) The service admin password</td>
      </tr>
      <tr>
        <td><option>admin_user_domain</option> = <replaceable>admin</replaceable></td>
        <td>(StrOpt) The admin user domain name</td>
      </tr>
      <tr>
        <td><option>admin_project_domain</option> = <replaceable>admin</replaceable></td>
        <td>(StrOpt) The admin project domain name</td>
      </tr>
      <tr>
        <td><option>region</option> = <replaceable>RegionOne</replaceable></td>
        <td>(StrOpt) The deployment region</td>
      </tr>
      <tr>
        <td><option>service_name</option> = <replaceable>lbaas</replaceable></td>
        <td>(StrOpt) The name of the service</td>
      </tr>
      <tr>
        <td><option>auth_version</option> = <replaceable>2</replaceable></td>
        <td>(StrOpt) The auth version used to authenticate</td>
      </tr>
      <tr>
        <th colspan="2">[service_providers]</th>
      </tr>
      <tr>
        <td><option>service_provider</option> = <replaceable>[]</replaceable></td>
        <td>(MultiStrOpt) Defines providers for advanced services using the format: &lt;service_type&gt;:&lt;name&gt;:&lt;driver&gt;[:default]</td>
      </tr>
      <tr>
        <th colspan="2">[certificates]</th>
      </tr>
      <tr>
        <td><option>cert_manager_type</option> = <replaceable>barbican</replaceable></td>
        <td>(StrOpt) Certificate Manager plugin. Defaults to barbican.</td>
      </tr>
      <tr>
        <td><option>storage_path</option> = <replaceable>/var/lib/neutron-lbaas/certificates/</replaceable></td>
        <td>(StrOpt) Absolute path to the certificate storage directory. Defaults to env[OS_LBAAS_TLS_STORAGE].</td>
      </tr>
      <tr>
        <th colspan="2">[service_auth]</th>
      </tr>
      <tr>
        <td><option>admin_password</option> = <replaceable>password</replaceable></td>
        <td>(StrOpt) The service admin password</td>
      </tr>
      <tr>
        <td><option>admin_project_domain</option> = <replaceable>admin</replaceable></td>
        <td>(StrOpt) The admin project domain name</td>
      </tr>
      <tr>
        <td><option>admin_tenant_name</option> = <replaceable>admin</replaceable></td>
        <td>(StrOpt) The service admin tenant name</td>
      </tr>
      <tr>
        <td><option>admin_user</option> = <replaceable>admin</replaceable></td>
        <td>(StrOpt) The service admin user name</td>
      </tr>
      <tr>
        <td><option>admin_user_domain</option> = <replaceable>admin</replaceable></td>
        <td>(StrOpt) The admin user domain name</td>
      </tr>
      <tr>
        <td><option>auth_url</option> = <replaceable>http://127.0.0.1:5000/v2.0</replaceable></td>
        <td>(StrOpt) Authentication endpoint</td>
      </tr>
      <tr>
        <td><option>auth_version</option> = <replaceable>2</replaceable></td>
        <td>(StrOpt) The auth version used to authenticate</td>
      </tr>
      <tr>
        <td><option>region</option> = <replaceable>RegionOne</replaceable></td>
        <td>(StrOpt) The deployment region</td>
      </tr>
      <tr>
        <td><option>service_name</option> = <replaceable>lbaas</replaceable></td>
        <td>(StrOpt) The name of the service</td>
      </tr>
    </tbody>
  </table>
</para>