openstack/openstack-manuals
Code Issues Proposed changes

Merge "Update the content for neutron-lbaas"

Browse Source
This commit is contained in:
Jenkins 2015-10-11 13:01:45 +00:00 committed by Gerrit Code Review
commit fb0da0d31f
9 changed files with 862 additions and 313 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
doc/common/tables/neutron-lbaas.xml
View File

@ -25,6 +25,94 @@
<td><option>loadbalancer_scheduler_driver</option> = <replaceable>neutron_lbaas.agent_scheduler.ChanceScheduler</replaceable></td> <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> <td>(StrOpt) Driver to use for scheduling to a default loadbalancer agent</td>
</tr> </tr>
<tr>
<th colspan="2">[quotas]</th>
</tr>
<tr>
<td><option>quota_vip</option> = <replaceable>10</replaceable></td>
<td>(StrOpt) Number of vips allowed per tenant.A negative value means unlimited.</td>
</tr>
<tr>
<td><option>quota_pool</option> = <replaceable>10</replaceable></td>
<td>(StrOpt) Number of pools allowed per tenant.A negative value means unlimited.</td>
</tr>
<tr>
<td><option>quota_member</option> = <replaceable>-1</replaceable></td>
<td>(StrOpt) Number of pool members allowed per tenant. A negative value means unlimited.</td>
</tr>
<tr>
<td><option>quota_health_monitor</option> = <replaceable>-1</replaceable></td>
<td>(StrOpt) Number of health monitors allowed per tenant. A negative value means unlimited.</td>
</tr>
<tr>
<td><option>quota_loadbalancer</option> = <replaceable>10</replaceable></td>
<td>(StrOpt) Number of loadbalancers allowed per tenant. A negative value means unlimited.</td>
</tr>
<tr>
<td><option>quota_listener</option> = <replaceable>-1</replaceable></td>
<td>(StrOpt) Number of listeners allowed per tenant. A negative value means unlimited.</td>
</tr>
<tr>
<td><option>quota_healthmonitor</option> = <replaceable>-1</replaceable></td>
<td>(StrOpt) Number of v2 health monitors allowed per tenant. A negative value means unlimited.</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) An auth_url that points to the root of a V2 identity server.</td>
</tr>
<tr>
<td><option>admin_tenant_name</option> = <replaceable>%SERVICE_TENANT_NAME%</replaceable></td>
<td>(StrOpt) Service tenant name.</td>
</tr>
<tr>
<td><option>admin_user</option> = <replaceable>%SERVICE_USER%</replaceable></td>
<td>(StrOpt) Service user.</td>
</tr>
<tr>
<td><option>admin_password</option> = <replaceable>%SERVICE_PASSWORD%</replaceable></td>
<td>(StrOpt) Service password.</td>
</tr>
<tr>
<td><option>admin_user_domain</option> = <replaceable>%SERVICE_USER_DOMAIN%</replaceable></td>
<td>(StrOpt) Service User Domain.</td>
</tr>
<tr>
<td><option>admin_project_domain</option> = <replaceable>%SERVICE_PROJECT_DOMAIN%</replaceable></td>
<td>(StrOpt) Service Project Domain.</td>
</tr>
<tr>
<td><option>region</option> = <replaceable>%REGION%</replaceable></td>
<td>(StrOpt) 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 version of service authorization.</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 of the certificate storage directory. Defaults to /var/lib/magnum/certificates/.</td>
</tr>
</tbody> </tbody>
</table> </table>
</para> </para>

37
doc/common/tables/neutron-lbaas_haproxy.xml → doc/common/tables/neutron-lbaas_agent.xml
View File

@ -3,8 +3,8 @@
<!-- Warning: Do not edit this file. It is automatically <!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten. generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. --> The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_neutron_lbaas_haproxy"> <table rules="all" xml:id="config_table_neutron_lbaas_agent">
<caption>Description of LBaaS HAProxy plugin configuration options</caption> <caption>Description of LBaaS agent configuration options</caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
<thead> <thead>
@ -15,24 +15,35 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<th colspan="2">[haproxy]</th> <th colspan="2">[DEFAULT]</th>
</tr> </tr>
<tr> <tr>
<td><option>interface_driver</option> = <replaceable>None</replaceable></td> <td><option>debug</option> = <replaceable>False</replaceable></td>
<td>(StrOpt) The driver used to manage the virtual interface.</td> <td>(StrOpt) Show debugging output in log (sets DEBUG log level output)..</td>
</tr>
<tr>
<td><option>jinja_config_template</option> = <replaceable>/home/gpocentek/Workspace/OpenStack/openstack-doc-tools/autogenerate_config_docs/sources/neutron-lbaas/neutron_lbaas/services/loadbalancer/drivers/haproxy/templates/haproxy.loadbalancer.j2</replaceable></td>
<td>(StrOpt) Jinja template file for haproxy configuration</td>
</tr>
<tr>
<td><option>loadbalancer_state_path</option> = <replaceable>$state_path/lbaas</replaceable></td>
<td>(StrOpt) Location to store config and state files</td>
</tr> </tr>
<tr> <tr>
<td><option>periodic_interval</option> = <replaceable>10</replaceable></td> <td><option>periodic_interval</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Seconds between periodic task runs</td> <td>(IntOpt) Seconds between periodic task runs</td>
</tr> </tr>
<tr>
<td><option>interface_driver</option> = <replaceable>neutron.agent.linux.interface.OVSInterfaceDriver</replaceable></td>
<td>(StrOpt) The driver used to manage the virtual interface.</td>
</tr>
<tr>
<td><option>ovs_use_veth</option> = <replaceable>False</replaceable></td>
<td>(StrOpt) Use veth for an OVS interface or not.</td>
</tr>
<tr>
<td><option>device_driver</option> = <replaceable>neutron.services.loadbalancer.drivers.haproxy.namespace_driver.HaproxyNSDriver</replaceable></td>
<td>(StrOpt) The agent requires drivers to manage the loadbalancer. HAProxy is the opensource version.</td>
</tr>
<tr>
<th colspan="2">[haproxy]</th>
</tr>
<tr>
<td><option>loadbalancer_state_path</option> = <replaceable>$state_path/lbaas</replaceable></td>
<td>(StrOpt) Location to store config and state files</td>
</tr>
<tr> <tr>
<td><option>send_gratuitous_arp</option> = <replaceable>3</replaceable></td> <td><option>send_gratuitous_arp</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) When delete and re-add the same vip, send this many gratuitous ARPs to flush the ARP cache in the Router. Set it below or equal to 0 to disable this feature.</td> <td>(IntOpt) When delete and re-add the same vip, send this many gratuitous ARPs to flush the ARP cache in the Router. Set it below or equal to 0 to disable this feature.</td>

70
doc/common/tables/neutron-lbaas_embrane.xml
View File

