From 849397a3b4f4516f101ebc1dbb3fc5221cfb8b57 Mon Sep 17 00:00:00 2001 From: senthilmageswaran muthusamy Date: Thu, 14 May 2015 19:06:43 +0530 Subject: [PATCH] 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 --- api-ref/src/docbkx/ch_netconn-v2-ext.xml | 117 ++++++++++--------- api-ref/src/wadls/netconn-api/src/common.ent | 106 ++++++++++++----- 2 files changed, 139 insertions(+), 84 deletions(-) diff --git a/api-ref/src/docbkx/ch_netconn-v2-ext.xml b/api-ref/src/docbkx/ch_netconn-v2-ext.xml index 550eb186d..1ecf3b45b 100644 --- a/api-ref/src/docbkx/ch_netconn-v2-ext.xml +++ b/api-ref/src/docbkx/ch_netconn-v2-ext.xml @@ -169,20 +169,22 @@
Load-Balancer-as-a-Service (LBaaS) 1.0 (STABLE) - 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. - 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. + + 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. + + + 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. + - - + @@ -191,53 +193,61 @@ - - + + - - + + - - + + - - + + - - + + - - + +
Load balancer statuses
Status
ACTIVEResource is ready and active.ACTIVEResource is ready and active.
PENDING_CREATEResource is being created.PENDING_CREATEResource is being created.
PENDING_UPDATEResource is being updated.PENDING_UPDATEResource is being updated.
PENDING_DELETEResource is going to be deleted.PENDING_DELETEResource is pending deletion.
INACTIVEResource is created but not active.INACTIVEResource was created but is not active.
ERRORObject within the service is not working. Look - for an extra attribute called error_details - for a textual explanation on the error, its - cause, and possibly a solution.ERROR + + Object within the service is not working. The + error_details attribute provides an + explanation for the error, its cause, and + possibly a solution. + +
+
Load-Balancer-as-a-Service (LBaaS) 2.0 (EXPERIMENTAL) - 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. - 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. + + 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. + + + 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. + - - + @@ -246,37 +256,40 @@ - - + + - - + + - - + + - - + + - - + + - - + +
Load balancer statuses
Status
ACTIVEResource is ready and active.ACTIVEResource is ready and active.
PENDING_CREATEResource is being created.PENDING_CREATEResource is being created.
PENDING_UPDATEResource is being updated.PENDING_UPDATEResource is being updated.
PENDING_DELETEResource is going to be deleted.PENDING_DELETEResource is pending deletion.
INACTIVEResource is created but not active.INACTIVEResource was created but is not active.
ERRORObject within the service is not working. Look - for an extra attribute called error_details - for a textual explanation on the error, its - cause, and possibly a solution.ERROR + Object within the service is not working. The + error_details attribute provides an + explanation for the error, its cause, and possibly a + solution. +
+ + />
Virtual-Private-Network-as-a-Service (VPNaaS) 2.0 (CURRENT) diff --git a/api-ref/src/wadls/netconn-api/src/common.ent b/api-ref/src/wadls/netconn-api/src/common.ent index 7795dcfd0..8695a7f45 100644 --- a/api-ref/src/wadls/netconn-api/src/common.ent +++ b/api-ref/src/wadls/netconn-api/src/common.ent @@ -1631,12 +1631,27 @@ + name="subnet_id" style="plain" type="csapi:uuid"> + + + The ID of the subnet on which to allocate the VIP address. + + + + - 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. -' > + + 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. + + + +'> @@ -1651,7 +1666,12 @@ - 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. + + 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. + + ' > - 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. @@ -1702,7 +1722,10 @@ - Maximum connections this load balancer can have. Default is infinite. + + The maximum number of connections permitted for this load balancer. + Default is infinite. + - The administrative state of the load balancer, which is up (true) or down (false). - If you set this attribute to false, the listener is created in an administratively down state. + + The administrative state of the load balancer, which is up + (true) or down (false). + + + Set this attribute to false to create the listener in + an administratively down state. + - The type of probe sent by the load balancer to verify the member state, which is PING, TCP, HTTP, or HTTPS. + + The type of probe sent by the load balancer to verify the member + state, which is PING, TCP, HTTP, or HTTPS. + - 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. + + 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. + - Session persistence parameters for the VIP. Omit the - session_persistence parameter to prevent - session persistence. When no session persistence is used, - the session_persistence parameter does not appear in the - API response. - To clear session persistence for the VIP, set the - session_persistence parameter to null in a VIP update request. + + Session persistence parameters for the VIP. Omit the + session_persistence parameter to prevent session + persistence. When no session persistence is used, the + session_persistence parameter does not appear in the + API response. To clear session persistence for the VIP, set the + session_persistence parameter to null in a + VIP update request. + - Session persistence parameters for the VIP. Omit the - session_persistence parameter to prevent - session persistence. When no session persistence is used, the - session_persistence parameter does not appear in the - API response. To clear session persistence for the VIP, set the - session_persistence parameter to null in a - VIP update request. + + Session persistence parameters for the VIP. Omit the + session_persistence parameter to prevent session + persistence. When no session persistence is used, the + session_persistence parameter does not appear in the + API response. To clear session persistence for the VIP, set the + session_persistence parameter to null in a + VIP update request. + - Session persistence parameters for the VIP. Omit the - session_persistence parameter to prevent - session persistence. When no session persistence is used, - the session_persistence parameter does not appear in the - API response. - To clear session persistence for the VIP, set the - session_persistence parameter to null in a VIP update request. + + Session persistence parameters for the VIP. Omit the + session_persistence parameter to prevent session + persistence. When no session persistence is used, the + session_persistence parameter does not appear in the + API response. To clear session persistence for the VIP, set the + session_persistence parameter to null in a + VIP update request. +