From 850fd7bff89fd1bc99aef50224cc4dfaf39a0eb8 Mon Sep 17 00:00:00 2001
From: darrenchan <dazzachan@yahoo.com.au>
Date: Thu, 18 Dec 2014 11:09:57 +1100
Subject: [PATCH] Removed mellanox plug-in content in the Configuration
Reference Guide and Cloud Administrator Guide
1. Removed mellanox plug-in content.
2. Added plug-in removal notices where appropriate.
Change-Id: I571ec09cb525876a561c5b931a3c88ff7f67d5de
backport: none
Closes-Bug: #1403206
---
.../section_networking_introduction.xml | 19 ++-----
doc/common/tables/neutron-ml2_mlnx.xml | 26 ---------
doc/common/tables/neutron-mlnx.xml | 57 -------------------
.../section_networking-plugins-ml2.xml | 5 --
.../networking/section_networking-plugins.xml | 22 +++----
5 files changed, 17 insertions(+), 112 deletions(-)
delete mode 100644 doc/common/tables/neutron-ml2_mlnx.xml
delete mode 100644 doc/common/tables/neutron-mlnx.xml
diff --git a/doc/admin-guide-cloud/networking/section_networking_introduction.xml b/doc/admin-guide-cloud/networking/section_networking_introduction.xml
index b88a55d3c1..5e01ecc388 100644
--- a/doc/admin-guide-cloud/networking/section_networking_introduction.xml
+++ b/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>
diff --git a/doc/common/tables/neutron-ml2_mlnx.xml b/doc/common/tables/neutron-ml2_mlnx.xml
deleted file mode 100644
index 39980b6811..0000000000
--- a/doc/common/tables/neutron-ml2_mlnx.xml
+++ /dev/null
@@ -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>
diff --git a/doc/common/tables/neutron-mlnx.xml b/doc/common/tables/neutron-mlnx.xml
deleted file mode 100644
index ae3ce4ff26..0000000000
--- a/doc/common/tables/neutron-mlnx.xml
+++ /dev/null
@@ -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 <physical_network>:<physical_interface></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 <physical_network>:<vlan_min>:<vlan_max> or <physical_network></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 <physical_network>:<physical_network_type> 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>
diff --git a/doc/config-reference/networking/section_networking-plugins-ml2.xml b/doc/config-reference/networking/section_networking-plugins-ml2.xml
index ac6e29d563..74a981aad1 100644
--- a/doc/config-reference/networking/section_networking-plugins-ml2.xml
+++ b/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>
diff --git a/doc/config-reference/networking/section_networking-plugins.xml b/doc/config-reference/networking/section_networking-plugins.xml
index 49b4b70bd1..272d92ebdb 100644
--- a/doc/config-reference/networking/section_networking-plugins.xml
+++ b/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