openstack/openstack-manuals
Code Issues Proposed changes

Updates conf reference for neutron ml2 plugin

Browse Source 
Fixes-Bug: 1229237
Fixes-Bug: 1237662
Change-Id: I6974ea7d857b5186f39913baf43f3a8c321cc4ba
This commit is contained in:
Justin Hammond 2013-10-09 12:56:56 -05:00 committed by Tom Fifield
parent cc1463a6ce
commit 3d44dd50c6
30 changed files with 610 additions and 252 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/common/tables/neutron-agent.xml
View File

@ -23,9 +23,17 @@
<td>external_pids=$state_path/external/pids</td>
<td>(StrOpt) Location to store child pid files</td>
</tr>
<tr>
<td>interface_driver=None</td>
<td>(StrOpt) The driver used to manage the virtual interface.</td>
</tr>
<tr>
<td>report_interval=4</td>
<td>(IntOpt) Seconds between nodes reporting state to server</td>
<td>(FloatOpt) Seconds between nodes reporting state to server</td>
</tr>
<tr>
<td>use_namespaces=True</td>
<td>(BoolOpt) Allow overlapping IP.</td>
</tr>
</tbody>
</table>

4
doc/common/tables/neutron-bigswitch.xml
View File

@ -24,7 +24,7 @@
<td>(IntOpt) Maximum number of router rules</td>
</tr>
<tr>
<td>neutron_id=neutron-autodoc</td>
<td>neutron_id=neutron-[hostname]</td>
<td>(StrOpt) User defined identifier for this Neutron deployment</td>
</tr>
<tr>
@ -97,4 +97,4 @@
</tr>
</tbody>
</table>
</para>
</para>

2
doc/common/tables/neutron-cisco.xml
View File

@ -24,7 +24,7 @@
<td>(StrOpt) N1K default policy profile</td>
</tr>
<tr>
<td>host=autodoc</td>
<td>host=[hostname]</td>
<td>(StrOpt) The hostname Neutron is running on</td>
</tr>
<tr>

10
doc/common/tables/neutron-common.xml
View File

@ -17,13 +17,13 @@
<tbody>
<tr>
<td>admin_password=None</td>
<td>(StrOpt) ESM admin password.</td>
<td>(StrOpt) Admin password</td>
</tr>
<tr>
<td>admin_tenant_name=None</td>
<td>(StrOpt) Admin tenant name</td>
</tr>
<tr>
<tr>
<td>admin_user=None</td>
<td>(StrOpt) Admin user</td>
</tr>
@ -76,9 +76,13 @@
<td>(BoolOpt) Ensure that configured gateway is on subnet</td>
</tr>
<tr>
<td>host=autodoc</td>
<td>host=docwork</td>
<td>(StrOpt) The hostname Neutron is running on</td>
</tr>
<tr>
<td>interface_driver=None</td>
<td>(StrOpt) The driver used to manage the virtual interface.</td>
</tr>
<tr>
<td>lock_path=None</td>
<td>(StrOpt) Directory to use for lock files. Default to a temp directory</td>

40
doc/common/tables/neutron-hyperv.xml
View File

@ -16,49 +16,13 @@
</thead>
<tbody>
<tr>
<td>enable_metrics_collection=False</td>
<td>(BoolOpt) Enables metrics collections for switch ports by using Hyper-V's metric APIs. Collected data can by retrieved by other apps and services, e.g.: Ceilometer. Requires Hyper-V / Windows Server 2012 and above</td>
</tr>
<tr>
<td>force_hyperv_utils_v1=False</td>
<td>(BoolOpt) Force V1 WMI utility classes</td>
</tr>
<tr>
<td>local_network_vswitch=private</td>
<td>(StrOpt) Private vswitch name used for local networks</td>
<td>network_vlan_ranges=vlan:1:4095</td>
<td>(StrOpt) N1K Network VLAN Ranges</td>
</tr>
<tr>
<td>network_vlan_ranges=</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt;</td>
</tr>
<tr>
<td>physical_network_vswitch_mappings=</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;vswitch&gt; where the physical networks can be expressed with wildcards, e.g.: ."*:external"</td>
</tr>
<tr>
<td>polling_interval=2</td>
<td>(IntOpt) The number of seconds the agent will wait between polling for local device changes.</td>
</tr>
<tr>
<td>tenant_network_type=local</td>
<td>(StrOpt) Network type for tenant networks (local, flat, vlan or none)</td>
</tr>
<tr>
<td>tenant_network_type=local</td>
<td>(StrOpt) Network type for tenant networks (local, vlan, gre, vxlan, or none)</td>
</tr>
<tr>
<td>tenant_network_type=vlan</td>
<td>(StrOpt) Network type for tenant networks (local, ib, vlan, or none)</td>
</tr>
<tr>
<td>tenant_network_type=local</td>
<td>(StrOpt) N1K Tenant Network Type</td>
</tr>
<tr>
<td>tenant_network_type=local</td>
<td>(StrOpt) Network type for tenant networks (local, vlan, or none)</td>
</tr>
</tbody>
</table>
</para>

40
doc/common/tables/neutron-hyperv_agent.xml Normal file
View File

