You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by ra...@apache.org on 2014/01/06 09:20:36 UTC

git commit: CLOUDSTACK-5292 moniroting services in VR

Updated Branches:
  refs/heads/master 83acdf500 -> 1ae8b3ea8


CLOUDSTACK-5292 moniroting services in VR


Project: http://git-wip-us.apache.org/repos/asf/cloudstack-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cloudstack-docs/commit/1ae8b3ea
Tree: http://git-wip-us.apache.org/repos/asf/cloudstack-docs/tree/1ae8b3ea
Diff: http://git-wip-us.apache.org/repos/asf/cloudstack-docs/diff/1ae8b3ea

Branch: refs/heads/master
Commit: 1ae8b3ea8440911bd2a769ecd48d4da4a82853e7
Parents: 83acdf5
Author: radhikap <ra...@citrix.com>
Authored: Mon Jan 6 13:48:54 2014 +0530
Committer: radhikap <ra...@citrix.com>
Committed: Mon Jan 6 13:48:54 2014 +0530

----------------------------------------------------------------------
 en-US/virtual-router.xml |  22 +++++---
 en-US/vr-monitor.xml     | 115 ++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 130 insertions(+), 7 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/1ae8b3ea/en-US/virtual-router.xml
----------------------------------------------------------------------
diff --git a/en-US/virtual-router.xml b/en-US/virtual-router.xml
index c9b403b..501157f 100644
--- a/en-US/virtual-router.xml
+++ b/en-US/virtual-router.xml
@@ -21,12 +21,20 @@
     specific language governing permissions and limitations
     under the License.
 -->
-
 <section id="virtual-router">
-    <title>Virtual Router</title>
-    <para>The virtual router is a type of System Virtual Machine. The virtual router is one of the most frequently used service providers in &PRODUCT;. The end user has no direct access to the virtual router. Users can ping the virtual router and take actions that affect it (such as setting up port forwarding), but users do not have SSH access into the virtual router.</para>
-    <para>There is no mechanism for the administrator to log in to the virtual router. Virtual routers can be restarted by administrators, but this will interrupt public network access and other services for end users. A basic test in debugging networking issues is to attempt to ping the virtual router from a guest VM. Some of the characteristics of the virtual router are determined by its associated system service offering..</para>
-    <xi:include href="configure-virtual-router.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-    <xi:include href="upgrade-virtual-router-with-service-offering.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-    <xi:include href="best-practices-virtual-router.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />  
+  <title>Virtual Router</title>
+  <para>The virtual router is a type of System Virtual Machine. The virtual router is one of the
+    most frequently used service providers in &PRODUCT;. The end user has no direct access to the
+    virtual router. Users can ping the virtual router and take actions that affect it (such as
+    setting up port forwarding), but users do not have SSH access into the virtual router.</para>
+  <para>There is no mechanism for the administrator to log in to the virtual router. Virtual routers
+    can be restarted by administrators, but this will interrupt public network access and other
+    services for end users. A basic test in debugging networking issues is to attempt to ping the
+    virtual router from a guest VM. Some of the characteristics of the virtual router are determined
+    by its associated system service offering.</para>
+  <xi:include href="configure-virtual-router.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+  <xi:include href="upgrade-virtual-router-with-service-offering.xml"
+    xmlns:xi="http://www.w3.org/2001/XInclude"/>
+  <xi:include href="best-practices-virtual-router.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+  <xi:include href="vr-monitor.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
 </section>

http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/1ae8b3ea/en-US/vr-monitor.xml
----------------------------------------------------------------------
diff --git a/en-US/vr-monitor.xml b/en-US/vr-monitor.xml
new file mode 100644
index 0000000..6444185
--- /dev/null
+++ b/en-US/vr-monitor.xml
@@ -0,0 +1,115 @@
+<?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="vr-monitor">
+  <title>Service Monitoring Tool for Virtual Router</title>
+  <para>Various services running on the &PRODUCT; virtual routers can be monitored by using a
+    Service Monitoring tool. The tool ensures that services are successfully running until &PRODUCT;
+    deliberately disables them. If a service goes down, the tool automatically restarts the VR, and
+    if that does not bring up the VR, an alert as well as an event is generated indicating the
+    failure.</para>
+  <para>Monitoring tool can help to start a VR service, which is crashed due to an unexpected
+    reason. For example:</para>
+  <itemizedlist>
+    <listitem>
+      <para>The services crashed due to defects in the source code.</para>
+    </listitem>
+    <listitem>
+      <para>The services that are terminated by the OS when memory or CPU is not sufficiently
+        available for the service.</para>
+    </listitem>
+  </itemizedlist>
+  <note>
+    <para>Only those services with daemons are monitored. The services that are failed due to errors in the service/daemon configuration file cannot
+      be restarted by the Monitoring tool.</para>
+  </note>
+  <para>The following services are monitored in a VR:</para>
+  <itemizedlist>
+    <listitem>
+      <para>DNS</para>
+    </listitem>
+    <listitem>
+      <para>HA Proxy</para>
+    </listitem>
+    <listitem>
+      <para>SSH</para>
+    </listitem>
+    <listitem>
+      <para>Apache Web Server</para>
+    </listitem>
+  </itemizedlist>
+  <para>The following networks are supported:</para>
+  <itemizedlist>
+    <listitem>
+      <para>Isolated Networks</para>
+    </listitem>
+    <listitem>
+      <para>Shared Networks in both Advanced and Basic zone</para>
+    </listitem>
+  </itemizedlist>
+  <para>The following table lists down various scenarios for virtual router and corresponding
+    actions taken by &PRODUCT;.</para>
+  <informaltable>
+    <tgroup cols="2" align="left" colsep="1" rowsep="1">
+      <colspec colwidth="1.0*" colname="1" colnum="1"/>
+      <colspec colwidth="9.87*" colname="2" colnum="2"/>
+      <thead>
+        <row>
+          <entry><para>Scenarios</para></entry>
+          <entry><para>Action Taken by &PRODUCT;</para></entry>
+        </row>
+      </thead>
+      <tbody>
+        <row>
+          <entry><para>VR is shutdown externally.</para></entry>
+          <entry><para>&PRODUCT; brings it up into running state.</para></entry>
+        </row>
+        <row>
+          <entry><para>VR is shutdown internally.</para></entry>
+          <entry><para>VR continues to stay in stopped state. &PRODUCT;will not automatically change
+              the VR state into running.</para></entry>
+        </row>
+        <row>
+          <entry><para>VR is stopped and VM is deployed in that network.</para></entry>
+          <entry><para>VR state is automatically changed into running state during the VM deployment
+              process.</para></entry>
+        </row>
+        <row>
+          <entry><para>VR is destroyed internally.</para></entry>
+          <entry><para>&PRODUCT; will not automatically spin up a new router.</para></entry>
+        </row>
+        <row>
+          <entry><para>Deploy a VM in a network where router is destroyed by
+            &PRODUCT;.</para></entry>
+          <entry><para>&PRODUCT; spins up a new router.</para></entry>
+        </row>
+        <row>
+          <entry><para>Running VR is destroyed externally.</para></entry>
+          <entry><para>&PRODUCT; shows that the VR is stopped. The router will not be brought back
+              to running state.</para></entry>
+        </row>
+      </tbody>
+    </tgroup>
+  </informaltable>
+  <para>This feature is supported on the following hypervisors: XenServer, VMware, and KVM.</para>
+</section>