You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@karaf.apache.org by jb...@apache.org on 2012/02/27 09:19:47 UTC
svn commit: r1294057 - in /karaf/cellar/branches/cellar-2.2.x/manual: ./
src/main/webapp/ src/main/webapp/images/ src/main/webapp/user-guide/
Author: jbonofre
Date: Mon Feb 27 08:19:46 2012
New Revision: 1294057
URL: http://svn.apache.org/viewvc?rev=1294057&view=rev
Log:
Add a topology section in the Cellar manual and fix the manual build
Added:
karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/images/cross_topology.jpg
karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/images/star_topology.jpg
karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/user-guide/introduction.conf
Modified:
karaf/cellar/branches/cellar-2.2.x/manual/pom.xml
karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/index.conf
karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/manual.conf
karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/user-guide/index.conf
Modified: karaf/cellar/branches/cellar-2.2.x/manual/pom.xml
URL: http://svn.apache.org/viewvc/karaf/cellar/branches/cellar-2.2.x/manual/pom.xml?rev=1294057&r1=1294056&r2=1294057&view=diff
==============================================================================
--- karaf/cellar/branches/cellar-2.2.x/manual/pom.xml (original)
+++ karaf/cellar/branches/cellar-2.2.x/manual/pom.xml Mon Feb 27 08:19:46 2012
@@ -216,10 +216,19 @@
javax.servlet.http,
org.osgi.framework,
org.osgi.service.packageadmin,
- javax.swing.tree,
+ javax.swing*,
+ javax.xml*,
+ javax.ws.rs*,
+ org.w3c.dom,
+ org.xml.sax*,
+ sun.misc;resolution:=optional,
+ jline;resolution:=optional,
+ org.apache.tools.ant*;resolution:=optional,
+ org.fusesource.scalamd;resolution:=optional,
+ com.sun.jersey*;resolution:=optional,
org.apache.commons.logging;provider=paxlogging;resolution:=optional,
org.apache.log4j;provider=paxlogging;resolution:=optional,
- org.slf4j;provider=paxlogging;resolution:=optional;version="[1.5,2)",
+ org.slf4j*;provider=paxlogging;resolution:=optional;version="[1.5,2)",
</Import-Package>
<Bundle-ClassPath>.,WEB-INF/classes</Bundle-ClassPath>
<Embed-Directory>WEB-INF/lib</Embed-Directory>
Added: karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/images/cross_topology.jpg
URL: http://svn.apache.org/viewvc/karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/images/cross_topology.jpg?rev=1294057&view=auto
==============================================================================
Files karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/images/cross_topology.jpg (added) and karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/images/cross_topology.jpg Mon Feb 27 08:19:46 2012 differ
Added: karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/images/star_topology.jpg
URL: http://svn.apache.org/viewvc/karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/images/star_topology.jpg?rev=1294057&view=auto
==============================================================================
Files karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/images/star_topology.jpg (added) and karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/images/star_topology.jpg Mon Feb 27 08:19:46 2012 differ
Modified: karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/index.conf
URL: http://svn.apache.org/viewvc/karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/index.conf?rev=1294057&r1=1294056&r2=1294057&view=diff
==============================================================================
--- karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/index.conf (original)
+++ karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/index.conf Mon Feb 27 08:19:46 2012
@@ -2,6 +2,6 @@ h1. Apache Karaf Cellar
This project contains documentation about Apache Karaf Cellar.
-* [Karaf Cellar Overview|overview]
+* [Overview|overview]
* [User Guide|user-guide/index]
* [Architecture Guide|architecture-guide/index]
Modified: karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/manual.conf
URL: http://svn.apache.org/viewvc/karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/manual.conf?rev=1294057&r1=1294056&r2=1294057&view=diff
==============================================================================
--- karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/manual.conf (original)
+++ karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/manual.conf Mon Feb 27 08:19:46 2012
@@ -29,6 +29,7 @@ h1. Overview
{include:overview.conf}
h1. User Guide
+{include:user-guide/introduction.conf}
{include:user-guide/installation.conf}
{include:user-guide/deploy.conf}
{include:user-guide/nodes.conf}
Modified: karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/user-guide/index.conf
URL: http://svn.apache.org/viewvc/karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/user-guide/index.conf?rev=1294057&r1=1294056&r2=1294057&view=diff
==============================================================================
--- karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/user-guide/index.conf (original)
+++ karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/user-guide/index.conf Mon Feb 27 08:19:46 2012
@@ -1,5 +1,6 @@
h1. Karaf Cellar User Guide
+* [Karaf Cellar Introduction|/user-guide/introduction]
* [Installing Karaf Cellar|/user-guide/installation]
* [Start Karaf Cellar|/user-guide/deploy]
* [Nodes in Karaf Cellar|/user-guide/nodes]
Added: karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/user-guide/introduction.conf
URL: http://svn.apache.org/viewvc/karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/user-guide/introduction.conf?rev=1294057&view=auto
==============================================================================
--- karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/user-guide/introduction.conf (added)
+++ karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/user-guide/introduction.conf Mon Feb 27 08:19:46 2012
@@ -0,0 +1,76 @@
+h1. Introduction
+
+h2. Karaf Cellar use cases
+
+The first purpose of Cellar is to synchronize the state of several Karaf instances (named nodes).
+
+It means that all resources modified (installed, started, etc) on one Karaf instance will be propagated to all others
+nodes.
+Concretely, Cellar will broadcast an event to others nodes when you perform an action.
+
+The nodes list could be discovered (using multicast/unicast), or explicitly defined (using a couple hostname or IP
+and port list).
+
+Cellar is able to synchronize:
+- bundles (remote, local, or from an OBR)
+- config
+- features
+
+The second purpose is to provide a Distributed OSGi runtime. It means that using Cellar, you are able to call an OSGi
+service located on a remote instance. See the [Transport and DOSGi] section of the user guide.
+
+h2. Cellar network
+
+Cellar relies on Hazelcast (http://www.hazelcast.com), a memory data grid implementation.
+
+You have a full access to the Hazelcast configuration (in etc/hazelcast.xml) allowing you to specify the network
+configuration.
+
+Especially, you can enable or not the multicast support and choose the multicast group and port number.
+
+You can also configure on which interface and IP address you configure Cellar and port number used by Cellar:
+
+{code}
+ <network>
+ <port auto-increment="true">5701</port>
+ <join>
+ <multicast enabled="true">
+ <multicast-group>224.2.2.3</multicast-group>
+ <multicast-port>54327</multicast-port>
+ </multicast>
+ <tcp-ip enabled="false">
+ <interface>127.0.0.1</interface>
+ </tcp-ip>
+ <aws enabled="false">
+ <access-key>my-access-key</access-key>
+ <secret-key>my-secret-key</secret-key>
+ <region>us-east-1</region>
+ </aws>
+ </join>
+ <interfaces enabled="false">
+ <interface>10.10.1.*</interface>
+ </interfaces>
+ </network>
+{code}
+
+By default, the Cellar node will start from network port 5701, each new node will use an incremented port number.
+
+h2. Cross topology
+
+!/images/cross_topology.jpg!
+
+This is the default Cellar topology. Cellar is installed on every nodes, each node has the same function.
+
+It means that you can perform actions on any node, it will be broadcasted to all others nodes.
+
+h2. Star topology
+
+!/images/star_topology.jpg!
+
+In this topology, if Cellar is installed on all nodes, you perform actions only on one specific node (the "manager").
+
+To do that, the "manager" is a standard Cellar node, and the event producing is disable on all others nodes
+(cluster:producer-stop on all "managed" nodes).
+
+Like this, only the "manager" will send event to the nodes (which are able to consumer and handle), but no event can
+be produced on the nodes.
\ No newline at end of file