| <?xml version='1.0' encoding='utf-8' ?> |
| <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ |
| <!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> |
| %BOOK_ENTITIES; |
| ]> |
| <!-- Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| http://www.apache.org/licenses/LICENSE-2.0 |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| --> |
| <section id="add-load-balancer-rule"> |
| <title>Adding a Load Balancer Rule</title> |
| <orderedlist> |
| <listitem> |
| <para>Log in to the &PRODUCT; UI as an administrator or end user. </para> |
| </listitem> |
| <listitem> |
| <para>In the left navigation, choose Network.</para> |
| </listitem> |
| <listitem> |
| <para>Click the name of the network where you want to load balance the traffic.</para> |
| </listitem> |
| <listitem> |
| <para>Click View IP Addresses.</para> |
| </listitem> |
| <listitem> |
| <para>Click the IP address for which you want to create the rule, then click the Configuration |
| tab.</para> |
| </listitem> |
| <listitem> |
| <para>In the Load Balancing node of the diagram, click View All.</para> |
| <para>In a Basic zone, you can also create a load balancing rule without acquiring or |
| selecting an IP address. &PRODUCT; internally assign an IP when you create the load |
| balancing rule, which is listed in the IP Addresses page when the rule is created. </para> |
| <para>To do that, select the name of the network, then click Add Load Balancer tab. Continue |
| with <xref linkend="config-lb"/>.</para> |
| </listitem> |
| <listitem id="config-lb"> |
| <para>Fill in the following:</para> |
| <itemizedlist> |
| <listitem> |
| <para><emphasis role="bold">Name</emphasis>: A name for the load balancer rule.</para> |
| </listitem> |
| <listitem> |
| <para><emphasis role="bold">Public Port</emphasis>: The port receiving incoming traffic to |
| be balanced.</para> |
| </listitem> |
| <listitem> |
| <para><emphasis role="bold">Private Port</emphasis>: The port that the VMs will use to |
| receive the traffic.</para> |
| </listitem> |
| <listitem> |
| <para><emphasis role="bold">Algorithm</emphasis>: Choose the load balancing algorithm you |
| want &PRODUCT; to use. &PRODUCT; supports a variety of well-known algorithms. If you are |
| not familiar with these choices, you will find plenty of information about them on the |
| Internet.</para> |
| </listitem> |
| <listitem> |
| <para><emphasis role="bold">Stickiness</emphasis>: (Optional) Click Configure and choose |
| the algorithm for the stickiness policy. See Sticky Session Policies for Load Balancer |
| Rules.</para> |
| </listitem> |
| <listitem> |
| <para><emphasis role="bold">AutoScale</emphasis>: Click Configure and complete the |
| AutoScale configuration as explained in <xref linkend="autoscale"/>.</para> |
| </listitem> |
| <listitem><para><emphasis role="bold">Health Check</emphasis>: (Optional; NetScaler load balancers only) |
| Click Configure and fill in the characteristics of the health check policy. |
| See <xref linkend="health-checks-for-lb-rules"/>.</para> |
| <itemizedlist> |
| <listitem><para><emphasis role="bold">Ping path (Optional)</emphasis>: Sequence of destinations to which to send health check queries. |
| Default: / (all).</para></listitem> |
| <listitem><para><emphasis role="bold">Response time (Optional)</emphasis>: How long to wait for a response from the health check (2 - 60 seconds). |
| Default: 5 seconds.</para></listitem> |
| <listitem><para><emphasis role="bold">Interval time (Optional)</emphasis>: Amount of time between health checks (1 second - 5 minutes). |
| Default value is set in the global configuration parameter lbrule_health check_time_interval.</para></listitem> |
| <listitem><para><emphasis role="bold">Healthy threshold (Optional)</emphasis>: Number of consecutive health check successes |
| that are required before declaring an instance healthy. |
| Default: 2.</para></listitem> |
| <listitem><para><emphasis role="bold">Unhealthy threshold (Optional)</emphasis>: Number of consecutive health check failures that are required before declaring an instance unhealthy. |
| Default: 10.</para></listitem> |
| </itemizedlist></listitem> |
| </itemizedlist> |
| </listitem> |
| <listitem> |
| <para>Click Add VMs, then select two or more VMs that will divide the load of incoming |
| traffic, and click Apply.</para> |
| <para>The new load balancer rule appears in the list. You can repeat these steps to add more |
| load balancer rules for this IP address.</para> |
| </listitem> |
| </orderedlist> |
| </section> |