@ -1,70 +0,0 @@
<?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_embrane">
<caption>Description of LBaaS Embrane plugin 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">[heleoslb]</th>
</tr>
<tr>
<td><option>admin_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) ESM admin password.</td>
</tr>
<tr>
<td><option>admin_username</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) ESM admin username.</td>
</tr>
<tr>
<td><option>async_requests</option> = <replaceable>None</replaceable></td>
<td>(BoolOpt) Define if the requests have run asynchronously or not</td>
</tr>
<tr>
<td><option>dummy_utif_id</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Dummy user traffic Security Zone id for LBs</td>
</tr>
<tr>
<td><option>esm_mgmt</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) ESM management root address</td>
</tr>
<tr>
<td><option>inband_id</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) In band Security Zone id for LBs</td>
</tr>
<tr>
<td><option>lb_flavor</option> = <replaceable>small</replaceable></td>
<td>(StrOpt) choose LB image flavor to use, accepted values: small, medium</td>
</tr>
<tr>
<td><option>lb_image</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Load Balancer image id (Embrane LB)</td>
</tr>
<tr>
<td><option>mgmt_id</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Management Security Zone id for LBs</td>
</tr>
<tr>
<td><option>oob_id</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Out of band Security Zone id for LBs</td>
</tr>
<tr>
<td><option>resource_pool_id</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Shared resource pool id</td>
</tr>
<tr>
<td><option>sync_interval</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) resource synchronization interval in seconds</td>
</tr>
</tbody>
</table>
</para>

46
doc/common/tables/neutron-lbaas_netscaler.xml
View File

@ -1,46 +0,0 @@
<?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_netscaler">
<caption>Description of LBaaS NetScaler plugin 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">[netscaler_driver]</th>
</tr>
<tr>
<td><option>is_synchronous</option> = <replaceable>True</replaceable></td>
<td>(StrOpt) Setting for option to enable synchronous operationsNetScaler Control Center Server.</td>
</tr>
<tr>
<td><option>netscaler_ncc_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password to login to the NetScaler Control Center Server.</td>
</tr>
<tr>
<td><option>netscaler_ncc_uri</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The URL to reach the NetScaler Control Center Server.</td>
</tr>
<tr>
<td><option>netscaler_ncc_username</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Username to login to the NetScaler Control Center Server.</td>
</tr>
<tr>
<td><option>netscaler_status_collection</option> = <replaceable>True,300</replaceable></td>
<td>(StrOpt) Setting for member status collection fromNetScaler Control Center Server.</td>
</tr>
<tr>
<td><option>periodic_task_interval</option> = <replaceable>2</replaceable></td>
<td>(StrOpt) Setting for periodic task collection interval fromNetScaler Control Center Server..</td>
</tr>
</tbody>
</table>
</para>

322
doc/common/tables/neutron-lbaas_radware.xml → doc/common/tables/neutron-lbaas_services.xml
View File