@ -0,0 +1,40 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for hyperv_agent</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<td>Configuration option=Default value</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td>enable_metrics_collection=False</td>
<td>(BoolOpt) Enables metrics collections for switch ports by using Hyper-V's metric APIs. Collected data can by retrieved by other apps and services, e.g.: Ceilometer. Requires Hyper-V / Windows Server 2012 and above</td>
</tr>
<tr>
<td>force_hyperv_utils_v1=False</td>
<td>(BoolOpt) Force V1 WMI utility classes</td>
</tr>
<tr>
<td>local_network_vswitch=private</td>
<td>(StrOpt) Private vswitch name used for local networks</td>
</tr>
<tr>
<td>physical_network_vswitch_mappings=</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;vswitch&gt; where the physical networks can be expressed with wildcards, e.g.: ."*:external"</td>
</tr>
<tr>
<td>polling_interval=2</td>
<td>(IntOpt) The number of seconds the agent will wait between polling for local device changes.</td>
</tr>
</tbody>
</table>
</para>

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

@ -19,6 +19,30 @@
<td>loadbalancer_pool_scheduler_driver=neutron.services.loadbalancer.agent_scheduler.ChanceScheduler</td>
<td>(StrOpt) Driver to use for scheduling pool to a default loadbalancer agent</td>
</tr>
<tr>
<td>service_compression_throughput=100</td>
<td>(IntOpt) service compression throughtput</td>
</tr>
<tr>
<td>service_cache=20</td>
<td>(IntOpt) service cache</td>
</tr>
<tr>
<td>service_ha_pair=False</td>
<td>(BoolOpt) service HA pair</td>
</tr>
<tr>
<td>service_throughput=1000</td>
<td>(IntOpt) service throughtput</td>
</tr>
<tr>
<td>service_ssl_throughput=100</td>
<td>(IntOpt) service ssl throughtput</td>
</tr>
<tr>
<td>vdirect_address=None</td>
<td>(StrOpt) vdirect server IP address</td>
</tr>
</tbody>
</table>
</para>

8
doc/common/tables/neutron-linuxbridge.xml
View File

@ -37,7 +37,7 @@
</tr>
<tr>
<td>tenant_network_type=local</td>
<td>(StrOpt) Network type for tenant networks (local, vlan, gre, vxlan, or none)</td>
<td>(StrOpt) Network type for tenant networks (local, vlan, or none)</td>
</tr>
<tr>
<td>tenant_network_type=vlan</td>
@ -49,7 +49,7 @@
</tr>
<tr>
<td>tenant_network_type=local</td>
<td>(StrOpt) Network type for tenant networks (local, vlan, or none)</td>
<td>(StrOpt) Network type for tenant networks (local, vlan, gre, vxlan, or none)</td>
</tr>
<tr>
<td>tos=None</td>
@ -63,6 +63,10 @@
<td>vxlan_group=224.0.0.1</td>
<td>(StrOpt) Multicast group for vxlan interface.</td>
</tr>
<tr>
<td>vxlan_group=None</td>
<td>(StrOpt) Multicast group for VXLAN. If unset, disables VXLAN multicast mode.</td>
</tr>
</tbody>
</table>
</para>

56
doc/common/tables/neutron-linuxbridge_agent.xml Normal file
View File

@ -0,0 +1,56 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for linuxbridge_agent</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<td>Configuration option=Default value</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td>enable_vxlan=False</td>
<td>(BoolOpt) Enable VXLAN on the agent. Can be enabled when agent is managed by ml2 plugin using linuxbridge mechanism driver</td>
</tr>
<tr>
<td>l2_population=False</td>
<td>(BoolOpt) Extension to use alongside ml2 plugin's l2population mechanism driver. It enables the plugin to populate VXLAN forwarding table.</td>
</tr>
<tr>
<td>l2_population=False</td>
<td>(BoolOpt) Use ml2 l2population mechanism driver to learn remote mac and IPs and improve tunnel scalability</td>
</tr>
<tr>
<td>physical_interface_mappings=</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;physical_interface&gt;</td>
</tr>
<tr>
<td>physical_interface_mappings=</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;physical_interface&gt;</td>
</tr>
<tr>
<td>tos=None</td>
<td>(IntOpt) TOS for vxlan interface protocol packets.</td>
</tr>
<tr>
<td>ttl=None</td>
<td>(IntOpt) TTL for vxlan interface protocol packets.</td>
</tr>
<tr>
<td>vxlan_group=224.0.0.1</td>
<td>(StrOpt) Multicast group for vxlan interface.</td>
</tr>
<tr>
<td>vxlan_group=None</td>
<td>(StrOpt) Multicast group for VXLAN. If unset, disables VXLAN multicast mode.</td>
</tr>
</tbody>
</table>
</para>

2
doc/common/tables/neutron-midonet.xml
View File

@ -27,7 +27,7 @@
<td>mode=dev</td>
<td>(StrOpt) Operational mode. Internal dev use only.</td>
</tr>
<tr>
<tr>
<td>password=passw0rd</td>
<td>(StrOpt) MidoNet admin password.</td>
</tr>

54
doc/common/tables/neutron-ml2.xml
View File

