en-US/management-server-lb.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="management-server-lb">
  <title>Management Server Load Balancing</title>
  <para>&PRODUCT; can use a load balancer to provide a virtual IP for multiple Management
    Servers. The administrator is responsible for creating the load balancer rules for the
    Management Servers. The application requires persistence or stickiness across multiple sessions.
    The following chart lists the ports that should be load balanced and whether or not persistence
    is required.</para>
  <para>Even if persistence is not required, enabling it is permitted.</para>
  <informaltable>
    <tgroup cols="4" align="left" colsep="1" rowsep="1">
      <thead>
        <row>
          <entry><para>Source Port</para></entry>
          <entry><para>Destination Port</para></entry>
          <entry><para>Protocol</para></entry>
          <entry><para>Persistence Required?</para></entry>
        </row>
      </thead>
      <tbody>
        <row>
          <entry><para>80 or 443</para></entry>
          <entry><para>8080 (or 20400 with AJP)</para></entry>
          <entry><para>HTTP (or AJP)</para></entry>
          <entry><para>Yes</para></entry>
        </row>
        <row>
          <entry><para>8250</para></entry>
          <entry><para>8250</para></entry>
          <entry><para>TCP</para></entry>
          <entry><para>Yes</para></entry>
        </row>
        <row>
          <entry><para>8096</para></entry>
          <entry><para>8096</para></entry>
          <entry><para>HTTP</para></entry>
          <entry><para>No</para></entry>
        </row>
      </tbody>
    </tgroup>
  </informaltable>
  <para>In addition to above settings, the administrator is responsible for setting the 'host' global
    config value from the management server IP to load balancer virtual IP address.
    If the 'host' value is not set to the VIP for Port 8250 and one of your management servers crashes,
    the UI is still available but the system VMs will not be able to contact the management server.
  </para>
</section>