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 2013/04/19 17:14:58 UTC
svn commit: r1469885 - in
/karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp: ./ user-guide/
Author: jbonofre
Date: Fri Apr 19 15:14:57 2013
New Revision: 1469885
URL: http://svn.apache.org/r1469885
Log:
Update Cellar documentation
Modified:
karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/manual.conf
karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/cloud.conf
karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/deploy.conf
karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/event.conf
karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/groups.conf
karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/installation.conf
karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/introduction.conf
karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/nodes.conf
Modified: karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/manual.conf
URL: http://svn.apache.org/viewvc/karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/manual.conf?rev=1469885&r1=1469884&r2=1469885&view=diff
==============================================================================
--- karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/manual.conf (original)
+++ karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/manual.conf Fri Apr 19 15:14:57 2013
@@ -6,7 +6,7 @@
\\
\\
Apache Karaf Cellar
-User Guide
+Manual
\\
\\
\\
@@ -14,7 +14,7 @@ User Guide
{div}
{div:class=copyright-section}
-Copyright 2011 The Apache Software Foundation
+Copyright 2013 The Apache Software Foundation
The PDF format of the Karaf Manual has been generated by Prince XML (http://www.princexml.com).
{div}
Modified: karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/cloud.conf
URL: http://svn.apache.org/viewvc/karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/cloud.conf?rev=1469885&r1=1469884&r2=1469885&view=diff
==============================================================================
--- karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/cloud.conf (original)
+++ karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/cloud.conf Fri Apr 19 15:14:57 2013
@@ -16,7 +16,6 @@ h2. Installing Cellar cloud discovery se
To install the cloud discovery service simply the appropriate jclouds provider and then install cellar-cloud feature. For the rest of this manual I will use amazon s3 as an example, but it applies to any provider supported by jclouds.
{code}
-features:install jclouds-aws-s3
features:install cellar-cloud
{code}
Modified: karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/deploy.conf
URL: http://svn.apache.org/viewvc/karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/deploy.conf?rev=1469885&r1=1469884&r2=1469885&view=diff
==============================================================================
--- karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/deploy.conf (original)
+++ karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/deploy.conf Fri Apr 19 15:14:57 2013
@@ -10,15 +10,27 @@ Karaf Cellar is provided as a Karaf feat
Simply register the Cellar feature URL in your Karaf instance:
{code}
-karaf@root> features:addurl mvn:org.apache.karaf.cellar/apache-karaf-cellar/2.2.1/xml/features
+karaf@root> features:addurl mvn:org.apache.karaf.cellar/apache-karaf-cellar/2.3.0/xml/features
{code}
Now you have Cellar features available in your Karaf instance:
{code}
-karaf@root> features:list|grep -i cellar
-[uninstalled] [2.2.1 ] cellar Karaf clustering
-[uninstalled] [2.2.1 ] cellar-webconsole Karaf Cellar Webconsole Plugin
+karaf@node1> features:list|grep -i cellar
+[uninstalled] [2.3.0 ] cellar-core karaf-cellar-2.3.0 Karaf clustering core
+[uninstalled] [2.5 ] hazelcast karaf-cellar-2.3.0 In memory data grid
+[uninstalled] [2.3.0 ] cellar-hazelcast karaf-cellar-2.3.0 Cellar implementation based on Hazelcast
+[uninstalled] [2.3.0 ] cellar-config karaf-cellar-2.3.0 ConfigAdmin cluster support
+[uninstalled] [2.3.0 ] cellar-features karaf-cellar-2.3.0 Karaf features cluster support
+[uninstalled] [2.3.0 ] cellar-bundle karaf-cellar-2.3.0 Bundle cluster support
+[uninstalled] [2.3.0 ] cellar-shell karaf-cellar-2.3.0 Cellar shell commands
+[uninstalled] [2.3.0 ] cellar-management karaf-cellar-2.3.0 Cellar management
+[uninstalled] [2.3.0 ] cellar karaf-cellar-2.3.0 Karaf clustering
+[uninstalled] [2.3.0 ] cellar-dosgi karaf-cellar-2.3.0 DOSGi support
+[uninstalled] [2.3.0 ] cellar-obr karaf-cellar-2.3.0 OBR cluster support
+[uninstalled] [2.3.0 ] cellar-event karaf-cellar-2.3.0 OSGi events broadcasting in clusters
+[uninstalled] [2.3.0 ] cellar-cloud karaf-cellar-2.3.0 Cloud blobstore support in clusters
+[uninstalled] [2.3.0 ] cellar-webconsole karaf-cellar-2.3.0 Cellar plugin for Karaf WebConsole
{code}
h2. Starting Cellar
@@ -32,14 +44,15 @@ karaf@root> features:install cellar
You can now see the Cellar components (bundles) installed:
{code}
-karaf@root> la|grep -i cellar
-[ 56] [Active ] [Created ] [ ] [ 60] Apache Karaf :: Cellar :: Core (2.2.1)
-[ 57] [Active ] [Created ] [ ] [ 60] Apache Karaf :: Cellar :: Config (2.2.1)
-[ 58] [Active ] [Created ] [ ] [ 60] Apache Karaf :: Cellar :: Features (2.2.1)
-[ 59] [Active ] [Created ] [ ] [ 60] Apache Karaf :: Cellar :: Bundle (2.2.1)
-[ 60] [Active ] [Created ] [ ] [ 60] Apache Karaf :: Cellar :: Utils (2.2.1)
-[ 61] [Active ] [Created ] [ ] [ 60] Apache Karaf :: Cellar :: Shell (2.2.1)
-[ 62] [Active ] [ ] [ ] [ 60] Apache Karaf :: Cellar :: Hazelcast (2.2.1)
+karaf@node1> la|grep -i cellar
+[ 55] [Active ] [Created ] [ 30] Apache Karaf :: Cellar :: Core (2.3.0)
+[ 56] [Active ] [Created ] [ 31] Apache Karaf :: Cellar :: Utils (2.3.0)
+[ 57] [Active ] [Created ] [ 33] Apache Karaf :: Cellar :: Hazelcast (2.3.0)
+[ 58] [Active ] [Created ] [ 40] Apache Karaf :: Cellar :: Shell (2.3.0)
+[ 59] [Active ] [Created ] [ 40] Apache Karaf :: Cellar :: Config (2.3.0)
+[ 60] [Active ] [Created ] [ 40] Apache Karaf :: Cellar :: Bundle (2.3.0)
+[ 61] [Active ] [Created ] [ 40] Apache Karaf :: Cellar :: Features (2.3.0)
+[ 62] [Active ] [Created ] [ 40] Apache Karaf :: Cellar :: Management (2.3.0)
{code}
And Cellar cluster commands are now available:
Modified: karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/event.conf
URL: http://svn.apache.org/viewvc/karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/event.conf?rev=1469885&r1=1469884&r2=1469885&view=diff
==============================================================================
--- karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/event.conf (original)
+++ karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/event.conf Fri Apr 19 15:14:57 2013
@@ -10,7 +10,7 @@ OSGi Event Broadcasting is an optional f
karaf@root> feature:install cellar-event
{code}
-Of course, it Cellar is already installed, you can use Cellar itself to install cellar-event feature on all nodes:
+Of course, if Cellar is already installed, you can use Cellar itself to install cellar-event feature on all nodes:
{code}
karaf@root> cluster:feature-install group cellar-event
Modified: karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/groups.conf
URL: http://svn.apache.org/viewvc/karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/groups.conf?rev=1469885&r1=1469884&r2=1469885&view=diff
==============================================================================
--- karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/groups.conf (original)
+++ karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/groups.conf Fri Apr 19 15:14:57 2013
@@ -7,10 +7,9 @@ a node within a group.
By default, the Cellar nodes go into the default group:
{code}
-karaf@root> cluster:group-list
- Node Group
-* node1.local:5701 default
- node2.local:5702 default
+karaf@node1> cluster:group-list
+ Group Members
+* [default ] [vostro.local:5701* ]
{code}
As for node, the starting * shows the local node/group.
@@ -21,21 +20,30 @@ You can create a new group using the gro
{code}
karaf@root> cluster:group-create test
-Name test
-Members []
-
{code}
For now, the test group hasn't any nodes:
{code}
-kaaf@root> cluster:group-list
- Node Group
- node1.local:5701 default
-* node2.local:5702 default
- test
+karaf@node1> cluster:group-list
+ Group Members
+* [default ] [vostro.local:5701* ]
+ [test ] []
+{code}
+
+You can use cluster:group-join, cluster:group-quit, cluster:group-set commands to add/remove a node into a cluster group.
+
+For instance, to set the local into the test cluster group:
{code}
+karaf@node1> cluster:group-join test
+{code}
+
+The cluster:group-delete command deletes the given cluster group:
+
+{code}
+karaf@node1> cluster:group-delete test
+{code}
h2. Group configuration
Modified: karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/installation.conf
URL: http://svn.apache.org/viewvc/karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/installation.conf?rev=1469885&r1=1469884&r2=1469885&view=diff
==============================================================================
--- karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/installation.conf (original)
+++ karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/installation.conf Fri Apr 19 15:14:57 2013
@@ -6,6 +6,12 @@ h2. Pre-Installation Requirements
As Cellar is a Karaf sub-project, you need a running Karaf instance.
+Check in etc/config.properties of your Karaf instances, if the following property is set:
+
+{code}
+org.apache.aries.blueprint.synchronous=true
+{code}
+
Karaf Cellar is provided under a Karaf features descriptor. The easiest way to install is just to
have an internet connection from the Karaf running instance.
Modified: karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/introduction.conf
URL: http://svn.apache.org/viewvc/karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/introduction.conf?rev=1469885&r1=1469884&r2=1469885&view=diff
==============================================================================
--- karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/introduction.conf (original)
+++ karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/introduction.conf Fri Apr 19 15:14:57 2013
@@ -15,6 +15,8 @@ Cellar is able to synchronize:
- bundles (remote, local, or from an OBR)
- config
- features
+- OSGi events (optional)
+- OBR events (optional)
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.
Modified: karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/nodes.conf
URL: http://svn.apache.org/viewvc/karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/nodes.conf?rev=1469885&r1=1469884&r2=1469885&view=diff
==============================================================================
--- karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/nodes.conf (original)
+++ karaf/cellar/branches/cellar-2.3.x/manual/src/main/webapp/user-guide/nodes.conf Fri Apr 19 15:14:57 2013
@@ -10,10 +10,9 @@ and hence tries to discover the others C
You can list the known Cellar nodes using the list-nodes command:
{code}
-karaf@root> cluster:list-nodes
- No. Host Name Port ID
-* 1 node1.local 5701 node1.local:5701
- 2 node2.local 5702 node2.local:5702
+karaf@node1> cluster:node-list
+ ID Host Name Port
+* [vostro.local:5701 ] [vostro.local ] [ 5701]
{code}
The starting * indicates that it's the Karaf instance on which you are logged on (the local node).
@@ -23,11 +22,12 @@ h2. Testing nodes
You can ping a node to test it:
{code}
-karaf@root> cluster:ping node2.local:5702
-Pinging node :node2.local:5702
-PING 1 node2.local:5702 82ms
-PING 2 node2.local:5702 11ms
-PING 3 node2.local:5702 14ms
+karaf@node1> cluster:node-ping vostro.local:5701
+PING vostro.local:5701
+from 1: req=vostro.local:5701 time=67 ms
+from 2: req=vostro.local:5701 time=10 ms
+from 3: req=vostro.local:5701 time=8 ms
+from 4: req=vostro.local:5701 time=9 ms
{code}
h2. Nodes sync