@ -15,70 +15,18 @@
</tr>
</thead>
<tbody>
<tr>
<td>agent_boot_time=180</td>
<td>(IntOpt) Delay within which agent is expected to update existing ports whent it restarts</td>
</tr>
<tr>
<td>eapi_host=</td>
<td>(StrOpt) Arista EOS IP address. This is required field.If not set, all communications to Arista EOSwill fail</td>
</tr>
<tr>
<td>eapi_password=</td>
<td>(StrOpt) Password for Arista EOS. This is required field.if not set, all communications to Arista EOSwill fail</td>
</tr>
<tr>
<td>eapi_username=</td>
<td>(StrOpt) Username for Arista EOS. This is required field.if not set, all communications to Arista EOSwill fail</td>
</tr>
<tr>
<td>flat_networks=</td>
<td>(ListOpt) List of physical_network names with which flat networks can be created. Use * to allow flat networks with arbitrary physical_network names.</td>
</tr>
<tr>
<td>mechanism_drivers=</td>
<td>(ListOpt) An ordered list of networking mechanism driver entrypoints to be loaded from the neutron.ml2.mechanism_drivers namespace.</td>
</tr>
<tr>
<td>region_name=RegionOne</td>
<td>(StrOpt) Defines Region Name that is assigned to this OpenStackController. This is useful when multipleOpenStack/Neutron controllers are managing the sameArista HW clusters. Note that this name must match withthe region name registered (or known) to keystoneservice. Authentication with Keysotne is performed byEOS. This is optional. If not set, a value of"RegionOne" is assumed</td>
</tr>
<tr>
<td>req_timeout=30</td>
<td>(IntOpt) Total time limit for a cluster request</td>
</tr>
<tr>
<td>sync_interval=180</td>
<td>(IntOpt) Sync interval in seconds between Neutron plugin andEOS. This interval defines how often thesynchronization is performed. This is an optionalfield. If not set, a value of 180 seconds is assumed</td>
</tr>
<tr>
<td>tenant_network_types=local</td>
<td>(ListOpt) Ordered list of network_types to allocate as tenant networks.</td>
</tr>
<tr>
<td>timeout=10</td>
<td>(IntOpt) HTTP timeout in seconds.</td>
</tr>
<tr>
<td>type_drivers=local,flat,vlan,gre,vxlan</td>
<td>(ListOpt) List of network type driver entrypoints to be loaded from the neutron.ml2.type_drivers namespace.</td>
</tr>
<tr>
<td>url=None</td>
<td>(StrOpt) HTTP URL of Tail-f NCS REST interface.</td>
</tr>
<tr>
<td>use_fqdn=True</td>
<td>(BoolOpt) Defines if hostnames are sent to Arista EOS as FQDNs("node1.domain.com") or as short names ("node1").This is optional. If not set, a value of "True"is assumed.</td>
</tr>
<tr>
<td>vni_ranges=</td>
<td>(ListOpt) Comma-separated list of &lt;vni_min&gt;:&lt;vni_max&gt; tuples enumerating ranges of VXLAN VNI IDs that are available for tenant network allocation</td>
</tr>
<tr>
<td>vxlan_group=224.0.0.1</td>
<td>(StrOpt) Multicast group for vxlan interface.</td>
</tr>
</tbody>
</table>
</para>
</para>

44
doc/common/tables/neutron-ml2_arista.xml Normal file
View File

@ -0,0 +1,44 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for ml2_arista</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<td>Configuration option=Default value</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td>eapi_host=</td>
<td>(StrOpt) Arista EOS IP address. This is required field.If not set, all communications to Arista EOSwill fail</td>
</tr>
<tr>
<td>eapi_password=</td>
<td>(StrOpt) Password for Arista EOS. This is required field.if not set, all communications to Arista EOSwill fail</td>
</tr>
<tr>
<td>eapi_username=</td>
<td>(StrOpt) Username for Arista EOS. This is required field.if not set, all communications to Arista EOSwill fail</td>
</tr>
<tr>
<td>region_name=RegionOne</td>
<td>(StrOpt) Defines Region Name that is assigned to this OpenStackController. This is useful when multipleOpenStack/Neutron controllers are managing the sameArista HW clusters. Note that this name must match withthe region name registered (or known) to keystoneservice. Authentication with Keysotne is performed byEOS. This is optional. If not set, a value of"RegionOne" is assumed</td>
</tr>
<tr>
<td>sync_interval=180</td>
<td>(IntOpt) Sync interval in seconds between Neutron plugin andEOS. This interval defines how often thesynchronization is performed. This is an optionalfield. If not set, a value of 180 seconds is assumed</td>
</tr>
<tr>
<td>use_fqdn=True</td>
<td>(BoolOpt) Defines if hostnames are sent to Arista EOS as FQDNs("node1.domain.com") or as short names ("node1").This is optional. If not set, a value of "True"is assumed.</td>
</tr>
</tbody>
</table>
</para>

24
doc/common/tables/neutron-ml2_cisco.xml Normal file
View File

@ -0,0 +1,24 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for ml2_cisco</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<td>Configuration option=Default value</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td>managed_physical_network=None</td>
<td>(StrOpt) The physical network managed by the switches.</td>
</tr>
</tbody>
</table>
</para>

24
doc/common/tables/neutron-ml2_flat.xml Normal file
View File

@ -0,0 +1,24 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for ml2_flat</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<td>Configuration option=Default value</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td>flat_networks=</td>
<td>(ListOpt) List of physical_network names with which flat networks can be created. Use * to allow flat networks with arbitrary physical_network names.</td>
</tr>
</tbody>
</table>
</para>