@ -3,8 +3,8 @@
<!-- Warning: Do not edit this file. It is automatically <!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten. generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. --> The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_neutron_lbaas_radware"> <table rules="all" xml:id="config_table_neutron_lbaas_services">
<caption>Description of LBaaS Radware plugin configuration options</caption> <caption>Description of LBaaS Radware, Netscaler, HAProxy, Octavia plugin configuration options</caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
<thead> <thead>
@ -18,13 +18,77 @@
<th colspan="2">[radware]</th> <th colspan="2">[radware]</th>
</tr> </tr>
<tr> <tr>
<td><option>actions_to_skip</option> = <replaceable>setup_l2_l3</replaceable></td> <td><option>vdirect_address</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) List of actions that are not pushed to the completion queue.</td> <td>(StrOpt) IP address of vDirect server.</td>
</tr> </tr>
<tr> <tr>
<td><option>ha_secondary_address</option> = <replaceable>None</replaceable></td> <td><option>ha_secondary_address</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) IP address of secondary vDirect server.</td> <td>(StrOpt) IP address of secondary vDirect server.</td>
</tr> </tr>
<tr>
<td><option>vdirect_user</option> = <replaceable>vDirect</replaceable></td>
<td>(StrOpt) vDirect user name.</td>
</tr>
<tr>
<td><option>vdirect_password</option> = <replaceable>radware</replaceable></td>
<td>(StrOpt) vDirect user password.</td>
</tr>
<tr>
<td><option>service_ha_pair</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables the Service HA pair. Default: False.</td>
</tr>
<tr>
<td><option>service_throughput</option> = <replaceable>1000</replaceable></td>
<td>(IntOpt) Service throughput. Default: 1000.</td>
</tr>
<tr>
<td><option>service_ssl_throughput</option> = <replaceable>100</replaceable></td>
<td>(IntOpt) Service SSL throughput. Default: 100.</td>
</tr>
<tr>
<td><option>service_compression_throughput</option> = <replaceable>100</replaceable></td>
<td>(IntOpt) Service compression throughput. Default: 100.</td>
</tr>
<tr>
<td><option>service_cache</option> = <replaceable>20</replaceable></td>
<td>(IntOpt) Size of service cache. Default: 20.</td>
</tr>
<tr>
<td><option>service_adc_type</option> = <replaceable>VA</replaceable></td>
<td>(StrOpt) Service ADC type. Default: VA.</td>
</tr>
<tr>
<td><option>service_adc_version</option> = <replaceable></replaceable></td>
<td>(StrOpt) Service ADC version.</td>
</tr>
<tr>
<td><option>service_session_mirroring_enabled</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable or disable Alteon interswitch link for stateful session failover. Default: False.</td>
</tr>
<tr>
<td><option>service_isl_vlan</option> = <replaceable>-1</replaceable></td>
<td>(IntOpt) A required VLAN for the interswitch link to use.</td>
</tr>
<tr>
<td><option>service_resource_pool_ids</option> = <replaceable></replaceable></td>
<td>(ListOpt) Resource pool IDs.</td>
</tr>
<tr>
<td><option>actions_to_skip</option> = <replaceable>setup_l2_l3</replaceable></td>
<td>(ListOpt) List of actions that are not pushed to the completion queue.</td>
</tr>
<tr>
<td><option>l4_action_name</option> = <replaceable>BaseCreate</replaceable></td>
<td>(StrOpt) Name of the l4 workflow action. Default: BaseCreate.</td>
</tr>
<tr>
<td><option>l2_l3_workflow_name</option> = <replaceable>openstack_l2_l3</replaceable></td>
<td>(StrOpt) Name of l2_l3 workflow. Default: openstack_l2_l3.</td>
</tr>
<tr>
<td><option>l4_workflow_name</option> = <replaceable>openstack_l4</replaceable></td>
<td>(StrOpt) Name of l4 workflow. Default: openstack_l4.</td>
</tr>
<tr> <tr>
<td><option>l2_l3_ctor_params</option> = <replaceable>{'ha_network_name': 'HA-Network', 'service': '_REPLACE_', 'ha_ip_pool_name': 'default', 'twoleg_enabled': '_REPLACE_', 'allocate_ha_ips': True, 'allocate_ha_vrrp': True}</replaceable></td> <td><option>l2_l3_ctor_params</option> = <replaceable>{'ha_network_name': 'HA-Network', 'service': '_REPLACE_', 'ha_ip_pool_name': 'default', 'twoleg_enabled': '_REPLACE_', 'allocate_ha_ips': True, 'allocate_ha_vrrp': True}</replaceable></td>
<td>(DictOpt) Parameter for l2_l3 workflow constructor.</td> <td>(DictOpt) Parameter for l2_l3 workflow constructor.</td>
@ -34,80 +98,44 @@
<td>(DictOpt) Parameter for l2_l3 workflow setup.</td> <td>(DictOpt) Parameter for l2_l3 workflow setup.</td>
</tr> </tr>
<tr> <tr>
<td><option>l2_l3_workflow_name</option> = <replaceable>openstack_l2_l3</replaceable></td> <th colspan="2">[radwarev2]</th>
<td>(StrOpt) Name of l2_l3 workflow. Default: openstack_l2_l3.</td>
</tr>
<tr>
<td><option>l4_action_name</option> = <replaceable>BaseCreate</replaceable></td>
<td>(StrOpt) Name of the l4 workflow action. Default: BaseCreate.</td>
</tr>
<tr>
<td><option>l4_workflow_name</option> = <replaceable>openstack_l4</replaceable></td>
<td>(StrOpt) Name of l4 workflow. Default: openstack_l4.</td>
</tr>
<tr>
<td><option>service_adc_type</option> = <replaceable>VA</replaceable></td>
<td>(StrOpt) Service ADC type. Default: VA.</td>
</tr>
<tr>
<td><option>service_adc_version</option> = <replaceable></replaceable></td>
<td>(StrOpt) Service ADC version.</td>
</tr>
<tr>
<td><option>service_cache</option> = <replaceable>20</replaceable></td>
<td>(IntOpt) Size of service cache. Default: 20.</td>
</tr>
<tr>
<td><option>service_compression_throughput</option> = <replaceable>100</replaceable></td>
<td>(IntOpt) Service compression throughput. Default: 100.</td>
</tr>
<tr>
<td><option>service_ha_pair</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables the Service HA pair. Default: False.</td>
</tr>
<tr>
<td><option>service_isl_vlan</option> = <replaceable>-1</replaceable></td>
<td>(IntOpt) A required VLAN for the interswitch link to use.</td>
</tr>
<tr>
<td><option>service_resource_pool_ids</option> = <replaceable></replaceable></td>
<td>(ListOpt) Resource pool IDs.</td>
</tr>
<tr>
<td><option>service_session_mirroring_enabled</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable or disable Alteon interswitch link for stateful session failover. Default: False.</td>
</tr>
<tr>
<td><option>service_ssl_throughput</option> = <replaceable>100</replaceable></td>
<td>(IntOpt) Service SSL throughput. Default: 100.</td>
</tr>
<tr>
<td><option>service_throughput</option> = <replaceable>1000</replaceable></td>
<td>(IntOpt) Service throughput. Default: 1000.</td>
</tr> </tr>
<tr> <tr>
<td><option>vdirect_address</option> = <replaceable>None</replaceable></td> <td><option>vdirect_address</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) IP address of vDirect server.</td> <td>(StrOpt) IP address of vDirect server.</td>
</tr> </tr>
<tr>
<td><option>vdirect_password</option> = <replaceable>radware</replaceable></td>
<td>(StrOpt) vDirect user password.</td>
</tr>
<tr>
<td><option>vdirect_user</option> = <replaceable>vDirect</replaceable></td>
<td>(StrOpt) vDirect user name.</td>
</tr>
<tr>
<th colspan="2">[radwarev2]</th>
</tr>
<tr>
<td><option>child_workflow_template_names</option> = <replaceable>manage_l3</replaceable></td>
<td>(ListOpt) Name of child workflow templates used.Default: manage_l3</td>
</tr>
<tr> <tr>
<td><option>ha_secondary_address</option> = <replaceable>None</replaceable></td> <td><option>ha_secondary_address</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) IP address of secondary vDirect server.</td> <td>(StrOpt) IP address of secondary vDirect server.</td>
</tr> </tr>
<tr>
<td><option>vdirect_user</option> = <replaceable>vDirect</replaceable></td>
<td>(StrOpt) vDirect user name.</td>
</tr>
<tr>
<td><option>vdirect_password</option> = <replaceable>radware</replaceable></td>
<td>(StrOpt) vDirect user password.</td>
</tr>
<tr>
<td><option>service_ha_pair</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables the Service HA pair. Default: False.</td>
</tr>
<tr>
<td><option>service_throughput</option> = <replaceable>1000</replaceable></td>
<td>(IntOpt) Service throughput. Default: 1000.</td>
</tr>
<tr>
<td><option>service_ssl_throughput</option> = <replaceable>100</replaceable></td>
<td>(IntOpt) Service SSL throughput. Default: 100.</td>
</tr>
<tr>
<td><option>service_compression_throughput</option> = <replaceable>100</replaceable></td>
<td>(IntOpt) Service compression throughput. Default: 100.</td>
</tr>
<tr>
<td><option>service_cache</option> = <replaceable>20</replaceable></td>
<td>(IntOpt) Size of service cache. Default: 20.</td>
</tr>
<tr> <tr>
<td><option>service_adc_type</option> = <replaceable>VA</replaceable></td> <td><option>service_adc_type</option> = <replaceable>VA</replaceable></td>
<td>(StrOpt) Service ADC type. Default: VA.</td> <td>(StrOpt) Service ADC type. Default: VA.</td>
@ -117,16 +145,8 @@
<td>(StrOpt) Service ADC version.</td> <td>(StrOpt) Service ADC version.</td>
</tr> </tr>
<tr> <tr>
<td><option>service_cache</option> = <replaceable>20</replaceable></td> <td><option>service_session_mirroring_enabled</option> = <replaceable>False</replaceable></td>
<td>(IntOpt) Size of service cache. Default: 20.</td> <td>(BoolOpt) Enable or disable Alteon interswitch link for stateful session failover. Default: False.</td>
</tr>
<tr>
<td><option>service_compression_throughput</option> = <replaceable>100</replaceable></td>
<td>(IntOpt) Service compression throughput. Default: 100.</td>
</tr>
<tr>
<td><option>service_ha_pair</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables the Service HA pair. Default: False.</td>
</tr> </tr>
<tr> <tr>
<td><option>service_isl_vlan</option> = <replaceable>-1</replaceable></td> <td><option>service_isl_vlan</option> = <replaceable>-1</replaceable></td>
@ -137,48 +157,32 @@
<td>(ListOpt) Resource pool IDs.</td> <td>(ListOpt) Resource pool IDs.</td>
</tr> </tr>
<tr> <tr>
<td><option>service_session_mirroring_enabled</option> = <replaceable>False</replaceable></td> <td><option>workflow_template_name</option> = <replaceable>os_lb_v2</replaceable></td>
<td>(BoolOpt) Enable or disable Alteon interswitch link for stateful session failover. Default: False.</td> <td>(StrOpt) Name of the workflow template. Default: os_lb_v2.</td>
</tr> </tr>
<tr> <tr>
<td><option>service_ssl_throughput</option> = <replaceable>100</replaceable></td> <td><option>child_workflow_template_names</option> = <replaceable>manage_l3</replaceable></td>
<td>(IntOpt) Service SSL throughput. Default: 100.</td> <td>(ListOpt) Name of child workflow templates used.Default: manage_l3</td>
</tr>
<tr>
<td><option>service_throughput</option> = <replaceable>1000</replaceable></td>
<td>(IntOpt) Service throughput. Default: 1000.</td>
</tr>
<tr>
<td><option>stats_action_name</option> = <replaceable>stats</replaceable></td>
<td>(StrOpt) Name of the workflow action for statistics. Default: stats.</td>
</tr>
<tr>
<td><option>vdirect_address</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) IP address of vDirect server.</td>
</tr>
<tr>
<td><option>vdirect_password</option> = <replaceable>radware</replaceable></td>
<td>(StrOpt) vDirect user password.</td>
</tr>
<tr>
<td><option>vdirect_user</option> = <replaceable>vDirect</replaceable></td>
<td>(StrOpt) vDirect user name.</td>
</tr>
<tr>
<td><option>workflow_action_name</option> = <replaceable>apply</replaceable></td>
<td>(StrOpt) Name of the workflow action. Default: apply.</td>
</tr> </tr>
<tr> <tr>
<td><option>workflow_params</option> = <replaceable>{'data_ip_address': '192.168.200.99', 'ha_network_name': 'HA-Network', 'ha_port': 2, 'allocate_ha_ips': True, 'ha_ip_pool_name': 'default', 'allocate_ha_vrrp': True, 'data_port': 1, 'gateway': '192.168.200.1', 'twoleg_enabled': '_REPLACE_', 'data_ip_mask': '255.255.255.0'}</replaceable></td> <td><option>workflow_params</option> = <replaceable>{'data_ip_address': '192.168.200.99', 'ha_network_name': 'HA-Network', 'ha_port': 2, 'allocate_ha_ips': True, 'ha_ip_pool_name': 'default', 'allocate_ha_vrrp': True, 'data_port': 1, 'gateway': '192.168.200.1', 'twoleg_enabled': '_REPLACE_', 'data_ip_mask': '255.255.255.0'}</replaceable></td>
<td>(DictOpt) Parameter for l2_l3 workflow constructor.</td> <td>(DictOpt) Parameter for l2_l3 workflow constructor.</td>
</tr> </tr>
<tr> <tr>
<td><option>workflow_template_name</option> = <replaceable>os_lb_v2</replaceable></td> <td><option>workflow_action_name</option> = <replaceable>apply</replaceable></td>
<td>(StrOpt) Name of the workflow template. Default: os_lb_v2.</td> <td>(StrOpt) Name of the workflow action. Default: apply.</td>
</tr>
<tr>
<td><option>stats_action_name</option> = <replaceable>stats</replaceable></td>
<td>(StrOpt) Name of the workflow action for statistics. Default: stats.</td>
</tr> </tr>
<tr> <tr>
<th colspan="2">[radwarev2_debug]</th> <th colspan="2">[radwarev2_debug]</th>
</tr> </tr>
<tr>
<td><option>provision_service</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Provision ADC service?</td>
</tr>
<tr> <tr>
<td><option>configure_l3</option> = <replaceable>True</replaceable></td> <td><option>configure_l3</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Configule ADC with L3 parameters?</td> <td>(BoolOpt) Configule ADC with L3 parameters?</td>
@ -188,8 +192,104 @@
<td>(BoolOpt) Configule ADC with L4 parameters?</td> <td>(BoolOpt) Configule ADC with L4 parameters?</td>
</tr> </tr>
<tr> <tr>
<td><option>provision_service</option> = <replaceable>True</replaceable></td> <th colspan="2">[netscaler_driver]</th>
<td>(BoolOpt) Provision ADC service?</td> </tr>
<tr>
<td><option>netscaler_ncc_uri</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The URL to reach the NetScaler Control Center Server.</td>
</tr>
<tr>
<td><option>netscaler_ncc_username</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Username to login to the NetScaler Control Center Server.</td>
</tr>
<tr>
<td><option>netscaler_ncc_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password to login to the NetScaler Control Center Server.</td>
</tr>
<tr>
<th colspan="2">[heleoslb]</th>
</tr>
<tr>
<td><option>esm_mgmt</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) ESM management root address</td>
</tr>
<tr>
<td><option>admin_username</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) ESM admin username.</td>
</tr>
<tr>
<td><option>admin_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) ESM admin password.</td>
</tr>
<tr>
<td><option>lb_image</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Load Balancer image id (Embrane LB)</td>
</tr>
<tr>
<td><option>inband_id</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) In band Security Zone id for LBs</td>
</tr>
<tr>
<td><option>oob_id</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Out of band Security Zone id for LBs</td>
</tr>
<tr>
<td><option>mgmt_id</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Management Security Zone id for LBs</td>
</tr>
<tr>
<td><option>dummy_utif_id</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Dummy user traffic Security Zone id for LBs</td>
</tr>
<tr>
<td><option>resource_pool_id</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Shared resource pool id</td>
</tr>
<tr>
<td><option>async_requests</option> = <replaceable>None</replaceable></td>
<td>(BoolOpt) Define if the requests have run asynchronously or not</td>
</tr>
<tr>
<td><option>lb_flavor</option> = <replaceable>small</replaceable></td>
<td>(StrOpt) choose LB image flavor to use, accepted values: small, medium</td>
</tr>
<tr>
<td><option>sync_interval</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) resource synchronization interval in seconds</td>
</tr>
<tr>
<th colspan="2">[haproxy]</th>
</tr>
<tr>
<td><option>jinja_config_template</option> = <replaceable>/opt/stack/neutron/neutron/services/drivers/haproxy/templates/haproxy_v1.4.template</replaceable></td>
<td>(StrOpt) Jinja template file for haproxy configuration</td>
</tr>
<tr>
<td><option>periodic_interval</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Seconds between periodic task runs.</td>
</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>send_gratuitous_arp</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) When delete and re-add the same vip, send this many gratuitous ARPs to flush the ARP cache in the Router. Set it below or equal to 0 to disable this feature.</td>
</tr>
<tr>
<td><option>user_group</option> = <replaceable>nogroup</replaceable></td>
<td>(StrOpt) The user group.</td>
</tr>
<tr>
<td><option>loadbalancer_state_path</option> = <replaceable>$state_path/lbaas</replaceable></td>
<td>(StrOpt) Location to store config and state files.</td>
</tr>
<tr>
<th colspan="2">[octavia]</th>
</tr>
<tr>
<td><option>base_url</option> = <replaceable>http://localhost:9191</replaceable></td>
<td>(StrOpt) Base url for octavia api service.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>

