cloudstack-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject [22/50] [abbrv] git commit: refs/heads/affinity_groups - CLOUDSTACK-820-documentation for event framework
Date Thu, 14 Mar 2013 22:35:17 GMT
CLOUDSTACK-820-documentation for event framework


Branch: refs/heads/affinity_groups
Commit: 76c072a86d8c34e9dc3d99a66d06be76a2b6ae4c
Parents: 76f2a34
Author: Radhika PC <>
Authored: Wed Feb 27 18:00:31 2013 +0530
Committer: Prachi Damle <>
Committed: Thu Mar 14 15:12:51 2013 -0700

 docs/en-US/event-framework.xml |  110 +++++++++++++++++++++++++++++++++++
 docs/en-US/events.xml          |   18 ++++--
 2 files changed, 122 insertions(+), 6 deletions(-)
diff --git a/docs/en-US/event-framework.xml b/docs/en-US/event-framework.xml
new file mode 100644
index 0000000..88c45c9
--- /dev/null
+++ b/docs/en-US/event-framework.xml
@@ -0,0 +1,110 @@
+<?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="event-framework">
+  <title>Event Notification</title>
+  <para>Event notification framework provides a means for the Management Server components
+    publish and subscribe to &PRODUCT; events. Event notification is achieved by implementing
+    concept of event bus abstraction in the Management Server. An event bus is introduced
in the
+    Management Server that allows the &PRODUCT;components and extension plug-ins to subscribe
to the
+    events by using the Advanced Message Queuing Protocol (AMQP) client. In &PRODUCT;,
a default
+    implementation of event bus is provided as a plug-in that uses the RabbitMQ AMQP client.
+    AMQP client pushes the published events to a compatible AMQP server. Therefore all the
+    events are published to an exchange in the AMQP server. </para>
+  <para>A new event for state change, resource state change, is introduced as part
of Event
+    notification framework. Every resource, such as user VM, volume, NIC, network, public
+    snapshot, and template, is associated with a state machine and generates events as part
of the
+    state change. That implies that a change in the state of a resource results in a state
+    event, and the event is published in the corresponding state machine on the event bus.
All the
+    &PRODUCT; events (alerts, action events, usage events) and the additional category
of resource
+    state change events, are published on to the events bus.</para>
+  <formalpara>
+    <title>Use Cases</title>
+    <para>The following are some of the use cases:</para>
+  </formalpara>
+  <itemizedlist>
+    <listitem>
+      <para>Usage or Billing Engines: A third-party cloud usage solution can implement
a plug-in
+        that can connects to &PRODUCT; to subscribe to &PRODUCT; events and generate
usage data. The
+        usage data is consumed by their usage software.</para>
+    </listitem>
+    <listitem>
+      <para>AMQP plug-in can place all the events on the a message queue, then a AMQP
message broker
+        can provide topic-based notification to the subscribers.</para>
+    </listitem>
+    <listitem>
+      <para>Publish and Subscribe notification service can be implemented as a pluggable
service in
+        &PRODUCT; that can provide rich set of APIs for event notification, such as topics-based
+        subscription and notification. Additionally, the pluggable service can deal with
+        multi-tenancy, authentication, and authorization issues.</para>
+    </listitem>
+  </itemizedlist>
+  <formalpara>
+    <title>Configuration</title>
+    <para>As a &PRODUCT; administrator, perform the following one-time configuration
to enable event
+      notification framework. At run time no changes can control the behaviour.</para>
+  </formalpara>
+  <orderedlist>
+    <listitem>
+      <para>Open <filename>'componentContext.xml</filename>.</para>
+    </listitem>
+    <listitem>
+      <para>Define a bean named <filename>eventNotificationBus</filename>
as follows:</para>
+      <itemizedlist>
+        <listitem>
+          <para>name : Specify a name for the bean.</para>
+        </listitem>
+        <listitem>
+          <para>server : The name or the IP address of the RabbitMQ AMQP server.</para>
+        </listitem>
+        <listitem>
+          <para>port : The port on which RabbitMQ server is running.</para>
+        </listitem>
+        <listitem>
+          <para>username : The username associated with the account to access the RabbitMQ
+            server.</para>
+        </listitem>
+        <listitem>
+          <para>password : The password associated with the username of the account
to access the
+            RabbitMQ server.</para>
+        </listitem>
+        <listitem>
+          <para>exchange : The exchange name on the RabbitMQ server where &PRODUCT;
events are
+            published.</para>
+          <para>A sample bean is given below:</para>
+          <programlisting>&lt;bean id="eventNotificationBus" class=""&gt;
+    &lt;property name="name" value="eventNotificationBus"/&gt;
+    &lt;property name="server" value=""/&gt;
+    &lt;property name="port" value="5672"/&gt;
+    &lt;property name="username" value="guest"/&gt;
+    &lt;property name="password" value="guest"/&gt;
+   &lt;property name="exchange" value="cloudstack-events"/&gt;
+   &lt;/bean&gt;</programlisting>
+          <para>The <filename>eventNotificationBus</filename> bean represents
+              <filename></filename>
+        </listitem>
+      </itemizedlist>
+    </listitem>
+    <listitem>
+      <para>Restart the Management Server.</para>
+    </listitem>
+  </orderedlist>
diff --git a/docs/en-US/events.xml b/docs/en-US/events.xml
index 242ff45..49ef86e 100644
--- a/docs/en-US/events.xml
+++ b/docs/en-US/events.xml
@@ -21,11 +21,17 @@
     specific language governing permissions and limitations
     under the License.
 <section id="events">
-    <title>Events</title>
-    <xi:include href="events-log.xml" xmlns:xi="" />
-    <xi:include href="standard-events.xml" xmlns:xi=""
-    <xi:include href="long-running-job-events.xml" xmlns:xi=""
-    <xi:include href="event-log-queries.xml" xmlns:xi=""
+  <title>Events</title>
+  <para>An event is essentially a significant or meaningful change in the state of
both virtual and
+    physical resources associated with a cloud environment. Events are used by monitoring
+    usage and billing systems, or any other event-driven workflow systems to discern a pattern
+    make the right business decision. In &PRODUCT; an event could be a state change of
virtual or
+    psychical resources, an action performed by an user (action events), or policy based
+    (alerts).</para>
+  <xi:include href="events-log.xml" xmlns:xi=""/>
+  <xi:include href="event-framework.xml" xmlns:xi=""/>
+  <xi:include href="standard-events.xml" xmlns:xi=""/>
+  <xi:include href="long-running-job-events.xml" xmlns:xi=""/>
+  <xi:include href="event-log-queries.xml" xmlns:xi=""/>

View raw message