24
doc/common/tables/neutron-ml2_l2pop.xml Normal file
View File

@ -0,0 +1,24 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for ml2_l2pop</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<td>Configuration option=Default value</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td>agent_boot_time=180</td>
<td>(IntOpt) Delay within which agent is expected to update existing ports whent it restarts</td>
</tr>
</tbody>
</table>
</para>

28
doc/common/tables/neutron-ml2_ncs.xml Normal file
View File

@ -0,0 +1,28 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for ml2_ncs</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<td>Configuration option=Default value</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td>timeout=10</td>
<td>(IntOpt) HTTP timeout in seconds.</td>
</tr>
<tr>
<td>url=None</td>
<td>(StrOpt) HTTP URL of Tail-f NCS REST interface.</td>
</tr>
</tbody>
</table>
</para>

32
doc/common/tables/neutron-ml2_vxlan.xml Normal file
View File

@ -0,0 +1,32 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for ml2_vxlan</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<td>Configuration option=Default value</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td>vni_ranges=</td>
<td>(ListOpt) Comma-separated list of &lt;vni_min&gt;:&lt;vni_max&gt; tuples enumerating ranges of VXLAN VNI IDs that are available for tenant network allocation</td>
</tr>
<tr>
<td>vxlan_group=224.0.0.1</td>
<td>(StrOpt) Multicast group for vxlan interface.</td>
</tr>
<tr>
<td>vxlan_group=None</td>
<td>(StrOpt) Multicast group for VXLAN. If unset, disables VXLAN multicast mode.</td>
</tr>
</tbody>
</table>
</para>

8
doc/common/tables/neutron-nec.xml
View File

@ -32,9 +32,13 @@
<td>(BoolOpt) Enable packet filter</td>
</tr>
<tr>
<td>host=autodoc</td>
<td>host=docwork</td>
<td>(StrOpt) The hostname Neutron is running on</td>
</tr>
<tr>
<td>port=6379</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
<tr>
<td>port=8888</td>
<td>(StrOpt) Port to connect to</td>
@ -45,7 +49,7 @@
</tr>
<tr>
<td>use_ssl=False</td>
<td>(BoolOpt) Use SSL to connect</td>
<td>(BoolOpt) Enable SSL on the API server</td>
</tr>
</tbody>
</table>

18
doc/common/tables/neutron-nicira.xml
View File

@ -20,8 +20,12 @@
<td>(StrOpt) The mode used to implement DHCP/metadata services.</td>
</tr>
<tr>
<td>concurrent_connections=5</td>
<td>(IntOpt) Maximum concurrent connections</td>
<td>always_read_status=False</td>
<td>(BoolOpt) Always read operational status from backend on show operations. Enabling this option might slow down the system.</td>
</tr>
<tr>
<td>concurrent_connections=10</td>
<td>(IntOpt) Maximum concurrent connections to each NVP controller.</td>
</tr>
<tr>
<td>datacenter_moid=None</td>
@ -68,12 +72,12 @@
<td>(StrOpt) uri for vsm</td>
</tr>
<tr>
<td>max_lp_per_bridged_ls=64</td>
<td>(IntOpt) Maximum number of ports of a logical switch on a bridged transport zone (default 64)</td>
<td>max_lp_per_bridged_ls=5000</td>
<td>(IntOpt) Maximum number of ports of a logical switch on a bridged transport zone (default 5000)</td>
</tr>
<tr>
<td>max_lp_per_overlay_ls=256</td>
<td>(IntOpt) Maximum number of ports of a logical switch on an overlay transport zone (default 64)</td>
<td>(IntOpt) Maximum number of ports of a logical switch on an overlay transport zone (default 256)</td>
</tr>
<tr>
<td>max_random_sync_delay=0</td>
@ -115,6 +119,10 @@
<td>redirects=2</td>
<td>(IntOpt) Number of times a redirect should be followed</td>
</tr>
<tr>
<td>req_timeout=30</td>
<td>(IntOpt) Total time limit for a cluster request</td>
</tr>
<tr>
<td>resource_pool_id=default</td>
<td>(StrOpt) Shared resource pool id</td>

60
doc/common/tables/neutron-openvswitch.xml
View File