359
doc/common/tables/octavia.xml Normal file
View File

@ -0,0 +1,359 @@
<?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_octavia">
<caption>Description of Octavia 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>verbose</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
</tr>
<tr>
<td><option>debug</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
</tr>
<tr>
<td><option>bind_host</option> = <replaceable>0.0.0.0</replaceable></td>
<td>(StrOpt) The host IP to bind to the api service to .</td>
</tr>
<tr>
<td><option>bind_port</option> = <replaceable>9876</replaceable></td>
<td>(IntOpt) The port to bind to the api service to.</td>
</tr>
<tr>
<td><option>api_handler</option> = <replaceable>simulated_handler</replaceable></td>
<td>(StrOpt) The handler that the API communicates with.</td>
</tr>
<tr>
<td><option>octavia_plugins</option> = <replaceable>hot_plug_plugin</replaceable></td>
<td>(StrOpt) Name of the controller plugin to use.</td>
</tr>
<tr>
<td><option>os_region_name</option> = <replaceable></replaceable></td>
<td>(StrOpt) Region in Identity service catalog to use for communication with the OpenStack services.</td>
</tr>
<tr>
<td><option>host</option> = <replaceable></replaceable></td>
<td>(StrOpt) Hostname to be used by the host machine for services running on it.The default value is the hostname of the host machine.</td>
</tr>
<tr>
<th colspan="2">[database]</th>
</tr>
<tr>
<td><option>connection</option> = <replaceable>mysql+pymysql://root:pass@127.0.0.1:3306/octavia</replaceable></td>
<td>(StrOpt) The SQLAlchemy connection string used to connect to the database.</td>
</tr>
<tr>
<th colspan="2">[health_manager]</th>
</tr>
<tr>
<td><option>bind_ip</option> = <replaceable>0.0.0.0</replaceable></td>
<td>(StrOpt) IP address the controller will listen on for heart beats from the amphora.</td>
</tr>
<tr>
<td><option>bind_port</option> = <replaceable>5555</replaceable></td>
<td>(IntOpt) Port number the controller will listen on for heart beats from the amphora.</td>
</tr>
<tr>
<td><option>controller_ip_port_list</option> = <replaceable></replaceable></td>
<td>(StrOpt) List of controller ip and port pairs for the heartbeat receivers. Example [127.0.0.1:5555, 127.0.0.1:5555].</td>
</tr>
<tr>
<td><option>failover_threads</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Number of threads performing amphora failovers.</td>
</tr>
<tr>
<td><option>status_update_threads</option> = <replaceable>50</replaceable></td>
<td>(IntOpt) Number of threads performing amphora status update.</td>
</tr>
<tr>
<td><option>heartbeat_interval</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Sleep time between sending hearthbeats from the amphora.</td>
</tr>
<tr>
<td><option>heartbeat_key</option> = <replaceable></replaceable></td>
<td>(StrOpt) key used to authenticate the heartbeat message sent by the amphora.</td>
</tr>
<tr>
<td><option>heartbeat_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Interval, in seconds, to wait before failing over an amphora.</td>
</tr>
<tr>
<td><option>health_check_interval</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Sleep time between health checks in seconds.</td>
</tr>
<tr>
<td><option>sock_rlimit</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) sets the value of the heartbeat recv buffer.</td>
</tr>
<tr>
<th colspan="2">[keystone_authtoken]</th>
</tr>
<tr>
<td><option>auth_uri</option> = <replaceable>https://localhost:5000/v3</replaceable></td>
<td>(StrOpt) Complete public Identity API endpoint.</td>
</tr>
<tr>
<td><option>admin_user</option> = <replaceable>octavia</replaceable></td>
<td>(StrOpt) Keystone account username.</td>
</tr>
<tr>
<td><option>admin_password</option> = <replaceable>password</replaceable></td>
<td>(StrOpt) Keystone account password.</td>
</tr>
<tr>
<td><option>admin_tenant_name</option> = <replaceable>service</replaceable></td>
<td>(StrOpt) Keystone service account tenant name to validate user tokens.</td>
</tr>
<tr>
<td><option>insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Verify HTTPS connections.</td>
</tr>
<tr>
<th colspan="2">[keystone_authtoken_v3]</th>
</tr>
<tr>
<td><option>admin_user_domain</option> = <replaceable>default</replaceable></td>
<td>(StrOpt) Admin user keystone authentication domain.</td>
</tr>
<tr>
<td><option>admin_project_domain</option> = <replaceable>default</replaceable></td>
<td>(StrOpt) Admin project keystone authentication domain.</td>
</tr>
<tr>
<th colspan="2">[certificates]</th>
</tr>
<tr>
<td><option>cert_generator_class</option> = <replaceable>octavia.certificates.generator.LocalCertGenerator</replaceable></td>
<td>(StrOpt) Class name which generate certificates.</td>
</tr>
<tr>
<td><option>cert_manager_class</option> = <replaceable>octavia.certificates.manager.LocalCertManager</replaceable></td>
<td>(StrOpt) Class name of certificate manager.</td>
</tr>
<tr>
<td><option>ca_certificate</option> = <replaceable>/etc/ssl/certs/ssl-cert-snakeoil.pem</replaceable></td>
<td>(StrOpt) Absolute path to the CA Certificate for signing. Defaults to env[OS_OCTAVIA_TLS_CA_CERT].Local Cert generator only.</td>
</tr>
<tr>
<td><option>ca_private_key</option> = <replaceable>/etc/ssl/private/ssl-cert-snakeoil.key</replaceable></td>
<td>(StrOpt) Absolute path to the Private Key for signing. Defaults to env[OS_OCTAVIA_TLS_CA_KEY].Local Cert generator only.</td>
</tr>
<tr>
<td><option>ca_private_key_passphrase</option> = <replaceable></replaceable></td>
<td>(StrOpt) Passphrase for the Private Key. Defaults to env[OS_OCTAVIA_CA_KEY_PASS] or None.Local Cert generator only.</td>
</tr>
<tr>
<td><option>signing_digest</option> = <replaceable>sha256</replaceable></td>
<td>(StrOpt) Certificate signing digest. Defaults to env[OS_OCTAVIA_CA_SIGNING_DIGEST] or sha256.Local Cert generator only.</td>
</tr>
<tr>
<td><option>storage_path</option> = <replaceable>/var/lib/octavia/certificates/</replaceable></td>
<td>(StrOpt) Absolute path to the certificate storage directory. Defaults to env[OS_OCTAVIA_TLS_STORAGE].Local Cert manager only.</td>
</tr>
<tr>
<th colspan="2">[octavia_network]</th>
</tr>
<tr>
<td><option>lb_network_name</option> = <replaceable></replaceable></td>
<td>(StrOpt) Network to communicate with amphora.</td>
</tr>
<tr>
<td><option>max_retries</option> = <replaceable>15</replaceable></td>
<td>(IntOpt) The maximum attempts to retry an action with the networking service.</td>
</tr>
<tr>
<td><option>retry_interval</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Seconds to wait before retrying an action with the networking service.</td>
</tr>
<tr>
<th colspan="2">[haproxy_amphora]</th>
</tr>
<tr>
<td><option>base_path</option> = <replaceable>/var/lib/octavia</replaceable></td>
<td>(StrOpt) Base directory for amphora files on amphora.</td>
</tr>
<tr>
<td><option>base_cert_dir</option> = <replaceable>/var/lib/octavia/certs</replaceable></td>
<td>(StrOpt) Base directory for cert storage on amphora.</td>
</tr>
<tr>
<td><option>haproxy_template</option> = <replaceable>/var/lib/octavia/custom_template</replaceable></td>
<td>(StrOpt) Custom haproxy template.</td>
</tr>
<tr>
<td><option>base_log_dir</option> = <replaceable>/logs</replaceable></td>
<td>(StrOpt) Base director for log on amphora.</td>
</tr>
<tr>
<td><option>connection_max_retries</option> = <replaceable>300</replaceable></td>
<td>(IntOpt) Retry threshold for connecting to amphorae.</td>
</tr>
<tr>
<td><option>connection_retry_interval</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) Retry threshold for connecting to amphorae.</td>
</tr>
<tr>
<td><option>cert_manager</option> = <replaceable>barbican_cert_manager</replaceable></td>
<td>(StrOpt) Name of the cert manager to use.</td>
</tr>
<tr>
<td><option>username</option> = <replaceable>ubuntu</replaceable></td>
<td>(StrOpt) Name of user for access to amphora,ssh driver only.</td>
</tr>
<tr>
<td><option>key_path</option> = <replaceable>/opt/stack/.ssh/id_rsa</replaceable></td>
<td>(StrOpt) Local absolute path to the private key loaded on amphora at boot,ssh driver only.</td>
</tr>
<tr>
<td><option>bind_host</option> = <replaceable>0.0.0.0</replaceable></td>
<td>(StrOpt) The host IP to bind to amphora hose/REST driver only.</td>
</tr>
<tr>
<td><option>bind_port</option> = <replaceable>9191</replaceable></td>
<td>(IntOpt) The port to bind to.REST driver only.</td>
</tr>
<tr>
<td><option>haproxy_cmd</option> = <replaceable>/usr/sbin/haproxy</replaceable></td>
<td>(StrOpt) The full path to haproxy.</td>
</tr>
<tr>
<td><option>respawn_count</option> = <replaceable>2</replaceable></td>
<td>(IntOpt) The respawn count for haproxy's upstart script.</td>
</tr>
<tr>
<td><option>respawn_interval</option> = <replaceable>2</replaceable></td>
<td>(IntOpt) The respawn interval for haproxy's upstart script.</td>
</tr>
<tr>
<td><option>haproxy_cert_dir</option> = <replaceable>/tmp</replaceable></td>
<td>(StrOpt) The directory to store haproxy cert files in.</td>
</tr>
<tr>
<th colspan="2">[controller_worker]</th>
</tr>
<tr>
<td><option>amp_active_retries</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Retry attempts to wait for Amphora to become active.</td>
</tr>
<tr>
<td><option>amp_active_wait_sec</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Seconds to wait for an Amphora to become active.</td>
</tr>
<tr>
<td><option>amp_flavor_id</option> = <replaceable></replaceable></td>
<td>(StrOpt) Nova instance flavor id for the Amphora.</td>
</tr>
<tr>
<td><option>amp_image_id</option> = <replaceable></replaceable></td>
<td>(StrOpt) Glance image id for the Amphora image to boot.</td>
</tr>
<tr>
<td><option>amp_ssh_key_name</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSH key name used to boot the Amphora.REST driver/or debugging.</td>
</tr>
<tr>
<td><option>amp_network</option> = <replaceable></replaceable></td>
<td>(StrOpt) Network to attach to the Amphora.</td>
</tr>
<tr>
<td><option>amp_secgroup_list</option> = <replaceable></replaceable></td>
<td>(StrOpt) List of security groups to attach to the Amphora.</td>
</tr>
<tr>
<td><option>client_ca</option> = <replaceable>/etc/octavia/certs/ca_01.pem</replaceable></td>
<td>(StrOpt) Client CA for the amphora agent to use.REST driver only.</td>
</tr>
<tr>
<td><option>amphora_driver</option> = <replaceable>amphora_noop_driver</replaceable></td>
<td>(StrOpt) Name of the amphora driver to use.</td>
</tr>
<tr>
<td><option>compute_driver</option> = <replaceable>compute_noop_driver</replaceable></td>
<td>(StrOpt) Name of the compute driver to use.</td>
</tr>
<tr>
<td><option>network_driver</option> = <replaceable>network_noop_driver</replaceable></td>
<td>(StrOpt) Name of the network driver to use.</td>
</tr>
<tr>
<td><option>cert_generator</option> = <replaceable>local_cert_generator</replaceable></td>
<td>(StrOpt) Name of the cert generator to use.</td>
</tr>
<tr>
<th colspan="2">[task_flow]</th>
</tr>
<tr>
<td><option>engine</option> = <replaceable>serial</replaceable></td>
<td>(StrOpt) TaskFlow engine to use.</td>
</tr>
<tr>
<td><option>max_workers</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) The maximum number of workers.</td>
</tr>
<tr>
<th colspan="2">[oslo_messaging_rabbi]</th>
</tr>
<tr>
<td><option>rabbit_userid</option> = <replaceable>octavia</replaceable></td>
<td>(StrOpt) RabbitMQ username.</td>
</tr>
<tr>
<td><option>rabbit_password</option> = <replaceable>password</replaceable></td>
<td>(StrOpt) RabbitMQ password.</td>
</tr>
<tr>
<td><option>rabbit_port</option> = <replaceable>5672</replaceable></td>
<td>(IntOpt) RabbitMQ port.</td>
</tr>
<tr>
<td><option>rabbit_hosts</option> = <replaceable>localhost:5672</replaceable></td>
<td>(StrOpt) RabbitMQ host.</td>
</tr>
<tr>
<th colspan="2">[oslo_messaging]</th>
</tr>
<tr>
<td><option>rpc_thread_pool_size</option> = <replaceable>2</replaceable></td>
<td>(IntOpt) Queue Consumer Thread Pool Size.</td>
</tr>
<tr>
<td><option>topic</option> = <replaceable>octavia_prov</replaceable></td>
<td>(StrOpt) Topic (i.e. Queue) Name.</td>
</tr>
<tr>
<th colspan="2">[house_keeping]</th>
</tr>
<tr>
<td><option>spare_check_interval</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Interval in seconds to initiate spare amphora checks.</td>
</tr>
<tr>
<td><option>spare_amphora_pool_size</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Number of spare amphorae.</td>
</tr>
<tr>
<td><option>cleanup_interval</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Cleanup interval for Deleted amphora.</td>
</tr>
<tr>
<td><option>amphora_expiry_age</option> = <replaceable>604800</replaceable></td>
<td>(IntOpt) Amphora expiry age in seconds. Default is 1 week.</td>
</tr>
</tbody>
</table>
</para>

