CLOUDSTACK-1050:Documentation for adding load balancer rule

This commit is contained in:
Radhika PC 2013-02-07 11:44:33 +05:30 committed by Pranav Saxena
parent 5fe1ef47dd
commit eea74f5ddd
3 changed files with 48 additions and 25 deletions

View File

@ -4,19 +4,19 @@
%BOOK_ENTITIES; %BOOK_ENTITIES;
]> ]>
<!-- Licensed to the Apache Software Foundation (ASF) under one <!-- Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file or more contributor license agreements. See the NOTICE file
distributed with this work for additional information distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance "License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0 http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the KIND, either express or implied. See the License for the
specific language governing permissions and limitations specific language governing permissions and limitations
under the License. under the License.
--> -->
<section id="add-load-balancer-rule"> <section id="add-load-balancer-rule">
<title>Adding a Load Balancer Rule</title> <title>Adding a Load Balancer Rule</title>
@ -70,6 +70,10 @@
the algorithm for the stickiness policy. See Sticky Session Policies for Load Balancer the algorithm for the stickiness policy. See Sticky Session Policies for Load Balancer
Rules.</para> Rules.</para>
</listitem> </listitem>
<listitem>
<para><emphasis role="bold">AutoScale</emphasis>: Click Configure and complete the
AutoScale configuration as explained in <xref linkend="autoscale"/>.</para>
</listitem>
</itemizedlist> </itemizedlist>
</listitem> </listitem>
<listitem> <listitem>

View File

@ -22,11 +22,19 @@
under the License. under the License.
--> -->
<section id="load-balancer-rules"> <section id="load-balancer-rules">
<title>Load Balancer Rules</title> <title>Load Balancer Rules</title>
<para>A &PRODUCT; user or administrator may create load balancing rules that balance traffic received at a public IP to one or more VMs. A user creates a rule, specifies an algorithm, and assigns the rule to a set of VMs.</para> <para>A &PRODUCT; user or administrator may create load balancing rules that balance traffic
<note><para>If you create load balancing rules while using a network service offering that includes an external load balancer device such as NetScaler, and later change the network service offering to one that uses the &PRODUCT; virtual router, you must create a firewall rule on the virtual router for each of your existing load balancing rules so that they continue to function.</para> received at a public IP to one or more VMs. A user creates a rule, specifies an algorithm, and
</note> assigns the rule to a set of VMs.</para>
<para></para> <note>
<xi:include href="add-load-balancer-rule.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <para>If you create load balancing rules while using a network service offering that includes an
<xi:include href="sticky-session-policies-for-lb-rules.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> external load balancer device such as NetScaler, and later change the network service offering
to one that uses the &PRODUCT; virtual router, you must create a firewall rule on the virtual
router for each of your existing load balancing rules so that they continue to
function.</para>
</note>
<para/>
<xi:include href="add-load-balancer-rule.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="sticky-session-policies-for-lb-rules.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"/>
</section> </section>

View File

@ -21,10 +21,21 @@
specific language governing permissions and limitations specific language governing permissions and limitations
under the License. under the License.
--> -->
<section id="sticky-session-policies-for-lb-rules"> <section id="sticky-session-policies-for-lb-rules">
<title>Sticky Session Policies for Load Balancer Rules</title> <title>Sticky Session Policies for Load Balancer Rules</title>
<para>Sticky sessions are used in Web-based applications to ensure continued availability of information across the multiple requests in a user's session. For example, if a shopper is filling a cart, you need to remember what has been purchased so far. The concept of "stickiness" is also referred to as persistence or maintaining state.</para> <para>Sticky sessions are used in Web-based applications to ensure continued availability of
<para>Any load balancer rule defined in &PRODUCT; can have a stickiness policy. The policy consists of a name, stickiness method, and parameters. The parameters are name-value pairs or flags, which are defined by the load balancer vendor. The stickiness method could be load balancer-generated cookie, application-generated cookie, or source-based. In the source-based method, the source IP address is used to identify the user and locate the users stored data. In the other methods, cookies are used. The cookie generated by the load balancer or application is included in request and response URLs to create persistence. The cookie name can be specified by the administrator or automatically generated. A variety of options are provided to control the exact behavior of cookies, such as how they are generated and whether they are cached.</para> information across the multiple requests in a user's session. For example, if a shopper is
<para>For the most up to date list of available stickiness methods, see the &PRODUCT; UI or call listNetworks and check the SupportedStickinessMethods capability.</para> filling a cart, you need to remember what has been purchased so far. The concept of "stickiness"
is also referred to as persistence or maintaining state.</para>
<para>Any load balancer rule defined in &PRODUCT; can have a stickiness policy. The policy
consists of a name, stickiness method, and parameters. The parameters are name-value pairs or
flags, which are defined by the load balancer vendor. The stickiness method could be load
balancer-generated cookie, application-generated cookie, or source-based. In the source-based
method, the source IP address is used to identify the user and locate the users stored data. In
the other methods, cookies are used. The cookie generated by the load balancer or application is
included in request and response URLs to create persistence. The cookie name can be specified by
the administrator or automatically generated. A variety of options are provided to control the
exact behavior of cookies, such as how they are generated and whether they are cached.</para>
<para>For the most up to date list of available stickiness methods, see the &PRODUCT; UI or call
listNetworks and check the SupportedStickinessMethods capability.</para>
</section> </section>