@ -15,70 +15,10 @@
</tr>
</thead>
<tbody>
<tr>
<td>bridge_mappings=</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;bridge&gt;</td>
</tr>
<tr>
<td>bridge_mappings=</td>
<td>(StrOpt) N1K Bridge Mappings</td>
</tr>
<tr>
<td>enable_tunneling=False</td>
<td>(BoolOpt) Enable tunneling support</td>
</tr>
<tr>
<td>int_peer_patch_port=patch-tun</td>
<td>(StrOpt) Peer patch port in integration bridge for tunnel bridge</td>
</tr>
<tr>
<td>integration_bridge=br-int</td>
<td>(StrOpt) Integration bridge to use</td>
</tr>
<tr>
<td>integration_bridge=br-int</td>
<td>(StrOpt) N1K Integration Bridge</td>
</tr>
<tr>
<td>l2_population=False</td>
<td>(BoolOpt) Use ml2 l2population mechanism driver to learn remote mac and IPs and improve tunnel scalability</td>
</tr>
<tr>
<td>local_ip=</td>
<td>(StrOpt) Local IP address of GRE tunnel endpoints.</td>
</tr>
<tr>
<td>local_ip=</td>
<td>(StrOpt) Local IP address of the VXLAN endpoints.</td>
</tr>
<tr>
<td>network_vlan_ranges=</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt;</td>
</tr>
<tr>
<td>tenant_network_type=local</td>
<td>(StrOpt) Network type for tenant networks (local, vlan, gre, vxlan, or none)</td>
</tr>
<tr>
<td>tun_peer_patch_port=patch-int</td>
<td>(StrOpt) Peer patch port in tunnel bridge for integration bridge</td>
</tr>
<tr>
<td>tunnel_bridge=br-tun</td>
<td>(StrOpt) Tunnel bridge to use</td>
</tr>
<tr>
<td>tunnel_id_ranges=</td>
<td>(ListOpt) Comma-separated list of &lt;tun_min&gt;:&lt;tun_max&gt; tuples enumerating ranges of GRE tunnel IDs that are available for tenant network allocation</td>
</tr>
<tr>
<td>veth_mtu=None</td>
<td>(IntOpt) MTU size of veth interfaces</td>
</tr>
<tr>
<td>vxlan_udp_port=4789</td>
<td>(IntOpt) The UDP port to use for VXLAN tunnels.</td>
</tr>
</tbody>
</table>
</para>

104
doc/common/tables/neutron-openvswitch_agent.xml Normal file
View File

@ -0,0 +1,104 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for openvswitch_agent</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<td>Configuration option=Default value</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td>bridge_mappings=</td>
<td>(StrOpt) N1K Bridge Mappings</td>
</tr>
<tr>
<td>bridge_mappings=</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;bridge&gt;</td>
</tr>
<tr>
<td>enable_tunneling=True</td>
<td>(BoolOpt) N1K Enable Tunneling</td>
</tr>
<tr>
<td>enable_tunneling=False</td>
<td>(BoolOpt) Enable tunneling support</td>
</tr>
<tr>
<td>int_peer_patch_port=patch-tun</td>
<td>(StrOpt) Peer patch port in integration bridge for tunnel bridge</td>
</tr>
<tr>
<td>integration_bridge=br-int</td>
<td>(StrOpt) N1K Integration Bridge</td>
</tr>
<tr>
<td>integration_bridge=br-int</td>
<td>(StrOpt) Integration bridge to use</td>
</tr>
<tr>
<td>l2_population=False</td>
<td>(BoolOpt) Extension to use alongside ml2 plugin's l2population mechanism driver. It enables the plugin to populate VXLAN forwarding table.</td>
</tr>
<tr>
<td>l2_population=False</td>
<td>(BoolOpt) Use ml2 l2population mechanism driver to learn remote mac and IPs and improve tunnel scalability</td>
</tr>
<tr>
<td>local_ip=10.0.0.3</td>
<td>(StrOpt) N1K Local IP</td>
</tr>
<tr>
<td>local_ip=</td>
<td>(StrOpt) Local IP address of the VXLAN endpoints.</td>
</tr>
<tr>
<td>local_ip=</td>
<td>(StrOpt) Local IP address of GRE tunnel endpoints.</td>
</tr>
<tr>
<td>tun_peer_patch_port=patch-int</td>
<td>(StrOpt) Peer patch port in tunnel bridge for integration bridge</td>
</tr>
<tr>
<td>tunnel_bridge=br-tun</td>
<td>(StrOpt) N1K Tunnel Bridge</td>
</tr>
<tr>
<td>tunnel_bridge=br-tun</td>
<td>(StrOpt) Tunnel bridge to use</td>
</tr>
<tr>
<td>tunnel_id_ranges=</td>
<td>(ListOpt) List of &lt;tun_min&gt;:&lt;tun_max&gt;</td>
</tr>
<tr>
<td>tunnel_id_ranges=</td>
<td>(ListOpt) Comma-separated list of &lt;tun_min&gt;:&lt;tun_max&gt; tuples enumerating ranges of GRE tunnel IDs that are available for tenant network allocation</td>
</tr>
<tr>
<td>tunnel_type=</td>
<td>(StrOpt) The type of tunnels to use when utilizing tunnels, either 'gre' or 'vxlan'</td>
</tr>
<tr>
<td>tunnel_types=</td>
<td>(ListOpt) Network types supported by the agent (gre and/or vxlan)</td>
</tr>
<tr>
<td>veth_mtu=None</td>
<td>(IntOpt) MTU size of veth interfaces</td>
</tr>
<tr>
<td>vxlan_udp_port=4789</td>
<td>(IntOpt) The UDP port to use for VXLAN tunnels.</td>
</tr>
</tbody>
</table>
</para>

16
doc/common/tables/neutron-plumgrid.xml
View File

@ -15,14 +15,6 @@
</tr>
</thead>
<tbody>
<tr>
<td>director=localhost</td>
<td>(StrOpt) vArmour director ip</td>
</tr>
<tr>
<td>director_port=443</td>
<td>(StrOpt) vArmour director port</td>
</tr>
<tr>
<td>director_server=localhost</td>
<td>(StrOpt) PLUMgrid Director server to connect to</td>
@ -31,18 +23,10 @@
<td>director_server_port=8080</td>
<td>(StrOpt) PLUMgrid Director server port to connect to</td>
</tr>
<tr>
<td>password=varmour</td>
<td>(StrOpt) vArmour director password</td>
</tr>
<tr>
<td>password=</td>
<td>(StrOpt) The SSH password to use</td>
</tr>
<tr>
<td>password=password</td>
<td>(StrOpt) PLUMgrid Director admin password</td>
</tr>
<tr>
<td>servertimeout=5</td>
<td>(IntOpt) PLUMgrid Director server timeout</td>