15
doc/config-reference/networking/section_networking-options-reference.xml
View File

@ -75,13 +75,18 @@
<section xml:id="networking-plugin-lbaas"> <section xml:id="networking-plugin-lbaas">
<title>Load-Balancer-as-a-Service configuration options</title> <title>Load-Balancer-as-a-Service configuration options</title>
<para>Use the following options in the <filename>lbaas_agent.ini</filename> <para>Use the following options in the <filename>neutron_lbaas.conf</filename>
file for the LBaaS agent.</para> file for the LBaaS agent.</para>
<xi:include href="../../common/tables/neutron-lbaas.xml" /> <xi:include href="../../common/tables/neutron-lbaas.xml" />
<xi:include href="../../common/tables/neutron-lbaas_embrane.xml" /> <para>Use the following options in the <filename>lbaas_agent.ini</filename>
<xi:include href="../../common/tables/neutron-lbaas_haproxy.xml" /> file for the LBaaS agent.</para>
<xi:include href="../../common/tables/neutron-lbaas_netscaler.xml" /> <xi:include href="../../common/tables/neutron-lbaas_agent.xml" />
<xi:include href="../../common/tables/neutron-lbaas_radware.xml" /> <para>Use the following options in the <filename>services_lbaas.conf</filename>
file for the LBaaS agent.</para>
<xi:include href="../../common/tables/neutron-lbaas_services.xml" />
<para>Use the following options in the <filename>/etc/octavia/octavia.conf</filename>
file for octavia config.</para>
<xi:include href="../../common/tables/octavia.xml" />
</section> </section>
<section xml:id="networking-plugin-vpnaas"> <section xml:id="networking-plugin-vpnaas">

