Description for "subnet ID" in create a load balancer pool is not accurate
Corrects the create load balancer pool description for subnet_id Adds the descripton for lb_algorithm Closes-Bug: #1453750 Change-Id: Iebb49c05c0617dc6b48083cc85d4ac29a78b0531
This commit is contained in:
senthilmageswaran muthusamy
Diane Fleming
parent
bceb389a4d
commit
849397a3b4
@ -169,20 +169,22 @@
|
||||
</section>
|
||||
<section xml:id="lbaas-v1.0">
|
||||
<title>Load-Balancer-as-a-Service (LBaaS) 1.0 (STABLE)</title>
|
||||
<para>The LBaaS version 1.0 extension pairs with the
|
||||
Networking 2.0 API to enable OpenStack tenants to manage
|
||||
load balancers for their VMs. With this extension
|
||||
you can load-balance client traffic from one network to application
|
||||
services, such as VMs, on the same network.</para>
|
||||
<para>Use this extension to create and manage virtual IP
|
||||
addresses (VIPs), pools, members of a pool, health
|
||||
monitors associated with a pool, and view status of a
|
||||
resource.</para>
|
||||
<para>
|
||||
The LBaaS version 1.0 extension pairs with the Networking 2.0 API
|
||||
to enable OpenStack tenants to manage load balancers for their
|
||||
VMs. With this extension, you can load-balance client traffic from
|
||||
one network to application services, such as VMs, on the same
|
||||
network.
|
||||
</para>
|
||||
<para>
|
||||
Use this extension to create and manage virtual IP addresses
|
||||
(VIPs), pools, members of a pool, health monitors associated with
|
||||
a pool, and view status of a resource.
|
||||
</para>
|
||||
<table rules="all" frame="border">
|
||||
<caption>Load balancer statuses</caption>
|
||||
<col width="25%"/>
|
||||
<col width="50%"/>
|
||||
<col width="25%"/>
|
||||
<col width="75%"/>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Status</th>
|
||||
@ -191,53 +193,61 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>ACTIVE</td>
|
||||
<td>Resource is ready and active.</td>
|
||||
<td><para>ACTIVE</para></td>
|
||||
<td><para>Resource is ready and active.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>PENDING_CREATE</td>
|
||||
<td>Resource is being created.</td>
|
||||
<td><para>PENDING_CREATE</para></td>
|
||||
<td><para>Resource is being created.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>PENDING_UPDATE</td>
|
||||
<td>Resource is being updated.</td>
|
||||
<td><para>PENDING_UPDATE</para></td>
|
||||
<td><para>Resource is being updated.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>PENDING_DELETE</td>
|
||||
<td>Resource is going to be deleted.</td>
|
||||
<td><para>PENDING_DELETE</para></td>
|
||||
<td><para>Resource is pending deletion.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>INACTIVE</td>
|
||||
<td>Resource is created but not active.</td>
|
||||
<td><para>INACTIVE</para></td>
|
||||
<td><para>Resource was created but is not active.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ERROR</td>
|
||||
<td>Object within the service is not working. Look
|
||||
for an extra attribute called <code>error_details</code>
|
||||
for a textual explanation on the error, its
|
||||
cause, and possibly a solution.</td>
|
||||
<td><para>ERROR</para></td>
|
||||
<td>
|
||||
<para>
|
||||
Object within the service is not working. The
|
||||
<code>error_details</code> attribute provides an
|
||||
explanation for the error, its cause, and
|
||||
possibly a solution.
|
||||
</para>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<para></para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
href="../wadls/netconn-api/src/os-lbaasv1.0-ext.wadl"
|
||||
> </wadl:resources>
|
||||
</section>
|
||||
<section xml:id="lbaas-v2.0">
|
||||
<title>Load-Balancer-as-a-Service (LBaaS) 2.0 (EXPERIMENTAL)</title>
|
||||
<para>The LBaaS version 2.0 extension pairs with the
|
||||
Networking 2.0 API to enable OpenStack tenants to manage
|
||||
load balancers for their VMs. With this extension
|
||||
you can load-balance client traffic from one network to application
|
||||
services, such as VMs, on the same network.</para>
|
||||
<para>Use this extension to create and manage load balancers, listeners,
|
||||
pools, members of a pool, and health monitors associated with a pool
|
||||
and view status of a resource.</para>
|
||||
<para>
|
||||
The LBaaS version 2.0 extension pairs with the Networking 2.0 API
|
||||
to enable OpenStack tenants to manage load balancers for their
|
||||
VMs. With this extension you can load-balance client traffic from
|
||||
one network to application services, such as VMs, on the same
|
||||
network.
|
||||
</para>
|
||||
<para>
|
||||
Use this extension to create and manage load balancers, listeners,
|
||||
pools, members of a pool, and health monitors associated with a
|
||||
pool and view status of a resource.
|
||||
</para>
|
||||
<table rules="all" frame="border">
|
||||
<caption>Load balancer statuses</caption>
|
||||
<col width="25%"/>
|
||||
<col width="50%"/>
|
||||
<col width="25%"/>
|
||||
<col width="75%"/>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Status</th>
|
||||
@ -246,37 +256,40 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>ACTIVE</td>
|
||||
<td>Resource is ready and active.</td>
|
||||
<td><para>ACTIVE</para></td>
|
||||
<td><para>Resource is ready and active.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>PENDING_CREATE</td>
|
||||
<td>Resource is being created.</td>
|
||||
<td><para>PENDING_CREATE</para></td>
|
||||
<td><para>Resource is being created.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>PENDING_UPDATE</td>
|
||||
<td>Resource is being updated.</td>
|
||||
<td><para>PENDING_UPDATE</para></td>
|
||||
<td><para>Resource is being updated.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>PENDING_DELETE</td>
|
||||
<td>Resource is going to be deleted.</td>
|
||||
<td><para>PENDING_DELETE</para></td>
|
||||
<td><para>Resource is pending deletion.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>INACTIVE</td>
|
||||
<td>Resource is created but not active.</td>
|
||||
<td><para>INACTIVE</para></td>
|
||||
<td><para>Resource was created but is not active.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ERROR</td>
|
||||
<td>Object within the service is not working. Look
|
||||
for an extra attribute called <code>error_details</code>
|
||||
for a textual explanation on the error, its
|
||||
cause, and possibly a solution.</td>
|
||||
<td><para>ERROR</para></td>
|
||||
<td><para>
|
||||
Object within the service is not working. The
|
||||
<code>error_details</code> attribute provides an
|
||||
explanation for the error, its cause, and possibly a
|
||||
solution.
|
||||
</para></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<para></para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
href="../wadls/netconn-api/src/os-lbaasv2.0-ext.wadl"
|
||||
> </wadl:resources>
|
||||
/>
|
||||
</section>
|
||||
<section xml:id="vpnaas-v2.0">
|
||||
<title>Virtual-Private-Network-as-a-Service (VPNaaS) 2.0 (CURRENT)</title>
|
||||
|
||||
@ -1631,12 +1631,27 @@
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="subnet_id" style="plain" type="csapi:uuid">
|
||||
name="subnet_id" style="plain" type="csapi:uuid">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>
|
||||
The ID of the subnet on which to allocate the VIP address.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="lb_algorithm" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The load-balancer algorithm, which is round-robin, least-connections, and so on. This value, which must be supported, is dependent on the load-balancer provider. Round robin must be supported.</para> </wadl:doc>
|
||||
</param>' >
|
||||
<para>
|
||||
The load-balancer algorithm, which is round-robin, least-connections,
|
||||
and so on. This algorithm must be supported and is dependent on the
|
||||
load-balancer provider. The round-robin algorithm must be supported.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
'>
|
||||
<!ENTITY poolUpdateRequestParams '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="name" style="plain" type="xsd:string">
|
||||
@ -1651,7 +1666,12 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The load-balancer algorithm, which is round-robin, least-connections, and so on. This value, which must be supported, is dependent on the load-balancer provider. Round robin must be supported.</para> </wadl:doc>
|
||||
<para>
|
||||
The load-balancer algorithm, which is round-robin, least-connections,
|
||||
and so on. This algorithm must be supported and is dependent on the
|
||||
load-balancer provider. The round-robin algorithm must be supported.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>' >
|
||||
<!ENTITY listenerRequestParams '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
@ -1692,8 +1712,8 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The ID of the tenant who owns the listener. Only administrative users can
|
||||
specify a tenant ID other than their own.
|
||||
The ID of the tenant who owns the listener. Only administrative
|
||||
users can specify a tenant ID other than their own.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@ -1702,7 +1722,10 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Maximum connections this load balancer can have. Default is infinite.</para>
|
||||
<para>
|
||||
The maximum number of connections permitted for this load balancer.
|
||||
Default is infinite.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
@ -1724,8 +1747,14 @@
|
||||
name="admin_state_up" style="plain" type="xsd:boolean">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>The administrative state of the load balancer, which is up (<code>true</code>) or down (<code>false</code>).</para>
|
||||
<para>If you set this attribute to <code>false</code>, the listener is created in an administratively down state.</para>
|
||||
<para>
|
||||
The administrative state of the load balancer, which is up
|
||||
(<code>true</code>) or down (<code>false</code>).
|
||||
</para>
|
||||
<para>
|
||||
Set this attribute to <code>false</code> to create the listener in
|
||||
an administratively down state.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
@ -1835,7 +1864,10 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The type of probe sent by the load balancer to verify the member state, which is PING, TCP, HTTP, or HTTPS.</para>
|
||||
<para>
|
||||
The type of probe sent by the load balancer to verify the member
|
||||
state, which is PING, TCP, HTTP, or HTTPS.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
@ -1851,7 +1883,11 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The maximum number of seconds for a monitor to wait for a connection to be established before it times out. This value must be less than the delay value.</para>
|
||||
<para>
|
||||
The maximum number of seconds for a monitor to wait for a connection
|
||||
to be established before it times out. This value must be less than
|
||||
the delay value.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
@ -2237,13 +2273,15 @@
|
||||
name="session_persistence" style="plain" type="xsd:dict">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>Session persistence parameters for the VIP. Omit the
|
||||
<parameter>session_persistence</parameter> parameter to prevent
|
||||
session persistence. When no session persistence is used,
|
||||
the <parameter>session_persistence</parameter> parameter does not appear in the
|
||||
API response.
|
||||
To clear session persistence for the VIP, set the
|
||||
<parameter>session_persistence</parameter> parameter to <code>null</code> in a VIP update request.</para>
|
||||
<para>
|
||||
Session persistence parameters for the VIP. Omit the
|
||||
<code>session_persistence</code> parameter to prevent session
|
||||
persistence. When no session persistence is used, the
|
||||
<code>session_persistence</code> parameter does not appear in the
|
||||
API response. To clear session persistence for the VIP, set the
|
||||
<code>session_persistence</code> parameter to <code>null</code> in a
|
||||
VIP update request.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
@ -2342,13 +2380,15 @@
|
||||
name="session_persistence" style="plain" type="xsd:dict">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>Session persistence parameters for the VIP. Omit the
|
||||
<parameter>session_persistence</parameter> parameter to prevent
|
||||
session persistence. When no session persistence is used, the
|
||||
<parameter>session_persistence</parameter> parameter does not appear in the
|
||||
API response. To clear session persistence for the VIP, set the
|
||||
<parameter>session_persistence</parameter> parameter to <code>null</code> in a
|
||||
VIP update request.</para>
|
||||
<para>
|
||||
Session persistence parameters for the VIP. Omit the
|
||||
<code>session_persistence</code> parameter to prevent session
|
||||
persistence. When no session persistence is used, the
|
||||
<code>session_persistence</code> parameter does not appear in the
|
||||
API response. To clear session persistence for the VIP, set the
|
||||
<code>session_persistence</code> parameter to <code>null</code> in a
|
||||
VIP update request.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
@ -2395,13 +2435,15 @@
|
||||
name="session_persistence" style="plain" type="xsd:dict">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>Session persistence parameters for the VIP. Omit the
|
||||
<parameter>session_persistence</parameter> parameter to prevent
|
||||
session persistence. When no session persistence is used,
|
||||
the <parameter>session_persistence</parameter> parameter does not appear in the
|
||||
API response.
|
||||
To clear session persistence for the VIP, set the
|
||||
<parameter>session_persistence</parameter> parameter to <code>null</code> in a VIP update request.</para>
|
||||
<para>
|
||||
Session persistence parameters for the VIP. Omit the
|
||||
<code>session_persistence</code> parameter to prevent session
|
||||
persistence. When no session persistence is used, the
|
||||
<code>session_persistence</code> parameter does not appear in the
|
||||
API response. To clear session persistence for the VIP, set the
|
||||
<code>session_persistence</code> parameter to <code>null</code> in a
|
||||
VIP update request.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user