openstack/openstack-manuals
Code Issues Proposed changes
Files
96d208e736e5b32b4666adfbf8d864b9ed0ca394
openstack-manuals/doc/common/tables/neutron-lbaas_services.xml
Gauvain Pocentek 9fa2c79f7e [config-ref] tables: update some incorrect values 
The autohelp script didn't properly clean some values. Use sensible
values for pybasedir-based paths instead of values related to the build
environment.

Change-Id: Id72eef4436a5edeb67adced9169824adb4d4aa3f
2015-11-09 09:43:23 +01:00

328 lines
14 KiB
XML
Raw Blame History

<?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_services">
<caption>Description of LBaaS Embrane, Radware, NetScaler, HAproxy, Octavia 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">[haproxy]</th>
</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>
<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>jinja_config_template</option> = <replaceable>/usr/lib/python/site-packages/neutron_lbaas/services/loadbalancer/drivers/haproxy/templates/haproxy.loadbalancer.j2</replaceable></td>
<td>(StrOpt) Jinja template file for haproxy configuration</td>
</tr>
<tr>
<th colspan="2">[octavia]</th>
</tr>
<tr>
<td><option>base_url</option> = <replaceable>http://127.0.0.1:9876</replaceable></td>
<td>(StrOpt) URL of Octavia controller root</td>
</tr>
<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>
<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_cleanup_mode</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Setting to enable/disable cleanup mode for 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>
<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>
<tr>
<th colspan="2">[octavia]</th>
</tr>
<tr>
<td><option>base_url</option> = <replaceable>http://127.0.0.1:9876</replaceable></td>
<td>(StrOpt) URL of Octavia controller root</td>
</tr>
<tr>
<td><option>request_poll_interval</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Interval in seconds to poll octavia when an entity is created, updated, or deleted.</td>
</tr>
<tr>
<td><option>request_poll_timeout</option> = <replaceable>100</replaceable></td>
<td>(IntOpt) Time to stop polling octavia when a status of an entity does not change.</td>
</tr>
<tr>
<th colspan="2">[radware]</th>
</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>ha_secondary_address</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) IP address of secondary vDirect server.</td>
</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>(DictOpt) Parameter for l2_l3 workflow constructor.</td>
</tr>
<tr>
<td><option>l2_l3_setup_params</option> = <replaceable>{'data_ip_address': '192.168.200.99', 'data_port': 1, 'gateway': '192.168.200.1', 'ha_port': 2, 'data_ip_mask': '255.255.255.0'}</replaceable></td>
<td>(DictOpt) Parameter for l2_l3 workflow setup.</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_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>
<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>
<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>
<td><option>ha_secondary_address</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) IP address of secondary vDirect server.</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>
<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>
<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>
</tr>
<tr>
<td><option>workflow_template_name</option> = <replaceable>os_lb_v2</replaceable></td>
<td>(StrOpt) Name of the workflow template. Default: os_lb_v2.</td>
</tr>
<tr>
<th colspan="2">[radwarev2_debug]</th>
</tr>
<tr>
<td><option>configure_l3</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Configule ADC with L3 parameters?</td>
</tr>
<tr>
<td><option>configure_l4</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Configule ADC with L4 parameters?</td>
</tr>
<tr>
<td><option>provision_service</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Provision ADC service?</td>
</tr>
</tbody>
</table>
</para>
View Git Blame Copy Permalink