openstack-attic/netconn-api
Code Issues Proposed changes

Clarify language in remove router interface extension

Browse Source 
Change-Id: I1d99106f2024207ff73c10458703f80a056a6608
author: diane fleming
This commit is contained in:
Diane Fleming 2014-02-10 12:47:28 -06:00
parent 1886494bae
commit 48f4b2a946
1 changed files with 52 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
v2.0/section_neutron-l3-ext.xml
View File

@ -30,12 +30,13 @@
<section xml:id="router_ext" xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
<title>Layer-3 Networking Extension (<literal>router</literal>)</title>
<para>The Layer-3 networking extension enables OpenStack Networking API users
to route packets between subnets, forward packets from
internal networks to external ones, and access instances from
external networks through <emphasis role="italic"> Floating
IPs</emphasis>.</para>
<title>Layer-3 Networking Extension
(<literal>router</literal>)</title>
<para>The Layer-3 networking extension enables OpenStack
Networking API users to route packets between subnets, forward
packets from internal networks to external ones, and access
instances from external networks through <emphasis
role="italic"> Floating IPs</emphasis>.</para>
<para>This extension introduces the following resources: <itemizedlist>
<listitem>
<para><emphasis role="bold">router</emphasis>, a
@ -50,15 +51,14 @@
OpenStack Networking port attached to an internal
network.</para>
</listitem>
</itemizedlist>
</itemizedlist>
</para>
<?hard-pagebreak?>
<section xml:id="router_ext_concepts">
<title>Concepts</title>
<para>The OpenStack Networking layer-3 extension is a resource
extension. It defines two new resources:
<emphasis role="bold">router</emphasis> and
<emphasis role="bold">floatingip</emphasis>.</para>
extension. It defines two new resources: <emphasis
role="bold">router</emphasis> and <emphasis
role="bold">floatingip</emphasis>.</para>
<para>A <emphasis role="bold">router </emphasis> is used to
interconnect subnets and forward traffic among them.
Another feature of the router is to NAT internal traffic
@ -71,12 +71,12 @@
<para>A <emphasis role="bold">floating IP </emphasis> is an IP
address on an external network, which is associated with a
specific port, and optionally a specific IP address, on a
private OpenStack Networking network. Therefore a floating IP allows
access to an instance on a private network from an
external network. Floating IPs can only be defined on
private OpenStack Networking network. Therefore a floating
IP allows access to an instance on a private network from
an external network. Floating IPs can only be defined on
networks for which the attribute <emphasis role="italic">
router:external</emphasis> (by the external network extension)
has been set to True.</para>
router:external</emphasis> (by the external network
extension) has been set to True.</para>
<?hard-pagebreak?>
<table rules="all">
<caption>Router Attributes</caption>
@ -234,9 +234,9 @@
<td>CRU</td>
<td>N/A</td>
<td>UUID Pattern</td>
<td>UUID of the port on an internal OpenStack Networking
network which should be associated to the
Floating IP</td>
<td>UUID of the port on an internal OpenStack
Networking network which should be associated
to the Floating IP</td>
</tr>
<tr>
<td>fixed_ip_address</td>
@ -365,7 +365,8 @@ Accept: application/json</literallayout>
URI. Users can control which attributes should be
returned by using the <parameter>fields</parameter>
query parameter.</para>
<para>This operation does not require a request body.</para>
<para>This operation does not require a request
body.</para>
<para>This operation returns a response body.</para>
<example>
<title>Show Router: JSON Request</title>
@ -528,8 +529,10 @@ Accept: application/json</literallayout>
interfaces through <link
linkend="router_remove_interface"> remove router
interface operation</link>. </simpara>
<para>This operation does not require a request body.</para>
<para>This operation does not return a response body.</para>
<para>This operation does not require a request
body.</para>
<para>This operation does not return a response
body.</para>
<example>
<title>Delete Router: JSON Request</title>
<literallayout class="monospaced">DELETE /v2.0/routers/8604a0de-7f6b-409a-a47c-a1cc7bc77b2e
@ -646,18 +649,22 @@ Accept: application/json
<simpara>This request requires a request body.</simpara>
<simpara>This request returns a response body.</simpara>
<para>This operation removes an internal router interface,
thus detaching a subnet from the router. Either a
subnet identifier (<literal>subnet_id</literal>) or a
port identifier (<literal>port_id</literal>) should be
passed in the request body; this will be used to
identify the router interface to remove. If both are
specified, the subnet identifier must correspond to
the one of the first ip address on the port specified
by the port identifier; Otherwise a <errorcode>409
Conflict</errorcode> error will be
returned. The response will contain information about
the affected router and interface.</para>
<para>A <literal>404 Not Found</literal> error will be
thus detaching a subnet from the router.</para>
<para>This operation removes an internal router interface,
which detaches a subnet from the router. You must
specify either a subnet ID or port ID in the request
body; this value is used to identify the router
interface to remove.</para>
<para>You can also specify both a subnet ID and port ID.
If you specify both IDs, the subnet ID must correspond
to the subnet ID of the first IP address on the port
specified by the port ID. Otherwise, the operation
returns a <errorcode>409</errorcode>
<errortext>Conflict</errortext> error. The response
contains information about the affected router and
interface.</para>
<para>A <errorcode>404</errorcode>
<errortext>Not Found</errortext> error will be
returned either if the router or the subnet/port do
not exist or are not visible to the user.</para>
<para>As a consequence of this operation, the port
@ -686,8 +693,8 @@ Accept: application/json
<section xml:id="router_ext_ops_floatingip">
<title>Floating IP API Operations</title>
<para>This section discusses operations for creating and
managing floating IPs through the OpenStack Networking L3 API
extension.</para>
managing floating IPs through the OpenStack Networking L3
API extension.</para>
<section xml:id="floatingip_list">
<title>List Floating IPs</title>
<para>
@ -842,10 +849,11 @@ Accept: application/json</literallayout>
port using the <literal>port_id</literal> attribute in
the request body. If an invalid port identifier is
specified, a <errorcode>404</errorcode> error will be
returned. The internal OpenStack Networking port associated with
the Floating IP must have at least an IP address
configured, otherwise a <errorcode>400</errorcode>
error will be returned.</para>
returned. The internal OpenStack Networking port
associated with the Floating IP must have at least an
IP address configured, otherwise a
<errorcode>400</errorcode> error will be
returned.</para>
<para>As an OpenStack Networking port might be associated
with multiple IP addresses, the particular IP address
to associate with the floating IP can be specified
@ -859,9 +867,10 @@ Accept: application/json</literallayout>
<literal>fixed_ip_address</literal> a
<errorcode>400</errorcode> error will be
returned.</para>
<para>If the internal OpenStack Networking port and ip address selected
for association are already associated to another
floating IP, a 409 error will be returned.</para>
<para>If the internal OpenStack Networking port and ip
address selected for association are already
associated to another floating IP, a 409 error will be
returned.</para>
<example>
<title>Create Floating IP: JSON Request</title>
<programlisting language="json"><xi:include href="samples/floatingips-post-req.json" parse="text"/></programlisting>