2
doc/common/tables/neutron-quotas.xml
View File

@ -24,7 +24,7 @@
<td>(IntOpt) Maximum number of routes</td>
</tr>
<tr>
<td>quota_driver=neutron.quota.ConfDriver</td>
<td>quota_driver=neutron.db.quota_db.DbQuotaDriver</td>
<td>(StrOpt) Default driver to use for quota checks</td>
</tr>
<tr>

4
doc/common/tables/neutron-rpc.xml
View File

@ -28,7 +28,7 @@
<td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</td>
</tr>
<tr>
<td>host=autodoc</td>
<td>host=[hostname]</td>
<td>(StrOpt) The hostname Neutron is running on</td>
</tr>
<tr>
@ -68,7 +68,7 @@
<td>(IntOpt) Seconds to wait for a response from call or multicall</td>
</tr>
<tr>
<td>rpc_support_old_agents=True</td>
<td>rpc_support_old_agents=False</td>
<td>(BoolOpt) Enable server RPC compatibility with old agents</td>
</tr>
<tr>

36
doc/common/tables/neutron-varmour.xml Normal file
View File

@ -0,0 +1,36 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for varmour</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<td>Configuration option=Default value</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td>director_port=443</td>
<td>(StrOpt) vArmour director port</td>
</tr>
<tr>
<td>director=localhost</td>
<td>(StrOpt) vArmour director ip</td>
</tr>
<tr>
<td>password=varmour</td>
<td>(StrOpt) vArmour director password</td>
</tr>
<tr>
<td>username=varmour</td>
<td>(StrOpt) vArmour director username</td>
</tr>
</tbody>
</table>
</para>

2
doc/common/tables/neutron-vpn.xml
View File

@ -37,4 +37,4 @@
</tr>
</tbody>
</table>
</para>
</para>

4
doc/common/tables/neutron-zeromq.xml
View File

@ -24,7 +24,7 @@
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1</td>
</tr>
<tr>
<td>rpc_zmq_host=autodoc</td>
<td>rpc_zmq_host=[hostname]</td>
<td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
</tr>
<tr>
@ -45,4 +45,4 @@
</tr>
</tbody>
</table>
</para>
</para>

39
doc/config-reference/networking/section_networking-plugins-ml2.xml Normal file
View File

@ -0,0 +1,39 @@
<?xml version= "1.0" encoding= "UTF-8"?>
<section xml:id="networking-options-plugins-ml2"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:ns5="http://www.w3.org/1999/xhtml"
xmlns:ns4="http://www.w3.org/2000/svg"
xmlns:ns3="http://www.w3.org/1998/Math/MathML"
xmlns:ns="http://docbook.org/ns/docbook"
version="5.0">
<title>Modular Layer 2 (ml2) Configuration Options</title>
<para>Lorem Ipsum</para>
<xi:include href="../../common/tables/neutron-ml2.xml"/>
<section xml:id="networking-plugin-ml2_flat">
<title>Modular Layer 2 (ml2) Flat Type Configuration Options</title>
<xi:include href="../../common/tables/neutron-ml2_flat.xml"/>
</section>
<section xml:id="networking-plugin-ml2_vxlan">
<title>Modular Layer 2 (ml2) VXLAN Type Configuration Options</title>
<xi:include href="../../common/tables/neutron-ml2_vxlan.xml"/>
</section>
<section xml:id="networking-plugin-ml2_arista">
<title>Modular Layer 2 (ml2) Arista Mechanism Configuration Options</title>
<xi:include href="../../common/tables/neutron-ml2_arista.xml"/>
</section>
<section xml:id="networking-plugin-ml2_cisco">
<title>Modular Layer 2 (ml2) Cisco Mechanism Configuration Options</title>
<xi:include href="../../common/tables/neutron-ml2_cisco.xml"/>
</section>
<section xml:id="networking-plugin-ml2_l2pop">
<title>Modular Layer 2 (ml2) L2 Population Mechanism Configuration Options</title>
<xi:include href="../../common/tables/neutron-ml2_l2pop.xml"/>
</section>
<section xml:id="networking-plugin-ml2_ncs">
<title>Modular Layer 2 (ml2) Tail-f NCS Mechanism Configuration Options</title>
<xi:include href="../../common/tables/neutron-ml2_ncs.xml"/>
</section>
</section>

23
doc/config-reference/networking/section_networking-plugins.xml
View File

