cloudstack-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject git commit: updated refs/heads/master to 84d3be2
Date Fri, 09 Aug 2013 04:41:18 GMT
Updated Branches:
  refs/heads/master dd4c2362b -> 84d3be21e

CLOUDSTACK-816. DOC. Document health checks for load balanced instances.


Branch: refs/heads/master
Commit: 84d3be21ea1da8bb994f52ddc437fd8fe6242b44
Parents: dd4c236
Author: Jessica <>
Authored: Thu Aug 8 21:40:31 2013 -0700
Committer: Jessica <>
Committed: Thu Aug 8 21:40:31 2013 -0700

 docs/en-US/add-load-balancer-rule.xml     | 20 +++++++++--
 docs/en-US/health-checks-for-lb-rules.xml | 48 ++++++++++++++++++++++++++
 docs/en-US/load-balancer-rules.xml        |  1 +
 3 files changed, 67 insertions(+), 2 deletions(-)
diff --git a/docs/en-US/add-load-balancer-rule.xml b/docs/en-US/add-load-balancer-rule.xml
index 2d911fe..b679736 100644
--- a/docs/en-US/add-load-balancer-rule.xml
+++ b/docs/en-US/add-load-balancer-rule.xml
@@ -67,8 +67,8 @@
           <para><emphasis role="bold">Stickiness</emphasis>: (Optional)
Click Configure and choose
-            the algorithm for the stickiness policy. See Sticky Session Policies for Load
-            Rules.</para>
+            the algorithm for the stickiness policy. See <xref
+            linkend="sticky-session-policies-for-lb-rules"/>.</para>
           <para><emphasis role="bold">AutoScale</emphasis>: Click Configure
and complete the
@@ -76,6 +76,22 @@
+    <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
+          Default: 10.</para></listitem>     
+      </itemizedlist></listitem>
       <para>Click Add VMs, then select two or more VMs that will divide the load of
         traffic, and click Apply.</para>
diff --git a/docs/en-US/health-checks-for-lb-rules.xml b/docs/en-US/health-checks-for-lb-rules.xml
new file mode 100644
index 0000000..84cae65
--- /dev/null
+++ b/docs/en-US/health-checks-for-lb-rules.xml
@@ -0,0 +1,48 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" ""
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+<!-- 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
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ KIND, either express or implied.  See the License for the
+ specific language governing permissions and limitations
+ under the License.
+<section id="health-checks-for-lb-rules">
+  <!-- CLOUDSTACK-443 -->
+  <title>Health Checks for Load Balancer Rules</title>
+  <para>(NetScaler load balancer only)
+  </para>
+  <para>Health checks are used in load-balanced applications to ensure that requests
are forwarded
+    only to running, available services.
+    When creating a load balancer rule, you can specify a health check policy.
+    This is in addition to specifying the
+    stickiness policy, algorithm, and other load balancer rule options.
+    You can configure one health check policy per load balancer rule.</para>
+  <para>Any load balancer rule defined on a NetScaler load balancer in &PRODUCT;
can have a health check policy.
+    The policy consists of a ping path, thresholds to define "healthy" and "unhealthy" states,
+    health check frequency, and timeout wait interval.</para>
+  <para>When a health check policy is in effect,
+    the load balancer will stop forwarding requests to any resources that are found to be
+    If the resource later becomes available again, the periodic health check
+    will discover it, and the resource will once again be added to the pool of resources
that can
+    receive requests from the load balancer.</para>
+  <para>You can delete or modify existing health check policies.</para>
+  <para>To configure how often the health check is performed by default, use the global
+    configuration setting lbrule_health check_time_interval.
+    You can override this value for an individual health check policy.</para>
+  <para>For details on how to set a health check policy using the UI, see <xref
diff --git a/docs/en-US/load-balancer-rules.xml b/docs/en-US/load-balancer-rules.xml
index 7773900..884647c 100644
--- a/docs/en-US/load-balancer-rules.xml
+++ b/docs/en-US/load-balancer-rules.xml
@@ -37,4 +37,5 @@
   <xi:include href="add-load-balancer-rule.xml" xmlns:xi=""/>
   <xi:include href="sticky-session-policies-for-lb-rules.xml"
+  <xi:include href="health-checks-for-lb-rules.xml" xmlns:xi=""

View raw message