231
tools/autogenerate-config-flagmappings/neutron.flagmappings
View File

@ -81,8 +81,7 @@ ipv6_gateway l3_agent
l2gw_callback_class l2gw l2gw_callback_class l2gw
l3_ha l3_agent l3_ha l3_agent
l3_ha_net_cidr l3_agent l3_ha_net_cidr l3_agent
loadbalancer_pool_scheduler_driver lbaas interface_driver lbaas
loadbalancer_scheduler_driver lbaas
log_config_append logging log_config_append logging
log_date_format logging log_date_format logging
log_dir logging log_dir logging
@ -494,12 +493,116 @@ general/l3_admin_tenant cisco
general/management_network cisco general/management_network cisco
general/service_vm_config_path cisco general/service_vm_config_path cisco
general/templates_path cisco general/templates_path cisco
haproxy/interface_driver lbaas_haproxy periodic_interval lbaas
haproxy/jinja_config_template lbaas_haproxy loadbalancer_scheduler_driver lbaas
haproxy/loadbalancer_state_path lbaas_haproxy loadbalancer_pool_scheduler_driver lbaas
haproxy/periodic_interval lbaas_haproxy quotas/quota_vip lbaas
haproxy/send_gratuitous_arp lbaas_haproxy quotas/quota_pool lbaas
haproxy/user_group lbaas_haproxy quotas/quota_member lbaas
quotas/quota_health_monitor lbaas
quotas/quota_loadbalancer lbaas
quotas/quota_listener lbaas
quotas/quota_healthmonitor lbaas
service_auth/auth_url lbaas
service_auth/admin_tenant_name lbaas
service_auth/admin_user lbaas
service_auth/admin_password lbaas
service_auth/admin_user_domain lbaas
service_auth/admin_project_domain lbaas
service_auth/region lbaas
service_auth/service_name lbaas
service_auth/auth_version lbaas
service_providers/service_provider lbaas
certificates/cert_manager_type lbaas
certificates/storage_path lbaas
periodic_interval lbaas_agent
interface_driver lbaas_agent
debug lbaas_agent
ovs_use_veth lbaas_agent
device_driver lbaas_agent
haproxy/loadbalancer_state_path lbaas_agent
haproxy/send_gratuitous_arp lbaas_agent
haproxy/user_group lbaas_agent
haproxy/send_gratuitous_arp lbaas_services
haproxy/user_group lbaas_services
haproxy/loadbalancer_state_path lbaas_services
haproxy/periodic_interval lbaas_services
haproxy/interface_driver lbaas_services
haproxy/jinja_config_template lbaas_services
octavia/base_url lbaas_services
debug octavia
verbose octavia
bind_host octavia
bind_port octavia
api_handler octavia
octavia_plugins octavia
os_region_name octavia
host octavia
database/connection octavia
health_manager/bind_ip octavia
health_manager/bind_port octavia
health_manager/controller_ip_port_list octavia
health_manager/failover_threads octavia
health_manager/status_update_threads octavia
health_manager/heartbeat_interval octavia
health_manager/heartbeat_key octavia
health_manager/heartbeat_timeout octavia
health_manager/health_check_interval octavia
health_manager/sock_rlimit octavia
keystone_authtoken/auth_uri octavia
keystone_authtoken/admin_user octavia
keystone_authtoken/admin_password octavia
keystone_authtoken/admin_tenant_name octavia
keystone_authtoken/insecure octavia
keystone_authtoken_v3/admin_user_domain octavia
keystone_authtoken_v3/admin_project_domain octavia
certificates/cert_generator_class octavia
certificates/cert_manager_class octavia
certificates/ca_certificate octavia
certificates/ca_private_key octavia
certificates/ca_private_key_passphrase octavia
certificates/signing_digest octavia
certificates/storage_path octavia
octavia_network/lb_network_name octavia
octavia_network/max_retries octavia
octavia_network/retry_interval octavia
haproxy_amphora/base_path octavia
haproxy_amphora/base_cert_dir octavia
haproxy_amphora/haproxy_template octavia
haproxy_amphora/base_log_dir octavia
haproxy_amphora/connection_retry_interval octavia
haproxy_amphora/cert_manager octavia
haproxy_amphora/username octavia
haproxy_amphora/key_path octavia
haproxy_amphora/bind_host octavia
haproxy_amphora/bin_port octavia
haproxy_amphora/haproxy_cmd octavia
haproxy_amphora/respawn_count octavia
haproxy_amphora/respawn_interval octavia
haproxy_amphora/haproxy_cert_dir octavia
controller_worker/amp_active_retries octavia
controller_worker/amp_active_wait_sec octavia
controller_worker/amp_flavor_id octavia
controller_worker/amp_image_id octavia
controller_worker/amp_ssh_key_name octavia
controller_worker/amp_network octavia
controller_worker/amp_secgroup_list octavia
controller_worker/client_ca octavia
controller_worker/amphora_driver octavia
controller_worker/compute_driver octavia
controller_worker/network_driver octavia
controller_worker/cert_generator octavia
task_flow/engine octavia
task_flow/max_workers octavia
oslo_messaging_rabbi/rabbit_userid octavia
oslo_messaging_rabbi/rabbit_password octavia
oslo_messaging_rabbi/rabbit_port octavia
oslo_messaging/rpc_thread_pool_size octavia
oslo_messaging/topic octavia
house_keeping/spare_check_interval octavia
house_keeping/spare_amphora_pool_size octavia
house_keeping/cleanup_interval octavia
house_keeping/amphora_expiry_age octavia
heleos/admin_password common heleos/admin_password common
heleos/admin_username embrane heleos/admin_username embrane
heleos/async_requests embrane heleos/async_requests embrane
@ -510,18 +613,18 @@ heleos/mgmt_id embrane
heleos/oob_id embrane heleos/oob_id embrane
heleos/resource_pool_id embrane heleos/resource_pool_id embrane
heleos/router_image embrane heleos/router_image embrane
heleoslb/admin_password lbaas_embrane heleoslb/admin_password lbaas_services
heleoslb/admin_username lbaas_embrane heleoslb/admin_username lbaas_services
heleoslb/async_requests lbaas_embrane heleoslb/async_requests lbaas_services
heleoslb/dummy_utif_id lbaas_embrane heleoslb/dummy_utif_id lbaas_services
heleoslb/esm_mgmt lbaas_embrane heleoslb/esm_mgmt lbaas_embrane
heleoslb/inband_id lbaas_embrane heleoslb/inband_id lbaas_services
heleoslb/lb_flavor lbaas_embrane heleoslb/lb_flavor lbaas_services
heleoslb/lb_image lbaas_embrane heleoslb/lb_image lbaas_services
heleoslb/mgmt_id lbaas_embrane heleoslb/mgmt_id lbaas_services
heleoslb/oob_id lbaas_embrane heleoslb/oob_id lbaas_services
heleoslb/resource_pool_id lbaas_embrane heleoslb/resource_pool_id lbaas_services
heleoslb/sync_interval lbaas_embrane heleoslb/sync_interval lbaas_services
hosting_devices/csr1kv_booting_time cisco hosting_devices/csr1kv_booting_time cisco
hosting_devices/csr1kv_cfgagent_router_driver cisco hosting_devices/csr1kv_cfgagent_router_driver cisco
hosting_devices/csr1kv_device_driver cisco hosting_devices/csr1kv_device_driver cisco
@ -679,9 +782,9 @@ ml2_type_vxlan/vni_ranges ml2_vxlan
ml2_type_vxlan/vxlan_group ml2_vxlan ml2_type_vxlan/vxlan_group ml2_vxlan
netscaler_driver/is_synchronous lbaas_netscaler netscaler_driver/is_synchronous lbaas_netscaler
netscaler_driver/netscaler_ncc_password lbaas_netscaler netscaler_driver/netscaler_ncc_password lbaas_netscaler
netscaler_driver/netscaler_ncc_uri lbaas_netscaler netscaler_driver/netscaler_ncc_uri lbaas_services
netscaler_driver/netscaler_ncc_username lbaas_netscaler netscaler_driver/netscaler_ncc_username lbaas_services
netscaler_driver/netscaler_status_collection lbaas_netscaler netscaler_driver/netscaler_status_collection lbaas_services
netscaler_driver/periodic_task_interval lbaas_netscaler netscaler_driver/periodic_task_interval lbaas_netscaler
ngfw/smc_api_auth_key fwaas_ngfw ngfw/smc_api_auth_key fwaas_ngfw
ngfw/smc_api_version fwaas_ngfw ngfw/smc_api_version fwaas_ngfw
@ -801,48 +904,48 @@ plumgriddirector/driver plumgrid
plumgriddirector/password plumgrid plumgriddirector/password plumgrid
plumgriddirector/servertimeout plumgrid plumgriddirector/servertimeout plumgrid
plumgriddirector/username plumgrid plumgriddirector/username plumgrid
radware/actions_to_skip lbaas_radware radware/actions_to_skip lbaas_services
radware/ha_secondary_address lbaas_radware radware/ha_secondary_address lbaas_services
radware/l2_l3_ctor_params lbaas_radware radware/l2_l3_ctor_params lbaas_services
radware/l2_l3_setup_params lbaas_radware radware/l2_l3_setup_params lbaas_services
radware/l2_l3_workflow_name lbaas_radware radware/l2_l3_workflow_name lbaas_services
radware/l4_action_name lbaas_radware radware/l4_action_name lbaas_services
radware/l4_workflow_name lbaas_radware radware/l4_workflow_name lbaas_services
radware/service_adc_type lbaas_radware radware/service_adc_type lbaas_services
radware/service_adc_version lbaas_radware radware/service_adc_version lbaas_services
radware/service_cache lbaas_radware radware/service_cache lbaas_services
radware/service_compression_throughput lbaas_radware radware/service_compression_throughput lbaas_services
radware/service_ha_pair lbaas_radware radware/service_ha_pair lbaas_services
radware/service_isl_vlan lbaas_radware radware/service_isl_vlan lbaas_services
radware/service_resource_pool_ids lbaas_radware radware/service_resource_pool_ids lbaas_services
radware/service_session_mirroring_enabled lbaas_radware radware/service_session_mirroring_enabled lbaas_services
radware/service_ssl_throughput lbaas_radware radware/service_ssl_throughput lbaas_services
radware/service_throughput lbaas_radware radware/service_throughput lbaas_services
radware/vdirect_address lbaas_radware radware/vdirect_address lbaas_services
radware/vdirect_password lbaas_radware radware/vdirect_password lbaas_services
radware/vdirect_user lbaas_radware radware/vdirect_user lbaas_services
radwarev2/child_workflow_template_names lbaas_radware radwarev2/child_workflow_template_names lbaas_services
radwarev2/ha_secondary_address lbaas_radware radwarev2/ha_secondary_address lbaas_services
radwarev2/service_adc_type lbaas_radware radwarev2/service_adc_type lbaas_services
radwarev2/service_adc_version lbaas_radware radwarev2/service_adc_version lbaas_services
radwarev2/service_cache lbaas_radware radwarev2/service_cache lbaas_services
radwarev2/service_compression_throughput lbaas_radware radwarev2/service_compression_throughput lbaas_services
radwarev2/service_ha_pair lbaas_radware radwarev2/service_ha_pair lbaas_services
radwarev2/service_isl_vlan lbaas_radware radwarev2/service_isl_vlan lbaas_services
radwarev2/service_resource_pool_ids lbaas_radware radwarev2/service_resource_pool_ids lbaas_services
radwarev2/service_session_mirroring_enabled lbaas_radware radwarev2/service_session_mirroring_enabled lbaas_services
radwarev2/service_ssl_throughput lbaas_radware radwarev2/service_ssl_throughput lbaas_services
radwarev2/service_throughput lbaas_radware radwarev2/service_throughput lbaas_services
radwarev2/stats_action_name lbaas_radware radwarev2/stats_action_name lbaas_services
radwarev2/vdirect_address lbaas_radware radwarev2/vdirect_address lbaas_services
radwarev2/vdirect_password lbaas_radware radwarev2/vdirect_password lbaas_services
radwarev2/vdirect_user lbaas_radware radwarev2/vdirect_user lbaas_services
radwarev2/workflow_action_name lbaas_radware radwarev2/workflow_action_name lbaas_services
radwarev2/workflow_params lbaas_radware radwarev2/workflow_params lbaas_services
radwarev2/workflow_template_name lbaas_radware radwarev2/workflow_template_name lbaas_services
radwarev2_debug/configure_l3 lbaas_radware radwarev2_debug/configure_l3 lbaas_services
radwarev2_debug/configure_l4 lbaas_radware radwarev2_debug/configure_l4 lbaas_services
radwarev2_debug/provision_service lbaas_radware radwarev2_debug/provision_service lbaas_services
service_providers/service_provider api service_providers/service_provider api
strongswan/default_config_area vpnaas_strongswan strongswan/default_config_area vpnaas_strongswan
strongswan/ipsec_config_template vpnaas_strongswan strongswan/ipsec_config_template vpnaas_strongswan

7
tools/autogenerate-config-flagmappings/neutron.headers
View File

@ -18,10 +18,9 @@ l3_arista Arista layer-3 service plug-in
l3_brocade_mlx Brocade MLX L3 plug-in l3_brocade_mlx Brocade MLX L3 plug-in
l3_brocade_mlx_switch Brocade MLX L3 switch l3_brocade_mlx_switch Brocade MLX L3 switch
lbaas Load-Balancer-as-a-Service lbaas Load-Balancer-as-a-Service
lbaas_embrane LBaaS Embrane plugin lbaas_agent LBaaS agent
lbaas_haproxy LBaaS HAProxy plugin lbaas_services LBaaS Radware, Netscaler, Haproxy,Octavia plugin
lbaas_netscaler LBaaS NetScaler plugin octavia Octavia
lbaas_radware LBaaS Radware plugin
linuxbridge_agent Linux Bridge agent linuxbridge_agent Linux Bridge agent
metering_agent metering agent metering_agent metering agent
midonet Midonet midonet Midonet