@ -28,13 +28,21 @@
<xi:include href="../../common/tables/neutron-cisco.xml"/>
</section>
<section xml:id="networking-plugin-hyperv">
<title>CloudBase Hyper-V configuration options</title>
<title>CloudBase Hyper-V Plugin configuration options (deprecated)</title>
<xi:include href="../../common/tables/neutron-hyperv.xml"/>
</section>
<section xml:id="networking-plugin-hyperv_agent">
<title>CloudBase Hyper-V Agent configuration options</title>
<xi:include href="../../common/tables/neutron-hyperv_agent.xml"/>
</section>
<section xml:id="networking-plugin-linuxbridge">
<title>Linux Bridge configuration options</title>
<title>Linux bridge Plugin configuration options (deprecated)</title>
<xi:include href="../../common/tables/neutron-linuxbridge.xml"/>
</section>
<section xml:id="networking-plugin-linuxbridge_agent">
<title>Linux bridge Agent configuration options</title>
<xi:include href="../../common/tables/neutron-linuxbridge_agent.xml"/>
</section>
<section xml:id="networking-plugin-mlnx">
<title>Mellanox Configuration Options</title>
<xi:include href="../../common/tables/neutron-mlnx.xml"/>
@ -44,10 +52,7 @@
<para>The Meta Plugin allows you to use multiple plugins at the same time.</para>
<xi:include href="../../common/tables/neutron-meta.xml"/>
</section>
<section xml:id="networking-plugin-ml2">
<title>Modular Layer 2 (ml2) Configuration Options</title>
<xi:include href="../../common/tables/neutron-ml2.xml"/>
</section>
<xi:include href="section_networking-plugins-ml2.xml"/>
<section xml:id="networking-plugin-midonet">
<title>MidoNet configuration options</title>
<xi:include href="../../common/tables/neutron-midonet.xml"/>
@ -61,9 +66,13 @@
<xi:include href="../../common/tables/neutron-nicira.xml"/>
</section>
<section xml:id="networking-plugin-openvswitch">
<title>Open vSwitch configuration options</title>
<title>Open vSwitch Plugin configuration options (deprecated)</title>
<xi:include href="../../common/tables/neutron-openvswitch.xml"/>
</section>
<section xml:id="networking-plugin-openvswitch_agent">
<title>Open vSwitch Agent configuration options</title>
<xi:include href="../../common/tables/neutron-openvswitch_agent.xml"/>
</section>
<section xml:id="networking-plugin-plumgrid">
<title>PLUMgrid configuration options</title>
<xi:include href="../../common/tables/neutron-plumgrid.xml"/>

120
tools/autogenerate-config-docs/flagmappings/neutron.flagmappings
View File

