Remove ryu plugin
Ryu plugin was marked deprecated in Juno and will be removed for Kilo. Also, mention Ryu team's recommendation for ofagent in doc/config-reference/networking/section_networking-plugins.xml We (Ryu team) recommend users to migrate to ofagent, on which we aim to concentrate our development resources by this deprecation. Partial-Bug: #1391714 Change-Id: Ia11ce42f1cd3ad9d1ccc2e7bf2c2937d7ee5406e
This commit is contained in:
YAMAMOTO Takashi
parent
798ba650f7
commit
928815d897
@ -580,7 +580,7 @@
|
||||
<listitem>
|
||||
<para>To use the Compute security group API with Networking, the Networking
|
||||
plug-in must implement the security group API. The following plug-ins
|
||||
currently implement this: ML2, Open vSwitch, Linux Bridge, NEC, Ryu, and
|
||||
currently implement this: ML2, Open vSwitch, Linux Bridge, NEC, and
|
||||
VMware NSX.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
|
||||
@ -150,58 +150,6 @@
|
||||
</step>
|
||||
</procedure>
|
||||
</section>
|
||||
<section xml:id="install_neutron_agent_ryu">
|
||||
<title>Node set up: Ryu plug-in</title>
|
||||
<warning>
|
||||
<para>
|
||||
The Ryu plug-in is deprecated as of the Juno release and might be removed in Kilo
|
||||
or a subsequent release.
|
||||
</para>
|
||||
</warning>
|
||||
<para>If you use the Ryu plug-in, you must install Open vSwitch, Ryu, and the Ryu agent package.</para>
|
||||
<procedure>
|
||||
<title>To set up each node for the Ryu
|
||||
plug-in</title>
|
||||
<step>
|
||||
<para>Install Ryu:</para>
|
||||
<screen><prompt>#</prompt> <userinput>pip install ryu</userinput></screen>
|
||||
<para>Currently, no Ryu package exists for
|
||||
Ubuntu.</para>
|
||||
</step>
|
||||
<step>
|
||||
<para>Install the Ryu agent and Open vSwitch
|
||||
packages:</para>
|
||||
<screen><prompt>#</prompt> <userinput>apt-get install neutron-plugin-ryu-agent openvswitch-switch python-openvswitch openvswitch-datapath-dkms</userinput></screen>
|
||||
</step>
|
||||
<step>
|
||||
<para>Replicate the
|
||||
<filename>ovs_ryu_plugin.ini</filename>
|
||||
and <filename>neutron.conf</filename>
|
||||
files created in the above step on all
|
||||
nodes running
|
||||
<systemitem class="service">neutron-plugin-ryu-agent</systemitem>.</para>
|
||||
</step>
|
||||
<step>
|
||||
<para>Restart Open vSwitch to properly load
|
||||
the kernel module:</para>
|
||||
<screen><prompt>#</prompt> <userinput>service openvswitch-switch restart</userinput></screen>
|
||||
</step>
|
||||
<step>
|
||||
<para>Restart the agent:</para>
|
||||
<screen><prompt>#</prompt> <userinput>service neutron-plugin-ryu-agent restart</userinput> </screen>
|
||||
</step>
|
||||
<step>
|
||||
<para>All nodes that run
|
||||
<systemitem class="service">neutron-plugin-ryu-agent</systemitem>
|
||||
must also have an OVS bridge named
|
||||
<literal>br-int</literal> on each
|
||||
node.</para>
|
||||
<para>To create the bridge, run this
|
||||
command:</para>
|
||||
<screen><prompt>#</prompt> <userinput>ovs-vsctl add-br br-int</userinput></screen>
|
||||
</step>
|
||||
</procedure>
|
||||
</section>
|
||||
</section>
|
||||
<section xml:id="install_neutron_dhcp">
|
||||
<title>Configure DHCP agent</title>
|
||||
@ -267,15 +215,6 @@ interface_driver = neutron.agent.linux.interface.OVSInterfaceDriver</programlist
|
||||
enable_metadata_network = True
|
||||
enable_isolated_metadata = True
|
||||
use_namespaces = True
|
||||
interface_driver = neutron.agent.linux.interface.OVSInterfaceDriver</programlisting>
|
||||
</section>
|
||||
<section xml:id="dhcp_agent_ryu">
|
||||
<title>DHCP agent setup: Ryu plug-in</title>
|
||||
<para>These DHCP agent options are required in the
|
||||
<filename>/etc/neutron/dhcp_agent.ini</filename>
|
||||
file for the Ryu plug-in:</para>
|
||||
<programlisting language="bash">[DEFAULT]
|
||||
use_namespace = True
|
||||
interface_driver = neutron.agent.linux.interface.OVSInterfaceDriver</programlisting>
|
||||
</section>
|
||||
</section>
|
||||
@ -421,7 +360,7 @@ interface_driver = neutron.agent.linux.interface.OVSInterfaceDriver</programlist
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>An OVS-based plug-in such as OVS,
|
||||
NSX, Ryu, NEC,
|
||||
NSX, NEC,
|
||||
BigSwitch/Floodlight:</para>
|
||||
<programlisting language="ini">interface_driver = neutron.agent.linux.interface.OVSInterfaceDriver</programlisting>
|
||||
</listitem>
|
||||
@ -457,7 +396,7 @@ interface_driver = neutron.agent.linux.interface.OVSInterfaceDriver</programlist
|
||||
the Open vSwitch or Linux Bridge plug-in. The Open
|
||||
vSwitch LBaaS driver is required when enabling LBaaS
|
||||
for OVS-based plug-ins, including BigSwitch,
|
||||
Floodlight, NEC, NSX, and Ryu.</para>
|
||||
Floodlight, NEC, and NSX.</para>
|
||||
<procedure>
|
||||
<title>To configure LBaas with Open vSwitch or Linux
|
||||
Bridge plug-in</title>
|
||||
|
||||
@ -317,64 +317,4 @@ password = "PLUMgrid-director-admin-password"</programlisting>
|
||||
</step>
|
||||
</procedure>
|
||||
</section>
|
||||
<section xml:id="ryu_plugin">
|
||||
<title>Configure Ryu plug-in</title>
|
||||
<warning>
|
||||
<para>
|
||||
The Ryu plug-in is deprecated as of the Juno release and might be removed in Kilo or
|
||||
a subsequent release.
|
||||
</para>
|
||||
</warning>
|
||||
<procedure>
|
||||
<title>To use the Ryu plug-in with OpenStack Networking</title>
|
||||
<step>
|
||||
<para>Install the Ryu plug-in:</para>
|
||||
<screen><prompt>#</prompt> <userinput>apt-get install neutron-plugin-ryu</userinput> </screen>
|
||||
</step>
|
||||
<step>
|
||||
<para>Edit the <filename>/etc/neutron/neutron.conf</filename> file and set this
|
||||
line:</para>
|
||||
<programlisting language="ini">core_plugin = ryu</programlisting>
|
||||
</step>
|
||||
<step>
|
||||
<para>Edit the <filename>/etc/neutron/plugins/ryu/ryu.ini</filename> file and update
|
||||
these options in the <literal>[ovs]</literal> section for the <systemitem
|
||||
class="service">ryu-neutron-agent</systemitem>:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><option>openflow_rest_api</option>. Defines where Ryu is listening for
|
||||
REST API. Substitute <option>ip-address</option> and
|
||||
<option>port-no</option> based on your Ryu setup.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><option>ovsdb_interface</option>. Enables Ryu to access the
|
||||
<systemitem>ovsdb-server</systemitem>. Substitute
|
||||
<literal>eth0</literal> based on your setup. The IP address is
|
||||
derived from the interface name. If you want to change this value
|
||||
irrespective of the interface name, you can specify
|
||||
<option>ovsdb_ip</option>. If you use a non-default port for
|
||||
<systemitem>ovsdb-server</systemitem>, you can specify
|
||||
<option>ovsdb_port</option>.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><option>tunnel_interface</option>. Defines which IP address is used
|
||||
for tunneling. If you do not use tunneling, this value is ignored. The
|
||||
IP address is derived from the network interface name.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>For database configuration, see <link
|
||||
xlink:href="http://docs.openstack.org/icehouse/install-guide/install/apt/content/neutron-ml2-controller-node.html"
|
||||
>Install Networking Services</link> in <citetitle>Installation
|
||||
Guide</citetitle>.</para>
|
||||
<para>You can use the same configuration file for many compute nodes by using a
|
||||
network interface name with a different IP address:</para>
|
||||
<programlisting language="ini">openflow_rest_api = <replaceable>IP_ADDRESS</replaceable>:<replaceable>PORT</replaceable> ovsdb_interface = <replaceable>ETH0</replaceable> tunnel_interface = <replaceable>ETH0</replaceable></programlisting>
|
||||
</step>
|
||||
<step>
|
||||
<para>Restart the <systemitem class="service">neutron-server</systemitem> to apply
|
||||
the settings:</para>
|
||||
<screen><prompt>#</prompt> <userinput>service neutron-server restart</userinput></screen>
|
||||
</step>
|
||||
</procedure>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
@ -484,12 +484,6 @@ enabled = True</programlisting>
|
||||
xlink:href="https://wiki.openstack.org/wiki/PLUMgrid-Neutron"
|
||||
>https://https://wiki.openstack.org/wiki/PLUMgrid-Neutron</link></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><emphasis role="bold">Ryu</emphasis></td>
|
||||
<td>This guide and <link
|
||||
xlink:href="https://github.com/osrg/ryu/wiki/OpenStack"
|
||||
>https://github.com/osrg/ryu/wiki/OpenStack</link></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<!-- TODO: update support link, when available -->
|
||||
<td><emphasis role="bold">VMware NSX</emphasis></td>
|
||||
@ -638,14 +632,6 @@ enabled = True</programlisting>
|
||||
<td/>
|
||||
<td/>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Ryu</td>
|
||||
<td>Yes</td>
|
||||
<td/>
|
||||
<td/>
|
||||
<td/>
|
||||
<td/>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>VMware NSX</td>
|
||||
<td>Yes</td>
|
||||
|
||||
@ -24,8 +24,7 @@
|
||||
depending on the vendor and technologies used in the particular cloud.
|
||||
OpenStack Networking ships with plug-ins and agents for Cisco
|
||||
virtual and physical switches, NEC OpenFlow products, Open
|
||||
vSwitch, Linux bridging, Ryu Network Operating System, and
|
||||
the VMware NSX product.</para>
|
||||
vSwitch, Linux bridging, and the VMware NSX product.</para>
|
||||
<para>The common agents are L3 (layer 3), DHCP (dynamic host IP
|
||||
addressing), and a plug-in agent.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
@ -1,65 +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_ryu">
|
||||
<caption>Description of RYU 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>wsapi_host = </td>
|
||||
<td>(StrOpt) webapp listen host</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>wsapi_port = 8080</td>
|
||||
<td>(IntOpt) webapp listen port</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th colspan="2">[OVS]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>openflow_rest_api = 127.0.0.1:8080</td>
|
||||
<td>(StrOpt) OpenFlow REST API location.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ovsdb_interface = None</td>
|
||||
<td>(StrOpt) OVSDB interface to connect to.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ovsdb_ip = None</td>
|
||||
<td>(StrOpt) OVSDB IP to connect to.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ovsdb_port = 6634</td>
|
||||
<td>(IntOpt) OVSDB port to connect to.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>tunnel_interface = None</td>
|
||||
<td>(StrOpt) Tunnel interface to use.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>tunnel_ip = None</td>
|
||||
<td>(StrOpt) Tunnel IP to use.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>tunnel_key_max = 16777215</td>
|
||||
<td>(IntOpt) Maximum tunnel ID to use.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>tunnel_key_min = 1</td>
|
||||
<td>(IntOpt) Minimum tunnel ID to use.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</para>
|
||||
@ -15,6 +15,10 @@
|
||||
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>
|
||||
<section xml:id="networking-plugin-bigswitch">
|
||||
<title>BigSwitch configuration options</title>
|
||||
<xi:include
|
||||
@ -121,12 +125,6 @@
|
||||
href="../../common/tables/neutron-plumgrid.xml"
|
||||
/>
|
||||
</section>
|
||||
<section xml:id="networking-plugin-ryu">
|
||||
<title>Ryu configuration options</title>
|
||||
<xi:include
|
||||
href="../../common/tables/neutron-ryu.xml"
|
||||
/>
|
||||
</section>
|
||||
<section xml:id="networking-plugin-sriov">
|
||||
<title>SR-IOV configuration options</title>
|
||||
<xi:include
|
||||
|
||||
@ -7215,18 +7215,6 @@
|
||||
instance can send and receive.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry>
|
||||
<glossterm>Ryu neutron plug-in</glossterm>
|
||||
<indexterm class="singular">
|
||||
<primary>Ryu neutron plug-in</primary>
|
||||
</indexterm>
|
||||
|
||||
<glossdef>
|
||||
<para>Enables the Ryu network operating system to function as a
|
||||
Networking OpenFlow controller.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<!-- .S. -->
|
||||
|
||||
@ -582,7 +582,7 @@
|
||||
<listitem>
|
||||
<para>To use the Compute security group API with Networking, the Networking
|
||||
plug-in must implement the security group API. The following plug-ins
|
||||
currently implement this: ML2, Open vSwitch, Linux Bridge, NEC, Ryu, and
|
||||
currently implement this: ML2, Open vSwitch, Linux Bridge, NEC, and
|
||||
VMware NSX.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user