cloudstack/docs/en-US/add-loadbalancer-rule-vpc.xml

<?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-loadbalancer-rule-vpc">
  <title>Adding Load Balancing Rules on a VPC</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 that belong to a network tier that provides load
    balancing service in a VPC. A user creates a rule, specifies an algorithm, and assigns the rule
    to a set of VMs within a VPC.</para>
  <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>In the Select view, select VPC.</para>
      <para>All the VPCs that you have created for the account is listed in the page.</para>
    </listitem>
    <listitem>
      <para>Click the Configure button of the VPC to which you want to configure load balancing
        rules.</para>
      <para>The VPC page is displayed where all the tiers you created are listed in a
        diagram.</para>
    </listitem>
    <listitem>
      <para>Click the Settings icon.</para>
      <para>The following options are displayed.</para>
      <itemizedlist>
        <listitem>
          <para>IP Addresses</para>
        </listitem>
        <listitem>
          <para>Gateways</para>
        </listitem>
        <listitem>
          <para>Site-to-Site VPN</para>
        </listitem>
        <listitem>
          <para>Network ACLs</para>
        </listitem>
      </itemizedlist>
    </listitem>
    <listitem>
      <para>Select IP Addresses.</para>
      <para>The IP Addresses page is displayed.</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>
    </listitem>
    <listitem>
      <para>Select the tier to which you want to apply the rule.</para>
      <note>
        <para>In a VPC, the load balancing service is supported only on a single tier.</para>
      </note>
    </listitem>
    <listitem>
      <para>Specify 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 that receives the 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 the following well-known algorithms:</para>
          <itemizedlist>
            <listitem>
              <para>Round-robin</para>
            </listitem>
            <listitem>
              <para>Least connections</para>
            </listitem>
            <listitem>
              <para>Source</para>
            </listitem>
          </itemizedlist>
        </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">Add VMs</emphasis>: Click Add VMs, then select two or more VMs
            that will divide the load of incoming traffic, and click Apply.</para>
        </listitem>
      </itemizedlist>
    </listitem>
  </orderedlist>
  <para>The new load balancing rule appears in the list. You can repeat these steps to add more load
    balancing rules for this IP address.</para>
</section>