openstack/openstack-manuals
Code Issues Proposed changes

Removed mellanox plug-in content in the Configuration Reference Guide and Cloud Administrator Guide

Browse Source 
1. Removed mellanox plug-in content.
2. Added plug-in removal notices where appropriate.

Change-Id: I571ec09cb525876a561c5b931a3c88ff7f67d5de
backport: none
Closes-Bug: #1403206
This commit is contained in:
darrenchan 2014-12-18 11:09:57 +11:00
parent d05f50e6ef
commit 850fd7bff8
5 changed files with 17 additions and 112 deletions

19
doc/admin-guide-cloud/networking/section_networking_introduction.xml

@ -442,12 +442,6 @@ enabled = True</programlisting>
xlink:href="http://wiki.openstack.org/Neutron-Linux-Bridge-Plugin"
>http://wiki.openstack.org/Neutron-Linux-Bridge-Plugin</link></td>
</tr>
<tr>
<td><emphasis role="bold">Mellanox</emphasis></td>
<td><link
xlink:href="https://wiki.openstack.org/wiki/Mellanox-Neutron"
>https://wiki.openstack.org/wiki/Mellanox-Neutron/</link></td>
</tr>
<tr>
<td><emphasis role="bold">Midonet</emphasis></td>
<td><link xlink:href="http://www.midokura.com/"
@ -525,6 +519,11 @@ enabled = True</programlisting>
plug-ins are now part of the ML2 plug-in in the form
of mechanism drivers.</para>
</note>
<note>
<title>Plug-in removal notice</title>
<para>The Mellanox plug-in has been removed in the Kilo
release.</para>
</note>
<para>Not all Networking plug-ins are compatible with all
possible Compute drivers:</para>
<table rules="all">
@ -589,14 +588,6 @@ enabled = True</programlisting>
<td/>
<td/>
</tr>
<tr>
<td>Mellanox</td>
<td>Yes</td>
<td/>
<td/>
<td/>
<td/>
</tr>
<tr>
<td>Midonet</td>
<td>Yes</td>

26
doc/common/tables/neutron-ml2_mlnx.xml

@ -1,26 +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_ml2_mlnx">
<caption>Description of Mellanox ML2 mechanism driver 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">[ESWITCH]</th>
</tr>
<tr>
<td>vnic_type = mlnx_direct</td>
<td>(StrOpt) Type of VM network interface: mlnx_direct or hostdev</td>
</tr>
</tbody>
</table>
</para>

57
doc/common/tables/neutron-mlnx.xml

@ -1,57 +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_mlnx">
<caption>Description of Mellanox 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">[ESWITCH]</th>
</tr>
<tr>
<td>backoff_rate = 2</td>
<td>(IntOpt) backoff rate multiplier for waiting period between retries for request to daemon, i.e. value of 2 will double the request timeout each retry</td>
</tr>
<tr>
<td>daemon_endpoint = tcp://127.0.0.1:60001</td>
<td>(StrOpt) eswitch daemon end point</td>
</tr>
<tr>
<td>physical_interface_mappings = </td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;physical_interface&gt;</td>
</tr>
<tr>
<td>request_timeout = 3000</td>
<td>(IntOpt) The number of milliseconds the agent will wait for response on request to daemon.</td>
</tr>
<tr>
<th colspan="2">[MLNX]</th>
</tr>
<tr>
<td>network_vlan_ranges = default:1:1000</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_type = eth</td>
<td>(StrOpt) Physical network type for provider network (eth or ib)</td>
</tr>
<tr>
<td>physical_network_type_mappings = </td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;physical_network_type&gt; with physical_network_type is either eth or ib</td>
</tr>
<tr>
<td>tenant_network_type = vlan</td>
<td>(StrOpt) Network type for tenant networks (local, vlan, or none)</td>
</tr>
</tbody>
</table>
</para>

5
doc/config-reference/networking/section_networking-plugins-ml2.xml

@ -83,11 +83,6 @@
options</title>
<xi:include href="../../common/tables/neutron-ml2_fslsdn.xml"/>
</section>
<section xml:id="networking-plugin-ml2_mlnx">
<title>Modular Layer 2 (ml2) Mellanox Mechanism configuration
options</title>
<xi:include href="../../common/tables/neutron-ml2_mlnx.xml"/>
</section>
<section xml:id="networking-plugin-ml2_odl">
<title>Modular Layer 2 (ml2) OpenDaylight Mechanism configuration
options</title>

22
doc/config-reference/networking/section_networking-plugins.xml

@ -15,10 +15,18 @@
L2-in-L3 tunneling or OpenFlow. These sections
detail the configuration options for the various
plug-ins.</para>
<note><para>Ryu plugin has been removed in Kilo. Ryu team recommends
to migrate to ML2 plugin with ofagent mechanism driver.
However, it isn't a functionality equivalent.
No mechanical upgrade procedure is provided.</para></note>
<note><para>The following plugins have been removed in
Kilo:</para>
<itemizedlist>
<listitem><para>Ryu plugin. The Ryu team recommends
that you migrate to the ML2 plugin with ofagent
mechanism driver. However, note that the
functionality is not the same. There is no
upgrade procedure currently available.</para>
</listitem>
<listitem><para>Mellanox plugin.</para></listitem>
</itemizedlist>
</note>
<section xml:id="networking-plugin-bigswitch">
<title>BigSwitch configuration options</title>
<xi:include
@ -67,12 +75,6 @@
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"
/>
</section>
<section xml:id="networking-plugin-meta">
<title>Meta Plug-in configuration options</title>
<para>The Meta Plug-in allows you to use multiple