@ -4,14 +4,15 @@ admin_password common
admin_tenant_name common
admin_user common
admin_username embrane
agent_boot_time ml2
agent_boot_time ml2_l2pop
agent_down_time agent
agent_mode nicira
allow_bulk api
allowed_rpc_exception_modules common
allow_overlapping_ips policy
allow_pagination api
allow_sorting api
allowed_rpc_exception_modules common
always_read_status nicira
amqp_auto_delete rpc
amqp_durable_queues rpc
api_extensions_path api
@ -27,7 +28,7 @@ backlog wsgi
base_mac common
bind_host common
bind_port common
bridge_mappings openvswitch
bridge_mappings openvswitch_agent
cert_file nec
concurrent_connections nicira
config_base_dir vpn
@ -58,21 +59,21 @@ deployment_container_id nicira
dhcp_agent_notification common
dhcp_agents_per_network db
dhcp_lease_duration common
director plumgrid
director_port plumgrid
director varmour
director_port varmour
director_server plumgrid
director_server_port plumgrid
disable_process_locking common
driver nec
dummy_utif_id embrane
eapi_host ml2
eapi_password ml2
eapi_username ml2
enable_metrics_collection hyperv
enable_packet_filter nec
enable_tunneling openvswitch
enable_vxlan linuxbridge
eapi_host ml2_arista
eapi_password ml2_arista
eapi_username ml2_arista
enabled fwaas
enable_metrics_collection hyperv_agent
enable_packet_filter nec
enable_tunneling openvswitch_agent
enable_vxlan linuxbridge_agent
esm_mgmt embrane
extension_map meta
external_network nicira
@ -80,9 +81,9 @@ external_pids agent
fake_rabbit testing
fatal_deprecations logging
firewall_driver securitygroups
flat_networks ml2
flat_networks ml2_flat
force_gateway_on_subnet common
force_hyperv_utils_v1 hyperv
force_hyperv_utils_v1 hyperv_agent
host cisco
host common
host nec
@ -92,8 +93,9 @@ idle_timeout db
inband_id embrane
instance_format logging
instance_uuid_format logging
int_peer_patch_port openvswitch
integration_bridge openvswitch
integration_bridge openvswitch_agent
interface_driver agent
int_peer_patch_port openvswitch_agent
ipsec_config_template vpn
ipsec_secret_template vpn
ipsec_status_check_interval vpn
@ -102,12 +104,12 @@ kombu_ssl_ca_certs kombu
kombu_ssl_certfile kombu
kombu_ssl_keyfile kombu
kombu_ssl_version kombu
l2_population linuxbridge
l2_population openvswitch
l2_population linuxbridge_agent
l2_population openvswitch_agent
l3_plugin_list meta
loadbalancer_pool_scheduler_driver lbaas
local_ip openvswitch
local_network_vswitch hyperv
local_ip openvswitch_agent
local_network_vswitch hyperv_agent
lock_path common
log_config logging
log_date_format logging
@ -119,6 +121,7 @@ logging_debug_format_suffix logging
logging_default_format_string logging
logging_exception_prefix logging
mac_generation_retries common
managed_physical_network ml2_cisco
manager_uri nicira
matchmaker_heartbeat_freq rpc
matchmaker_heartbeat_ttl rpc
@ -134,17 +137,16 @@ max_router_rules bigswitch
max_routes quotas
max_subnet_host_routes common
mechanism_drivers ml2
meta_flavor_driver_mappings common
metadata_mode nicira
metadata_proxy_socket metadata
meta_flavor_driver_mappings common
mgmt_id embrane
midonet_host_uuid_path midonet
midonet_uri midonet
min_chunk_size nicira
min_pool_size db
min_sync_req_delay nicira
mode midonet
model_class cisco
mode midonet
network_auto_schedule scheduler
network_device_mtu common
network_node_policy_profile cisco
@ -174,25 +176,26 @@ nvp_user nicira
oob_id embrane
openflow_rest_api ryu
ostype brocade
ovs_integration_bridge common
ovs_use_veth common
ovsdb_interface ryu
ovsdb_ip ryu
ovsdb_port ryu
ovs_integration_bridge common
ovs_use_veth common
pagination_max_limit api
password brocade
password midonet
password plumgrid
password rpc
password varmour
periodic_fuzzy_delay common
periodic_interval common
physical_interface brocade
physical_interface_mappings linuxbridge
physical_network_vswitch_mappings hyperv
physical_interface_mappings linuxbridge_agent
physical_network_vswitch_mappings hyperv_agent
plugin_list meta
policy_file policy
poll_duration cisco
polling_interval hyperv
polling_interval hyperv_agent
pool_timeout db
port nec
port rpc
@ -213,13 +216,13 @@ qpid_tcp_nodelay qpid
qpid_topology_version qpid
qpid_username qpid
quota_driver quotas
quota_firewall quotas
quota_firewall_policy quotas
quota_firewall quotas
quota_firewall_rule quotas
quota_floatingip quotas
quota_items quotas
quota_network quotas
quota_network_gateway quotas
quota_network quotas
quota_packet_filter quotas
quota_port quotas
quota_router quotas
@ -234,13 +237,13 @@ rabbit_password rabbitmq
rabbit_port rabbitmq
rabbit_retry_backoff rabbitmq
rabbit_retry_interval rabbitmq
rabbit_use_ssl rabbitmq
rabbit_userid rabbitmq
rabbit_use_ssl rabbitmq
rabbit_virtual_host rabbitmq
redirects nicira
region_name ml2
region_name ml2_arista
report_interval agent
req_timeout ml2
req_timeout nicira
request_timeout mlnx
resource_pool_id embrane
resource_pool_id nicira
@ -268,12 +271,17 @@ rpc_zmq_port zeromq
rpc_zmq_topic_backlog zeromq
run_external_periodic_tasks api
server_auth bigswitch
servers bigswitch
server_ssl bigswitch
server_timeout bigswitch
servers bigswitch
servertimeout plumgrid
service_cache lbaas
service_compression_throughput lbaas
service_ha_pair lbaas
service_plugins api
service_provider api
service_ssl_throughput lbaas
service_throughput lbaas
slave_connection db
sqlite_db db
sqlite_synchronous db
@ -285,50 +293,52 @@ state_sync_interval nicira
supported_extension_aliases meta
svi_round_robin cisco
sync_data bigswitch
sync_interval ml2
sync_interval ml2_arista
syslog_log_facility logging
task_status_check_interval nicira
tcp_keepidle wsgi
tenant_default_router_rule bigswitch
tenant_network_type hyperv
tenant_network_type linuxbridge
tenant_network_type openvswitch
tenant_network_type openvswitch_agent
tenant_network_types ml2
timeout ml2
timeout ml2_ncs
topics rpc
tos linuxbridge
ttl linuxbridge
tun_peer_patch_port openvswitch
tunnel_bridge openvswitch
tunnel_id_ranges openvswitch
tos linuxbridge_agent
ttl linuxbridge_agent
tunnel_bridge openvswitch_agent
tunnel_id_ranges openvswitch_agent
tunnel_interface ryu
tunnel_ip ryu
tunnel_key_max ryu
tunnel_key_min ryu
tunnel_type openvswitch
tunnel_types openvswitch
tunnel_type openvswitch_agent
tunnel_types openvswitch_agent
tun_peer_patch_port openvswitch_agent
type_drivers ml2
url ml2
use_fqdn ml2
url ml2_ncs
use_fqdn ml2_arista
use_namespaces agent
username brocade
username midonet
username plumgrid
user nicira
use_ssl nec
use_ssl ssl
use_stderr logging
use_syslog logging
use_tpool db
user nicira
username brocade
username midonet
username plumgrid
vdirect_address lbaas
verbose logging
veth_mtu openvswitch
veth_mtu openvswitch_agent
vif_type bigswitch
vif_types bigswitch
vlan_name_prefix cisco
vni_ranges ml2
vnic_type mlnx
vni_ranges ml2_vxlan
vpn_device_driver vpn
vswitch_plugin cisco
vxlan_group linuxbridge
vxlan_group ml2
vxlan_group linuxbridge_agent
vxlan_group ml2_vxlan
vxlan_id_ranges cisco
vxlan_udp_port openvswitch
vxlan_udp_port openvswitch_agent