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 2015/01/29 10:13:24 UTC
svn commit: r1655556 - in /karaf/site/production/manual/cellar/latest: ./
architecture-guide/ user-guide/
Author: jbonofre
Date: Thu Jan 29 09:13:24 2015
New Revision: 1655556
URL: http://svn.apache.org/r1655556
Log:
[scm-publish] Updating main site with Karaf Cellar manual
Added:
karaf/site/production/manual/cellar/latest/user-guide/hazelcast.html
Modified:
karaf/site/production/manual/cellar/latest/architecture-guide/broadcasting_commands.html
karaf/site/production/manual/cellar/latest/architecture-guide/design.html
karaf/site/production/manual/cellar/latest/architecture-guide/hazelcast.html
karaf/site/production/manual/cellar/latest/architecture-guide/index.html
karaf/site/production/manual/cellar/latest/architecture-guide/overview.html
karaf/site/production/manual/cellar/latest/architecture-guide/supported_events.html
karaf/site/production/manual/cellar/latest/index.html
karaf/site/production/manual/cellar/latest/overview.html
karaf/site/production/manual/cellar/latest/user-guide/cloud.html
karaf/site/production/manual/cellar/latest/user-guide/deploy.html
karaf/site/production/manual/cellar/latest/user-guide/event.html
karaf/site/production/manual/cellar/latest/user-guide/groups.html
karaf/site/production/manual/cellar/latest/user-guide/index.html
karaf/site/production/manual/cellar/latest/user-guide/installation.html
karaf/site/production/manual/cellar/latest/user-guide/introduction.html
karaf/site/production/manual/cellar/latest/user-guide/nodes.html
karaf/site/production/manual/cellar/latest/user-guide/obr.html
karaf/site/production/manual/cellar/latest/user-guide/services_registries.html
karaf/site/production/manual/cellar/latest/user-guide/transport.html
Modified: karaf/site/production/manual/cellar/latest/architecture-guide/broadcasting_commands.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/cellar/latest/architecture-guide/broadcasting_commands.html?rev=1655556&r1=1655555&r2=1655556&view=diff
==============================================================================
--- karaf/site/production/manual/cellar/latest/architecture-guide/broadcasting_commands.html (original)
+++ karaf/site/production/manual/cellar/latest/architecture-guide/broadcasting_commands.html Thu Jan 29 09:13:24 2015
@@ -8,7 +8,7 @@
<link href="../css/style.css" rel="stylesheet" type="text/css"/>
<link href="../css/pygmentize.css" rel="stylesheet" type="text/css"/>
<title>
- Apache Karaf Cellar 3.0.0 Guides
+ Apache Karaf Cellar 3.0.2-SNAPSHOT Guides
</title>
</head>
<body>
Modified: karaf/site/production/manual/cellar/latest/architecture-guide/design.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/cellar/latest/architecture-guide/design.html?rev=1655556&r1=1655555&r2=1655556&view=diff
==============================================================================
--- karaf/site/production/manual/cellar/latest/architecture-guide/design.html (original)
+++ karaf/site/production/manual/cellar/latest/architecture-guide/design.html Thu Jan 29 09:13:24 2015
@@ -8,7 +8,7 @@
<link href="../css/style.css" rel="stylesheet" type="text/css"/>
<link href="../css/pygmentize.css" rel="stylesheet" type="text/css"/>
<title>
- Apache Karaf Cellar 3.0.0 Guides
+ Apache Karaf Cellar 3.0.2-SNAPSHOT Guides
</title>
</head>
<body>
Modified: karaf/site/production/manual/cellar/latest/architecture-guide/hazelcast.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/cellar/latest/architecture-guide/hazelcast.html?rev=1655556&r1=1655555&r2=1655556&view=diff
==============================================================================
--- karaf/site/production/manual/cellar/latest/architecture-guide/hazelcast.html (original)
+++ karaf/site/production/manual/cellar/latest/architecture-guide/hazelcast.html Thu Jan 29 09:13:24 2015
@@ -8,7 +8,7 @@
<link href="../css/style.css" rel="stylesheet" type="text/css"/>
<link href="../css/pygmentize.css" rel="stylesheet" type="text/css"/>
<title>
- Apache Karaf Cellar 3.0.0 Guides
+ Apache Karaf Cellar 3.0.2-SNAPSHOT Guides
</title>
</head>
<body>
Modified: karaf/site/production/manual/cellar/latest/architecture-guide/index.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/cellar/latest/architecture-guide/index.html?rev=1655556&r1=1655555&r2=1655556&view=diff
==============================================================================
--- karaf/site/production/manual/cellar/latest/architecture-guide/index.html (original)
+++ karaf/site/production/manual/cellar/latest/architecture-guide/index.html Thu Jan 29 09:13:24 2015
@@ -8,7 +8,7 @@
<link href="../css/style.css" rel="stylesheet" type="text/css"/>
<link href="../css/pygmentize.css" rel="stylesheet" type="text/css"/>
<title>
- Apache Karaf Cellar 3.0.0 Guides
+ Apache Karaf Cellar 3.0.2-SNAPSHOT Guides
</title>
</head>
<body>
Modified: karaf/site/production/manual/cellar/latest/architecture-guide/overview.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/cellar/latest/architecture-guide/overview.html?rev=1655556&r1=1655555&r2=1655556&view=diff
==============================================================================
--- karaf/site/production/manual/cellar/latest/architecture-guide/overview.html (original)
+++ karaf/site/production/manual/cellar/latest/architecture-guide/overview.html Thu Jan 29 09:13:24 2015
@@ -8,7 +8,7 @@
<link href="../css/style.css" rel="stylesheet" type="text/css"/>
<link href="../css/pygmentize.css" rel="stylesheet" type="text/css"/>
<title>
- Apache Karaf Cellar 3.0.0 Guides
+ Apache Karaf Cellar 3.0.2-SNAPSHOT Guides
</title>
</head>
<body>
Modified: karaf/site/production/manual/cellar/latest/architecture-guide/supported_events.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/cellar/latest/architecture-guide/supported_events.html?rev=1655556&r1=1655555&r2=1655556&view=diff
==============================================================================
--- karaf/site/production/manual/cellar/latest/architecture-guide/supported_events.html (original)
+++ karaf/site/production/manual/cellar/latest/architecture-guide/supported_events.html Thu Jan 29 09:13:24 2015
@@ -8,7 +8,7 @@
<link href="../css/style.css" rel="stylesheet" type="text/css"/>
<link href="../css/pygmentize.css" rel="stylesheet" type="text/css"/>
<title>
- Apache Karaf Cellar 3.0.0 Guides
+ Apache Karaf Cellar 3.0.2-SNAPSHOT Guides
</title>
</head>
<body>
Modified: karaf/site/production/manual/cellar/latest/index.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/cellar/latest/index.html?rev=1655556&r1=1655555&r2=1655556&view=diff
==============================================================================
--- karaf/site/production/manual/cellar/latest/index.html (original)
+++ karaf/site/production/manual/cellar/latest/index.html Thu Jan 29 09:13:24 2015
@@ -8,7 +8,7 @@
<link href="css/style.css" rel="stylesheet" type="text/css"/>
<link href="css/pygmentize.css" rel="stylesheet" type="text/css"/>
<title>
- Apache Karaf Cellar 3.0.0 Guides
+ Apache Karaf Cellar 3.0.2-SNAPSHOT Guides
</title>
</head>
<body>
Modified: karaf/site/production/manual/cellar/latest/overview.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/cellar/latest/overview.html?rev=1655556&r1=1655555&r2=1655556&view=diff
==============================================================================
--- karaf/site/production/manual/cellar/latest/overview.html (original)
+++ karaf/site/production/manual/cellar/latest/overview.html Thu Jan 29 09:13:24 2015
@@ -8,7 +8,7 @@
<link href="css/style.css" rel="stylesheet" type="text/css"/>
<link href="css/pygmentize.css" rel="stylesheet" type="text/css"/>
<title>
- Apache Karaf Cellar 3.0.0 Guides
+ Apache Karaf Cellar 3.0.2-SNAPSHOT Guides
</title>
</head>
<body>
Modified: karaf/site/production/manual/cellar/latest/user-guide/cloud.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/cellar/latest/user-guide/cloud.html?rev=1655556&r1=1655555&r2=1655556&view=diff
==============================================================================
--- karaf/site/production/manual/cellar/latest/user-guide/cloud.html (original)
+++ karaf/site/production/manual/cellar/latest/user-guide/cloud.html Thu Jan 29 09:13:24 2015
@@ -8,7 +8,7 @@
<link href="../css/style.css" rel="stylesheet" type="text/css"/>
<link href="../css/pygmentize.css" rel="stylesheet" type="text/css"/>
<title>
- Apache Karaf Cellar 3.0.0 Guides
+ Apache Karaf Cellar 3.0.2-SNAPSHOT Guides
</title>
</head>
<body>
@@ -34,7 +34,17 @@
<td id="cell-1-2">
<div style="padding: 5px;">
<div id="banner">
- <h1 id="Cellarclouddiscovery">Cellar cloud discovery</h1><p>Cellar relies on Hazelcast (http://www.hazelcast.com) in order to discover cluster nodes. This can happen either by using multicast or by unicast (specifying the ip address of each node).<br/>Unfortunately multicast is not allowed in most IaaS providers and the alternative of specifying all IP addresses creates maintenance difficulties, especially since in most cases the addresses are not known in advance.</p><p>Cellar solves this problem using a cloud discovery service powered by jclouds (http://www.jclouds.org).</p><h2 id="Clouddiscoveryservice">Cloud discovery service</h2><p>Most cloud providers provide cloud storage among other services. Cellar uses the cloud storage via jclouds, in order to determine the IP addresses of each node so that Hazelcast can find them.</p><p>This approach is also called blackboard and refers to the process where each node registers itself in a common storage are so that other no
des know its existence.</p><h2 id="InstallingCellarclouddiscoveryservice">Installing Cellar cloud discovery service</h2><p>To install the cloud discovery service simply install the appropriate jclouds provider and then install cellar-cloud feature.<br/>Amazon S3 is being used here for this example, but the below applies to any provider supported by jclouds.</p><pre>
+ <h1 id="DiscoveryServices">Discovery Services</h1><p>The Discovery Services allow you to use third party libraries to discover the nodes member of the Cellar cluster.</p><h2 id="jClouds">jClouds</h2><p>Cellar relies on Hazelcast (http://www.hazelcast.com) in order to discover cluster nodes. This can happen either by using unicast, multicast or specifying the ip address of each node.<br/>See the <a href="../architecture-guide/hazelcast.html">Core Configuration</a> section for details.</p><p>Unfortunately multicast is not allowed in most IaaS providers and the alternative of specifying all IP addresses creates maintenance difficulties, especially since in most cases the addresses are not known in advance.</p><p>Cellar solves this problem using a cloud discovery service powered by jclouds (http://jclouds.apache.org).</p><h3 id="Clouddiscoveryservice">Cloud discovery service</h3><p>Most cloud providers provide cloud storage among other services. Cellar uses the cloud stor
age via jclouds, in order to determine the IP addresses of each node so that Hazelcast can find them.</p><p>This approach is also called blackboard and refers to the process where each node registers itself in a common storage are so that other nodes know its existence.</p><h3 id="InstallingCellarclouddiscoveryservice">Installing Cellar cloud discovery service</h3><p>To install the cloud discovery service simply install the appropriate jclouds provider and then install cellar-cloud feature.<br/>Amazon S3 is being used here for this example, but the below applies to any provider supported by jclouds.</p><pre>
karaf@root()> feature:install jclouds-aws-s3
karaf@root()> feature:install cellar-cloud
-</pre><p>Once the feature is installed, you're required to create a configuration that contains credentials and the type of the cloud storage (aka blobstore).<br/>To do that add a configuration file under the etc folder with the name org.apache.karaf.cellar.cloud-<provider>.cfg and place the following information there:</p><p>provider=aws-s3 (this varies according to the blobstore provider)<br/>identity=<the identity of the blobstore account><br/>credential=<the credential/password of the blobstore account)<br/>container=<the name of the bucket><br/>validity=<the amount of time an entry is considered valid, after that time the entry is removed></p><p>After creating the file the service will check for new nodes. If new nodes are found the Hazelcast instance configuration will be updated and the instance restarted.</p>
\ No newline at end of file
+</pre><p>Once the feature is installed, you're required to create a configuration that contains credentials and the type of the cloud storage (aka blobstore).<br/>To do that add a configuration file under the etc folder with the name org.apache.karaf.cellar.cloud-<provider>.cfg and place the following information there:</p><p>provider=aws-s3 (this varies according to the blobstore provider)<br/>identity=<the identity of the blobstore account><br/>credential=<the credential/password of the blobstore account)<br/>container=<the name of the bucket><br/>validity=<the amount of time an entry is considered valid, after that time the entry is removed></p><p>After creating the file the service will check for new nodes. If new nodes are found the Hazelcast instance configuration will be updated and the instance restarted.</p><h2 id="Kubernetesdocker.io">Kubernetes & docker.io</h2><p><a href="http://kubernetes.io">Kubernetes</a> is an open source orchestration system for do
cker.io containers.<br/>It handles scheduling onto nodes in a compute cluster and actively manages workloads to ensure that their state matches<br/>the users declared intentions.<br/>Using the concepts of "labels", "pods", "replicationControllers" and "services", it groups the containers which make up<br/>an application into logical units for easy management and discovery.<br/>Following the aforementioned concept will most likely change how you package and provision your Karaf based applications.<br/>For instance, you will eventually have to provide a Docker image with a pre-configured Karaf, KAR files in deployment<br/>folder, etc. so that your Kubernetes container may bootstrap everything on boot.</p><p>The Cellar Kubernetes discovery service is a great complement to the Karaf docker.io feature (allowing you to easily<br/>create and manage docker.io images in and for Karaf).</p><h3 id="Kubernetesdiscoveryservice">Kubernetes discovery service</h3><p>In order to determine the IP add
ress of each node, so that Hazelcast can connect to them, the Kubernetes discovery service queries<br/>the Kubernetes API for containers labeled with the <em>pod.label.key</em> and <em>pod.label.key</em> specified in <em>etc/org.apache.karaf.cellar.kubernetes.cfg</em>.<br/>So, you <strong>must be sure</strong> to label your containers (pods) accordingly.<br/><strong>NOTE</strong>: Since environment variables are injected into all Kubernetes containers, they can access said API at:</p><pre>
+http://$KUBERNETES_RO_SERVICE_HOST:$KUBERNETES_RO_SERVICE_PORT
+</pre><p>After a Cellar node starts up, Kubernetes discovery service will configure Hazelcast with currently running Cellar nodes.<br/>Since Hazelcast follows a peer-to-peer all-shared topology, whenever nodes come up and down, the cluster will remain up-to-date.</p><h3 id="InstallingKubernetesdiscoveryservice">Installing Kubernetes discovery service</h3><p>To install the Kubernetes discovery service, simply install cellar-kubernetes feature.</p><pre>
+karaf@root()> feature:install cellar-kubernetes
+</pre><p>Once the feature is installed, a new configuration file for the Kubernetes discovery service will live in etc/org.apache.karaf.cellar.kubernetes.cfg with the following contents:</p><pre>
+#
+# Label selector used to idenfity Cellar nodes in Kubernetes cluster
+#
+pod.label.key = name
+pod.label.value = cellar
+</pre><p>In case you change the file, the discovery service will check again for new nodes. If new nodes are found, Hazelcast configuration will be<br/>updated and the instance restarted.</p>
\ No newline at end of file
Modified: karaf/site/production/manual/cellar/latest/user-guide/deploy.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/cellar/latest/user-guide/deploy.html?rev=1655556&r1=1655555&r2=1655556&view=diff
==============================================================================
--- karaf/site/production/manual/cellar/latest/user-guide/deploy.html (original)
+++ karaf/site/production/manual/cellar/latest/user-guide/deploy.html Thu Jan 29 09:13:24 2015
@@ -8,7 +8,7 @@
<link href="../css/style.css" rel="stylesheet" type="text/css"/>
<link href="../css/pygmentize.css" rel="stylesheet" type="text/css"/>
<title>
- Apache Karaf Cellar 3.0.0 Guides
+ Apache Karaf Cellar 3.0.2-SNAPSHOT Guides
</title>
</head>
<body>
@@ -35,38 +35,42 @@
<div style="padding: 5px;">
<div id="banner">
<h1 id="DeployCellar">Deploy Cellar</h1><p>This chapter describes how to deploy and start Cellar into a running Apache Karaf instance. This chapter<br/>assumes that you already know Apache Karaf basics, especially the notion of features and shell usage.</p><h2 id="RegisteringCellarfeatures">Registering Cellar features</h2><p>Karaf Cellar is provided as a Karaf features XML descriptor.</p><p>Simply register the Cellar feature URL in your Karaf instance:</p><pre>
-karaf@root()> feature:repo-add mvn:org.apache.karaf.cellar/apache-karaf-cellar/3.0.0-SNAPSHOT/xml/features
-Adding feature url mvn:org.apache.karaf.cellar/apache-karaf-cellar/3.0.0-SNAPSHOT/xml/features
+karaf@root()> feature:repo-add mvn:org.apache.karaf.cellar/apache-karaf-cellar/3.0.1/xml/features
+Adding feature url mvn:org.apache.karaf.cellar/apache-karaf-cellar/3.0.1/xml/features
</pre><p>Now you have Cellar features available in your Karaf instance:</p><pre>
karaf@root()> feature:list |grep -i cellar
-cellar-core | 3.0.0 | | karaf-cellar-3.0.0-SNAPSHOT | Karaf clustering core
-hazelcast | 3.2.3 | | karaf-cellar-3.0.0-SNAPSHOT | In memory data grid
-cellar-hazelcast | 3.0.0 | | karaf-cellar-3.0.0-SNAPSHOT | Cellar implementation based on Hazelcast
-cellar-config | 3.0.0 | | karaf-cellar-3.0.0-SNAPSHOT | ConfigAdmin cluster support
-cellar-features | 3.0.0 | | karaf-cellar-3.0.0-SNAPSHOT | Karaf features cluster support
-cellar-bundle | 3.0.0 | | karaf-cellar-3.0.0-SNAPSHOT | Bundle cluster support
-cellar-shell | 3.0.0 | | karaf-cellar-3.0.0-SNAPSHOT | Cellar shell support
-cellar | 3.0.0 | | karaf-cellar-3.0.0-SNAPSHOT | Karaf clustering
-cellar-dosgi | 3.0.0 | | karaf-cellar-3.0.0-SNAPSHOT | DOSGi support
-cellar-obr | 3.0.0 | | karaf-cellar-3.0.0-SNAPSHOT | OBR cluster support
-cellar-eventadmin | 3.0.0 | | karaf-cellar-3.0.0-SNAPSHOT | OSGi events broadcasting in clusters
-cellar-cloud | 3.0.0 | | karaf-cellar-3.0.0-SNAPSHOT | Cloud blobstore support in clusters
-cellar-webconsole | 3.0.0 | | karaf-cellar-3.0.0-SNAPSHOT | Cellar plugin for Karaf WebConsole
+cellar-core | 3.0.1 | | karaf-cellar-3.0.1 | Karaf clustering core
+hazelcast | 3.2.3 | | karaf-cellar-3.0.1 | In memory data grid
+cellar-hazelcast | 3.0.1 | | karaf-cellar-3.0.1 | Cellar implementation based on Hazelcast
+cellar-config | 3.0.1 | | karaf-cellar-3.0.1 | ConfigAdmin cluster support
+cellar-features | 3.0.1 | | karaf-cellar-3.0.1 | Karaf features cluster support
+cellar-bundle | 3.0.1 | | karaf-cellar-3.0.1 | Bundle cluster support
+cellar-shell | 3.0.1 | | karaf-cellar-3.0.1 | Cellar shell support
+cellar | 3.0.1 | | karaf-cellar-3.0.1 | Karaf clustering
+cellar-dosgi | 3.0.1 | | karaf-cellar-3.0.1 | DOSGi support
+cellar-obr | 3.0.1 | | karaf-cellar-3.0.1 | OBR cluster support
+cellar-eventadmin | 3.0.1 | | karaf-cellar-3.0.1 | OSGi events broadcasting in clusters
+cellar-cloud | 3.0.1 | | karaf-cellar-3.0.1 | Cloud blobstore support in clusters
+cellar-webconsole | 3.0.1 | | karaf-cellar-3.0.1 | Cellar plugin for Karaf WebConsole
</pre><h2 id="StartingCellar">Starting Cellar</h2><p>To start Cellar in your Karaf instance, you only need to install the Cellar feature:</p><pre>
karaf@root()> feature:install cellar
</pre><p>You can now see the Cellar components (bundles) installed:</p><pre>
karaf@root()> la|grep -i cellar
-80 | Active | 30 | 3.0.0 | Apache Karaf :: Cellar :: Core
-81 | Active | 31 | 3.0.0 | Apache Karaf :: Cellar :: Utils
-82 | Active | 33 | 3.0.0 | Apache Karaf :: Cellar :: Hazelcast
-83 | Active | 40 | 3.0.0 | Apache Karaf :: Cellar :: Shell
-84 | Active | 40 | 3.0.0 | Apache Karaf :: Cellar :: Config
-85 | Active | 40 | 3.0.0 | Apache Karaf :: Cellar :: Bundle
-86 | Active | 40 | 3.0.0 | Apache Karaf :: Cellar :: Features
+80 | Active | 30 | 3.0.1 | Apache Karaf :: Cellar :: Core
+81 | Active | 31 | 3.0.1 | Apache Karaf :: Cellar :: Utils
+82 | Active | 33 | 3.0.1 | Apache Karaf :: Cellar :: Hazelcast
+83 | Active | 40 | 3.0.1 | Apache Karaf :: Cellar :: Shell
+84 | Active | 40 | 3.0.1 | Apache Karaf :: Cellar :: Config
+85 | Active | 40 | 3.0.1 | Apache Karaf :: Cellar :: Bundle
+86 | Active | 40 | 3.0.1 | Apache Karaf :: Cellar :: Features
</pre><p>And Cellar cluster commands are now available:</p><pre>
karaf@root()> cluster:<TAB>
-cluster:bundle-install cluster:bundle-list cluster:bundle-start cluster:bundle-stop cluster:bundle-uninstall cluster:config-list cluster:config-propappend cluster:config-propdel cluster:config-proplist cluster:config-propset
-cluster:consumer-start cluster:consumer-status cluster:consumer-stop cluster:feature-install cluster:feature-list cluster:feature-uninstall cluster:feature-url-add cluster:feature-url-list cluster:feature-url-remove cluster:group-create
-cluster:group-delete cluster:group-join cluster:group-list cluster:group-pick cluster:group-quit cluster:group-set cluster:handler-start cluster:handler-status cluster:handler-stop cluster:node-list
-cluster:node-ping cluster:producer-start cluster:producer-status cluster:producer-stop cluster:sync
-</pre>
\ No newline at end of file
+</pre><h2 id="Optionalfeatures">Optional features</h2><p>Optionally, you can install additional features.</p><p>The cellar-event feature adds support of OSGi EventAdmin on the cluster:</p><pre>
+karaf@root()> feature:install cellar-event
+</pre><p>The cellar-obr feature adds support of OBR sync on the cluster:</p><pre>
+karaf@root()> feature:install cellar-obr
+</pre><p>The cellar-dosgi feature adds support of DOSGi (Distributed OSGi):</p><pre>
+karaf@root()> feature:install cellar-dosgi
+</pre><p>The cellar-cloud feature adds support of cloud blobstore, allowing to use instances located on a cloud provider:</p><pre>
+karaf@root()> feature:install cellar-cloud
+</pre><p>Please, see the sections dedicated to these features for details.</p>
\ No newline at end of file
Modified: karaf/site/production/manual/cellar/latest/user-guide/event.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/cellar/latest/user-guide/event.html?rev=1655556&r1=1655555&r2=1655556&view=diff
==============================================================================
--- karaf/site/production/manual/cellar/latest/user-guide/event.html (original)
+++ karaf/site/production/manual/cellar/latest/user-guide/event.html Thu Jan 29 09:13:24 2015
@@ -8,7 +8,7 @@
<link href="../css/style.css" rel="stylesheet" type="text/css"/>
<link href="../css/pygmentize.css" rel="stylesheet" type="text/css"/>
<title>
- Apache Karaf Cellar 3.0.0 Guides
+ Apache Karaf Cellar 3.0.2-SNAPSHOT Guides
</title>
</head>
<body>
Modified: karaf/site/production/manual/cellar/latest/user-guide/groups.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/cellar/latest/user-guide/groups.html?rev=1655556&r1=1655555&r2=1655556&view=diff
==============================================================================
--- karaf/site/production/manual/cellar/latest/user-guide/groups.html (original)
+++ karaf/site/production/manual/cellar/latest/user-guide/groups.html Thu Jan 29 09:13:24 2015
@@ -8,7 +8,7 @@
<link href="../css/style.css" rel="stylesheet" type="text/css"/>
<link href="../css/pygmentize.css" rel="stylesheet" type="text/css"/>
<title>
- Apache Karaf Cellar 3.0.0 Guides
+ Apache Karaf Cellar 3.0.2-SNAPSHOT Guides
</title>
</head>
<body>
@@ -47,105 +47,120 @@ karaf@node1()> cluster:group-list
-----------------------------------------------
x | default | node2:5702 node1:5701(x)
| test |
-</pre><h2 id="Groupconfiguration">Group configuration</h2><p>You can see the configuration PID associated with a given group, for instance the default group:</p><pre>
-karaf@root()> cluster:config-list default |more
+</pre><h2 id="ClusteredResourcesandClusterGroups">Clustered Resources and Cluster Groups</h2><h3 id="Features">Features</h3><p>Cellar can manipulate features and features repositories on cluster groups.</p><p>You can use cluster:feature-* commands or the corresponding MBean for that.</p><p>You can list the features repositories on a given cluster group:</p><pre>
+karaf@node1()> cluster:feature-repo-list default
+Repository | Located | URL
+-------------------------------------------------------------------------------------------------------------------------
+jclouds-1.8.1 | cluster/local | mvn:org.apache.jclouds.karaf/jclouds-karaf/1.8.1/xml/features
+karaf-cellar-3.0.1-SNAPSHOT | cluster/local | mvn:org.apache.karaf.cellar/apache-karaf-cellar/3.0.1-SNAPSHOT/xml/features
+org.ops4j.pax.cdi-0.8.0 | cluster/local | mvn:org.ops4j.pax.cdi/pax-cdi-features/0.8.0/xml/features
+spring-3.0.2 | cluster/local | mvn:org.apache.karaf.features/spring/3.0.2/xml/features
+standard-3.0.2 | cluster/local | mvn:org.apache.karaf.features/standard/3.0.2/xml/features
+enterprise-3.0.2 | cluster/local | mvn:org.apache.karaf.features/enterprise/3.0.2/xml/features
+org.ops4j.pax.web-3.1.2 | cluster/local | mvn:org.ops4j.pax.web/pax-web-features/3.1.2/xml/features
+</pre><p>You have the name of the repository, and the URL, like in the feature:repo-list command. However, the cluster:feature-repo-list command<br/>provides the location of the features repository:</p><ul><li>cluster means that the repository is defined only on the cluster group</li><li>local means that the repository is defined only on the local node (not on the cluster)</li><li>cluster/local means that the repository is defined both on the local node, but also on the cluster group</li></ul><p>You can add a repository on a cluster group using the cluster:feature-repo-add command:</p><pre>
+karaf@node1()> cluster:feature-repo-add default mvn:org.apache.activemq/activemq-karaf/5.10.0/xml/features
+</pre><p>You can remove a repository from a cluster group using the cluster:feature-repo-remove command:</p><pre>
+karaf@node1()> cluster:feature-repo-remove default mvn:org.apache.activemq/activemq-karaf/5.10.0/xml/features
+</pre><p>You can list the features on a given cluster group:</p><pre>
+karaf@node1()> cluster:feature-list default |more
+Name | Version | Installed | Located | Blocked
+------------------------------------------------------------------------------------------------
+gemini-blueprint | 1.0.0.RELEASE | | cluster/local |
+package | 3.0.2 | x | cluster/local |
+jclouds-api-route53 | 1.8.1 | | cluster/local |
+jclouds-rackspace-clouddns-uk | 1.8.1 | | cluster/local |
+cellar-cloud | 3.0.1-SNAPSHOT | | local | in/out
+webconsole | 3.0.2 | | cluster/local |
+cellar-shell | 3.0.1-SNAPSHOT | x | local | in/out
+jclouds-glesys | 1.8.1 | | cluster/local |
+...
+</pre><p>Like for the features repositories, you can note there the "Located" column containing where the feature is located (local<br/>to the node, or on the cluster group).<br/>You can also see the "Blocked" column indicating if the feature is blocked inbound or outbound (see the blocking policy).</p><p>You can install a feature on a cluster group using the cluster:feature-install command:</p><pre>
+karaf@node1()> cluster:feature-install default eventadmin
+</pre><p>You can uninstall a feature from a cluster group, using the cluster:feature-uninstall command:</p><pre>
+karaf@node1()> cluster:feature-uninstall default eventadmin
+</pre><p>Cellar also provides a feature listener, disabled by default as you can see in etc/org.apache.karaf.cellar.node.cfg configuration<br/>file:</p><pre>
+feature.listener = false
+</pre><p>The listener listens for the following local feature changes:</p><ul><li>add features repository</li><li>remove features repository</li><li>install feature</li><li>uninstall feature</li></ul><h3 id="Bundles">Bundles</h3><p>Cellar can manipulate bundles on cluster groups.</p><p>You can use cluster:bundle-* commands or the corresponding MBean for that.</p><p>You can list the bundles in a cluster group using the cluster:bundle-list command:</p><pre>
+karaf@node1()> cluster:bundle-list default |more
+Bundles in cluster group default
+ID | State | Located | Blocked | Version | Name
+--------------------------------------------------------------------------------------------------------------------
+ 0 | Active | cluster/local | | 2.2.0 | OPS4J Pax Url - aether:
+ 1 | Active | cluster/local | | 3.0.2 | Apache Karaf :: Deployer :: Blueprint
+ 2 | Active | cluster/local | | 2.2.0 | OPS4J Pax Url - wrap:
+ 3 | Active | cluster/local | | 1.8.0 | Apache Felix Configuration Admin Service
+ 4 | Active | cluster/local | | 3.0.2 | Apache Karaf :: Region :: Core
+ ...
+</pre><p>Like for the features, you can see the "Located" and "Blocked" columns.</p><p>You can install a bundle on a cluster group using the cluster:bundle-install command:</p><pre>
+karaf@node1()> cluster:bundle-install default mvn:org.apache.servicemix.bundles/org.apache.servicemix.bundles.commons-lang/2.4_6
+</pre><p>You can start a bundle in a cluster group using the cluster:bundle-start command:</p><pre>
+karaf@node1()> cluster:bundle-start default commons-lang
+</pre><p>You can stop a bundle in a cluster group using the cluster:bundle-stop command:</p><pre>
+karaf@node1()> cluster:bundle-stop default commons-lang
+</pre><p>You can uninstall a bundle from a cluster group using the cluster:bundle-uninstall command:</p><pre>
+karaf@node1()> cluster:bundle-uninstall default commons-lang
+</pre><p>Like for the feature, Cellar provides a bundle listener disabled by default in etc/org.apache.karaf.cellar.nodes.cfg:</p><pre>
+bundle.listener = false
+</pre><p>The bundle listener listens the following local bundle changes:</p><ul><li>install bundle</li><li>start bundle</li><li>stop bundle</li><li>uninstall bundle</li></ul><h3 id="Configurations">Configurations</h3><p>Cellar can manipulate configurations on cluster groups.</p><p>You can use cluster:config-* commands or the corresponding MBean for that.</p><p>You can list the configurations on a cluster group using the cluster:config-list command:</p><pre>
+karaf@node1()> cluster:config-list default |more
----------------------------------------------------------------
Pid: org.apache.karaf.command.acl.jaas
+Located: cluster/local
+Blocked:
Properties:
update = admin
service.pid = org.apache.karaf.command.acl.jaas
----------------------------------------------------------------
-Pid: org.apache.karaf.service.acl.command.system.start-level
-Properties:
- execute = admin # admin can set any start level, including < 100
- start-level[/[^0-9]*/] = viewer # viewer can obtain the current start level
- execute[/.*/,/[^0-9]*/] = viewer # viewer can obtain the current start level
- * = *
- start-level = admin # admin can set any start level, including < 100
- service.guard = (&(osgi.command.scope=system)(osgi.command.function=start-level))
- execute[/.*/,/.*[0-9][0-9][0-9]+.*/] = manager # manager can set startlevels above 100
- service.pid = org.apache.karaf.service.acl.command.system.start-level
- start-level[/.*[0-9][0-9][0-9]+.*/] = manager # manager can set startlevels above 100
-----------------------------------------------------------------
-...
-</pre><p>You can use the cluster:config-property-list and config-property-set commands to list, add and edit the configuration.</p><p>For instance, in the test group, we don't have any configuration:</p><pre>
-karaf@root()> cluster:config-list test
-No PIDs found for group:test
-</pre><p>We can create a tstcfg config in the test group, containing name=value property:</p><pre>
-karaf@root()> cluster:config-property-set test tstcfg name value
-</pre><p>Now, we have this property in the test group:</p><pre>
-karaf@root()> cluster:config-property-list test testcfg
-Property list for configuration PID testcfg for cluster group test
- name = value
- service.pid = testcfg
-</pre><h2 id="Groupnodes">Group nodes</h2><p>You can declare a node member of one of more groups:</p><pre>
-karaf@node2()> cluster:group-join test node1:5701
- | Group | Members
------------------------------------------------
-x | default | node2:5702(x) node1:5701
- | test | node1:5701
-</pre><p>The node can be local or remote.</p><p>Now, the nodes of a given group will inherit of all configuration defined in the group. This means that<br/>node1 now knows the tstcfg configuration because it's a member of the test group:</p><pre>
-karaf@root()> config:edit tstcfg
-karaf@root()> property-list
- service.pid = testcfg
- name = value
-</pre><h2 id="Groupfeatures">Group features</h2><p>Configuration and features can be assigned to a given group.</p><pre>
-karaf@root()> cluster:feature-list default |more
-Name | Version | Installed
---------------------------------------------------------------------
-pax-cdi-1.1-weld | 0.7.0 |
-cellar-config | 3.0.0-SNAPSHOT |
-pax-cdi-deltaspike-jpa | 0.5 |
-jclouds-savvis-symphonyvpdc | 1.4.0 |
-jclouds | 1.4.0 |
-aries-annotation | 3.0.1 |
-eventadmin | 3.0.1 |
-jclouds-api-filesystem | 1.4.0 |
-scheduler | 3.0.1 |
-jclouds-api-elasticstack | 1.4.0 |
-hazelcast | 3.2.3 |
-cellar-core | 3.0.0-SNAPSHOT |
-jclouds-services | 1.4.0 |
-hibernate-envers | 4.2.7.Final |
-hibernate-envers | 4.3.1.Final |
-jclouds-api-byon | 1.4.0 |
-jclouds-go2cloud-jhb1 | 1.4.0 |
-openjpa | 2.3.0 |
-spring-instrument | 3.2.4.RELEASE |
-spring-orm | 3.1.4.RELEASE |
-jclouds-commands | 1.4.0 |
-jclouds-softlayer | 1.4.0 |
-jclouds-openhosting-east1 | 1.4.0 |
-http | 3.0.1 |
-...
-</pre><pre>
-karaf@root()> cluster:feature-list test|more
-Name | Version | Installed
---------------------------------------------------------------------
-pax-cdi-1.1-weld | 0.7.0 |
-pax-cdi-deltaspike-jpa | 0.5 |
-jclouds-savvis-symphonyvpdc | 1.4.0 |
-aries-annotation | 3.0.1 |
-jclouds | 1.4.0 |
-eventadmin | 3.0.1 |
-jclouds-api-filesystem | 1.4.0 |
-scheduler | 3.0.1 |
-jclouds-api-elasticstack | 1.4.0 |
-jclouds-services | 1.4.0 |
-hibernate-envers | 4.2.7.Final |
-hibernate-envers | 4.3.1.Final |
-jclouds-api-byon | 1.4.0 |
-jclouds-go2cloud-jhb1 | 1.4.0 |
-openjpa | 2.3.0 |
-spring-instrument | 3.2.4.RELEASE |
-spring-orm | 3.1.4.RELEASE |
-jclouds-commands | 1.4.0 |
...
-</pre><p>Now we can "install" a feature for a given cluster group:</p><pre>
-karaf@root()> cluster:feature-install test eventadmin
-karaf@root()> cluster:feature-list test|grep -i event
-eventadmin | 3.0.1 | x
-</pre><p>Below, we see that the eventadmin feature has been installed on this member of the test group:</p><pre>
-karaf@root()> feature:list |grep -i eventadmin
-eventadmin | 3.0.1 | x | standard-3.0.1 | OSGi Event Admin service specification for event-b
-</pre>
\ No newline at end of file
+</pre><p>You can note the "Blocked" and "Located" attributes, like for features and bundles.</p><p>YOu can list properties in a config using the cluster:config-property-list command:</p><pre>
+karaf@node1()> cluster:config-property-list default org.apache.karaf.jaas
+Property list for configuration PID org.apache.karaf.jaas for cluster group default
+ encryption.prefix = {CRYPT}
+ encryption.name =
+ encryption.enabled = false
+ encryption.suffix = {CRYPT}
+ encryption.encoding = hexadecimal
+ service.pid = org.apache.karaf.jaas
+ encryption.algorithm = MD5
+</pre><p>You can set or append a value to a config property using the cluster:config-property-set or cluster:config-property-append command:</p><pre>
+karaf@node1()> cluster:config-property-set default my.config my.property my.value
+</pre><p>You can delete a property in a config using the cluster:config-property-delete command:</p><pre>
+karaf@node1()> cluster:config-property-delete default my.config my.property
+</pre><p>You can delete the whole config using the cluster:config-delete command:</p><pre>
+karaf@node1()> cluster:config-delete default my.config
+</pre><p>Like for feature and bundle, Cellar provides a config listener disabled by default in etc/org.apache.karaf.cellar.nodes.cfg:</p><pre>
+config.listener = false
+</pre><p>The config listener listens the following local config changes:</p><ul><li>create a config</li><li>add/delete/change a property</li><li>delete a config</li></ul><p>As some properties may be local to a node, Cellar excludes some property by default.<br/>You can see the current excluded properties using the cluster:config-property-excluded command:</p><pre>
+karaf@node1()> cluster:config-property-excluded
+service.factoryPid, felix.fileinstall.filename, felix.fileinstall.dir, felix.fileinstall.tmpdir, org.ops4j.pax.url.mvn.defaultRepositories
+</pre><p>You can modify this list using the same command, or by editing the etc/org.apache.karaf.cellar.node.cfg configuration file:</p><pre>
+#
+# Excluded config properties from the sync
+# Some config properties can be considered as local to a node, and should not be sync on the cluster.
+#
+config.excluded.properties = service.factoryPid, felix.fileinstall.filename, felix.fileinstall.dir, felix.fileinstall.tmpdir, org.ops4j.pax.url.mvn.defaultRepositories
+</pre><h3 id="OBRoptional">OBR (optional)</h3><p>See the <a href="obr.html">OBR section</a> for details.</p><h3 id="EventAdminoptiona">EventAdmin (optiona)</h3><p>See the <a href="event.html">EventAdmin section</a> for details.</p><h2 id="Blockingpolicy">Blocking policy</h2><p>You can define a policy to filter the cluster events exchanges by the nodes (inbound or outbound).</p><p>It allows you to block or allow some resources on the cluster.</p><p>By adding a resource id in a blacklist, you block the resource.<br/>By adding a resource id in a whitelist, you allow the resource.</p><p>For instance, for feature, you can use the cluster:feature-block command to display or modify the current blocking policy for features:</p><pre>
+karaf@node1()> cluster:feature-block default
+INBOUND:
+ whitelist: [*]
+ blacklist: [config, cellar*, hazelcast, management]
+OUTBOUND:
+ whitelist: [*]
+ blacklist: [config, cellar*, hazelcast, management]
+</pre><p>NB: * is a wildcard.</p><p>You have the equivalent command for bundle and config:</p><pre>
+karaf@node1()> cluster:bundle-block default
+INBOUND:
+ whitelist: [*]
+ blacklist: [*.xml]
+OUTBOUND:
+ whitelist: [*]
+ blacklist: [*.xml]
+karaf@node1()> cluster:config-block default
+INBOUND:
+ whitelist: [*]
+ blacklist: [org.apache.karaf.cellar*, org.apache.karaf.shell, org.ops4j.pax.logging, org.ops4j.pax.web, org.apache.felix.fileinstall*, org.apache.karaf.management, org.apache.aries.transaction]
+OUTBOUND:
+ whitelist: [*]
+ blacklist: [org.apache.karaf.cellar*, org.apache.karaf.shell, org.ops4j.pax.logging, org.ops4j.pax.web, org.apache.felix.fileinstall*, org.apache.karaf.management, org.apache.aries.transaction]
+</pre><p>Using those commands, you can also update the blacklist and whitelist for inbound or outbound cluster events.</p>
\ No newline at end of file
Added: karaf/site/production/manual/cellar/latest/user-guide/hazelcast.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/cellar/latest/user-guide/hazelcast.html?rev=1655556&view=auto
==============================================================================
--- karaf/site/production/manual/cellar/latest/user-guide/hazelcast.html (added)
+++ karaf/site/production/manual/cellar/latest/user-guide/hazelcast.html Thu Jan 29 09:13:24 2015
@@ -0,0 +1,107 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.1//EN" "http://www.w3.org/TR/xhtml-basic/xhtml-basic11.dtd">
+<html lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+ <meta name="description" content="description goes here"/>
+ <meta name="keywords" content="keywords,goes,here"/>
+ <meta name="author" content="The Apache Karaf Team"/>
+ <link href="../css/style.css" rel="stylesheet" type="text/css"/>
+ <link href="../css/pygmentize.css" rel="stylesheet" type="text/css"/>
+ <title>
+ Apache Karaf Cellar 3.0.2-SNAPSHOT Guides
+ </title>
+ </head>
+ <body>
+ <table width="100%" cellpadding="0" cellspacing="0">
+ <tr width="100%">
+ <td id="cell-0-0" colspan="2">
+
+ </td>
+ <td id="cell-0-1">
+
+ </td>
+ <td id="cell-0-2" colspan="2">
+
+ </td>
+ </tr>
+ <tr width="100%">
+ <td id="cell-1-0">
+
+ </td>
+ <td id="cell-1-1">
+
+ </td>
+ <td id="cell-1-2">
+ <div style="padding: 5px;">
+ <div id="banner">
+ <h1 id="CoreruntimeandHazelcast">Core runtime and Hazelcast</h1><p>Cellar uses Hazelcast as cluster engine.</p><p>When you install the cellar feature, a hazelcast feature is automatically installed, providing the etc/hazelcast.xml<br/>configuration file.</p><p>The etc/hazelcast.xml configuration file contains all the core configuration, especially:</p><ul><li>the Hazelcast cluster identifiers (group name and password)</li><li>network discovery and security configuration</li></ul><h2 id="Hazelcastclusteridentification">Hazelcast cluster identification</h2><p>The <group/> element in the etc/hazelcast.xml defines the identification of the Hazelcast cluster:</p><pre>
+ <group>
+ <name>cellar</name>
+ <password>pass</password>
+ </group>
+</pre><p>All Cellar nodes have to use the same name and password (to be part of the same Hazelcast cluster).</p><h2 id="Network">Network</h2><p>The <network/> element in the etc/hazelcast.xml contains all the network configuration.</p><p>First, it defines the port numbers used by Hazelcast:</p><pre>
+ <port auto-increment="true" port-count="100">5701</port>
+ <outbound-ports>
+ <!--
+ Allowed port range when connecting to other nodes.
+ 0 or * means use system provided port.
+ -->
+ <ports>0</ports>
+ </outbound-ports>
+</pre><p>Second, it defines the mechanism used to discover the Cellar nodes: it's the <join/> element.</p><p>By default, Hazelcast uses unicast.</p><p>You can also use multicast (enabled by default in Cellar):</p><pre>
+ <multicast enabled="true">
+ <multicast-group>224.2.2.3</multicast-group>
+ <multicast-port>54327</multicast-port>
+ </multicast>
+ <tcp-ip enabled="false"/>
+ <aws enabled="false"/>
+</pre><p>Instead of using multicast, you can also explicitly define the host names (or IP addresses) of the different<br/>Cellar nodes:</p><pre>
+ <multicast enabled="false"/>
+ <tcp-ip enabled="true"/>
+ <aws enabled="false"/>
+</pre><p>By default, it will bind to all interfaces on the node machine. It's possible to specify a interface:</p><pre>
+ <multicast enabled="false"/>
+ <tcp-ip enabled="true">
+ <interface>127.0.0.1</interface>
+ </tcp-ip>
+ <aws enabled="false"/>
+</pre><p>NB: in previous Hazelcast versions (especially the one used by Cellar 2.3.x), it was possible to have multicast and tcp-ip enabled in the same time.<br/>In Hazelcast 3.3.x (the version currently used by Cellar 3.0.x), only one discover mechanism can be enabled at a time. Cellar uses multicast by default (tcp-ip is disabled).<br/>If your network or network interface don't support multicast, you have to enable tcp-ip and disable multicast.</p><p>You can also discover nodes located on a Amazon instance:</p><pre>
+ <multicast enabled="false"/>
+ <tcp-ip enabled="false"/>
+ <aws enabled="true">
+ <access-key>my-access-key</access-key>
+ <secret-key>my-secret-key</secret-key>
+ <!--optional, default is us-east-1 -->
+ <region>us-west-1</region>
+ <!--optional, default is ec2.amazonaws.com. If set, region shouldn't be set as it will override this property -->
+ <host-header>ec2.amazonaws.com</host-header>
+ <!-- optional, only instances belonging to this group will be discovered, default will try all running instances -->
+ <security-group-name>hazelcast-sg</security-group-name>
+ <tag-key>type</tag-key>
+ <tag-value>hz-nodes</tag-value>
+ </aws>
+</pre><p>Third, you can specific on which network interface the cluster is running (whatever the discovery mechanism used). By default, Hazelcast listens on all interfaces (0.0.0.0).<br/>But you can specify an interface:</p><pre>
+ <interfaces enabled="true">
+ <interface>10.10.1.*</interface>
+ </interfaces>
+</pre><p>Finally, you can also enable security transport on the cluster.<br/>Two modes are supported:</p><ul><li>SSL:<pre>
+ <ssl enabled="true"/>
+</pre></li><li>Symmetric Encryption:<pre>
+ <symmetric-encryption enabled="true">
+ <!--
+ encryption algorithm such as
+ DES/ECB/PKCS5Padding,
+ PBEWithMD5AndDES,
+ AES/CBC/PKCS5Padding,
+ Blowfish,
+ DESede
+ -->
+ <algorithm>PBEWithMD5AndDES</algorithm>
+ <!-- salt value to use when generating the secret key -->
+ <salt>thesalt</salt>
+ <!-- pass phrase to use when generating the secret key -->
+ <password>thepass</password>
+ <!-- iteration count to use when generating the secret key -->
+ <iteration-count>19</iteration-count>
+ </symmetric-encryption>
+</pre></li></ul><p>Cellar provides additional discovery mechanisms, See <a href="cloud.html">Discovery Service (jclouds and kubernetes)</a> section for details.</p>
\ No newline at end of file
Modified: karaf/site/production/manual/cellar/latest/user-guide/index.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/cellar/latest/user-guide/index.html?rev=1655556&r1=1655555&r2=1655556&view=diff
==============================================================================
--- karaf/site/production/manual/cellar/latest/user-guide/index.html (original)
+++ karaf/site/production/manual/cellar/latest/user-guide/index.html Thu Jan 29 09:13:24 2015
@@ -8,7 +8,7 @@
<link href="../css/style.css" rel="stylesheet" type="text/css"/>
<link href="../css/pygmentize.css" rel="stylesheet" type="text/css"/>
<title>
- Apache Karaf Cellar 3.0.0 Guides
+ Apache Karaf Cellar 3.0.2-SNAPSHOT Guides
</title>
</head>
<body>
@@ -34,4 +34,4 @@
<td id="cell-1-2">
<div style="padding: 5px;">
<div id="banner">
- <h1 id="KarafCellarUserGuide">Karaf Cellar User Guide</h1><ul><li><a href="introduction.html">Karaf Cellar Introduction</a></li><li><a href="installation.html">Installing Karaf Cellar</a></li><li><a href="deploy.html">Start Karaf Cellar</a></li><li><a href="nodes.html">Nodes in Karaf Cellar</a></li><li><a href="groups.html">Groups in Karaf Cellar</a></li><li><a href="obr.html">OBR in Karaf Cellar</a></li><li><a href="event.html">OSGi Event broadcast with Karaf Cellar</a></li><li><a href="cloud.html">Cellar Cloud Discovery</a></li></ul>
\ No newline at end of file
+ <h1 id="KarafCellarUserGuide">Karaf Cellar User Guide</h1><ul><li><a href="introduction.html">Karaf Cellar Introduction</a></li><li><a href="installation.html">Installing Karaf Cellar</a></li><li><a href="deploy.html">Start Karaf Cellar</a></li><li><a href="hazelcast.html">Core configuration</a></li><li><a href="nodes.html">Nodes in Karaf Cellar</a></li><li><a href="groups.html">Groups in Karaf Cellar</a></li><li><a href="obr.html">OBR in Karaf Cellar</a></li><li><a href="event.html">OSGi Event broadcast with Karaf Cellar</a></li><li><a href="transport.html">DOSGi and Transport</a></li><li><a href="cloud.html">Discovery Services</a></li></ul>
\ No newline at end of file
Modified: karaf/site/production/manual/cellar/latest/user-guide/installation.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/cellar/latest/user-guide/installation.html?rev=1655556&r1=1655555&r2=1655556&view=diff
==============================================================================
--- karaf/site/production/manual/cellar/latest/user-guide/installation.html (original)
+++ karaf/site/production/manual/cellar/latest/user-guide/installation.html Thu Jan 29 09:13:24 2015
@@ -8,7 +8,7 @@
<link href="../css/style.css" rel="stylesheet" type="text/css"/>
<link href="../css/pygmentize.css" rel="stylesheet" type="text/css"/>
<title>
- Apache Karaf Cellar 3.0.0 Guides
+ Apache Karaf Cellar 3.0.2-SNAPSHOT Guides
</title>
</head>
<body>
@@ -34,7 +34,7 @@
<td id="cell-1-2">
<div style="padding: 5px;">
<div id="banner">
- <h1 id="Installation">Installation</h1><p>This chapter describes how to install Apache Karaf Cellar into your existing Karaf based installation.</p><h2 id="PreInstallationRequirements">Pre-Installation Requirements</h2><p>As Cellar is a Karaf sub-project, you need a running Karaf instance.</p><p>Karaf Cellar is provided under a Karaf features descriptor. The easiest way to install is just to<br/>have an internet connection from the Karaf running instance.</p><h2 id="BuildingfromSources">Building from Sources</h2><p>If you intend to build Karaf Cellar from the sources, the requirements are:</p><p><strong>Hardware:</strong></p><ul><li>100MB of free disk space for the Apache Karaf Cellar x.y source distributions or SVN checkout, the Maven build and the dependencies that Maven downloads.</li></ul><p><strong>Environment:</strong></p><ul><li>Java SE Development Kit 1.7.x or greater (<a href="http://www.oracle.com/technetwork/java/javase/">http://www.oracle.com/technetwork/ja
va/javase/</a>).</li><li>Apache Maven 3.0.3 (<a href="http://maven.apache.org/download.html">http://maven.apache.org/download.html</a>).</li></ul><p><strong>Note:</strong> Karaf Cellar requires Java 7 to compile, build and run.</p><h3 id="BuildingonWindows">Building on Windows</h3><p>This procedure explains how to download and install the source distribution on a Windows system.</p><ol><li>From a browser, navigate to <a href="http://karaf.apache.org/sub-projects/cellar/download.html">http://karaf.apache.org/sub-projects/cellar/download.html</a>.</li><li>Select the desired distribution.<p>For a source distribution, the filename will be similar to: <tt>apache-karaf-cellar-x.y-src.zip</tt>.</p></li><li>Extract Karaf Cellar from the ZIP file into a directory of your choice. Please remember the restrictions concerning illegal characters in Java paths, e.g. !, % etc.</li><li><span id="WindowsSourceInstallation"></span> Build Karaf Cellar using Maven 3.0.3 or greater and Java 6.<p>The reco
mmended method of building Karaf Cellar is the following:</p><pre>
+ <h1 id="Installation">Installation</h1><p>This chapter describes how to install Apache Karaf Cellar into your existing Karaf based installation.</p><h2 id="PreInstallationRequirements">Pre-Installation Requirements</h2><p>Cellar is installed on running Karaf instances.</p><p>Cellar is provided as a Karaf features descriptor. The easiest way to install is just to<br/>have an internet connection from the Karaf running instance.</p><p>See <a href="deploy.html">deploy</a> to how to install and start Cellar.</p><h2 id="BuildingfromSources">Building from Sources</h2><p>If you intend to build Karaf Cellar from the sources, the requirements are:</p><p><strong>Hardware:</strong></p><ul><li>100MB of free disk space for the Apache Karaf Cellar x.y source distributions or SVN checkout, the Maven build and the dependencies that Maven downloads.</li></ul><p><strong>Environment:</strong></p><ul><li>Java SE Development Kit 1.7.x or greater (<a href="http://www.oracle.com/technetwork/j
ava/javase/">http://www.oracle.com/technetwork/java/javase/</a>).</li><li>Apache Maven 3.0.3 (<a href="http://maven.apache.org/download.html">http://maven.apache.org/download.html</a>).</li></ul><p><strong>Note:</strong> Karaf Cellar requires Java 7 to compile, build and run.</p><h3 id="BuildingonWindows">Building on Windows</h3><p>This procedure explains how to download and install the source distribution on a Windows system.</p><ol><li>From a browser, navigate to <a href="http://karaf.apache.org/sub-projects/cellar/download.html">http://karaf.apache.org/sub-projects/cellar/download.html</a>.</li><li>Select the desired distribution.<p>For a source distribution, the filename will be similar to: <tt>apache-karaf-cellar-x.y-src.zip</tt>.</p></li><li>Extract Karaf Cellar from the ZIP file into a directory of your choice. Please remember the restrictions concerning illegal characters in Java paths, e.g. !, % etc.</li><li><span id="WindowsSourceInstallation"></span> Build Karaf Cellar us
ing Maven 3.0.3 or greater and Java 6.<p>The recommended method of building Karaf Cellar is the following:</p><pre>
cd [cellar_install_dir]\src
</pre><p>where <tt>[cellar_install_dir]</tt> is the directory in which Karaf Cellar was uncompressed.</p><pre>
mvn
Modified: karaf/site/production/manual/cellar/latest/user-guide/introduction.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/cellar/latest/user-guide/introduction.html?rev=1655556&r1=1655555&r2=1655556&view=diff
==============================================================================
--- karaf/site/production/manual/cellar/latest/user-guide/introduction.html (original)
+++ karaf/site/production/manual/cellar/latest/user-guide/introduction.html Thu Jan 29 09:13:24 2015
@@ -8,7 +8,7 @@
<link href="../css/style.css" rel="stylesheet" type="text/css"/>
<link href="../css/pygmentize.css" rel="stylesheet" type="text/css"/>
<title>
- Apache Karaf Cellar 3.0.0 Guides
+ Apache Karaf Cellar 3.0.2-SNAPSHOT Guides
</title>
</head>
<body>
@@ -34,25 +34,4 @@
<td id="cell-1-2">
<div style="padding: 5px;">
<div id="banner">
- <h1 id="Introduction">Introduction</h1><h2 id="KarafCellarusecases">Karaf Cellar use cases</h2><p>The first purpose of Cellar is to synchronize the state of several Karaf instances (named nodes).</p><p>It means that all resources modified (installed, started, etc) on one Karaf instance will be propagated to all others<br/>nodes.<br/>Concretely, Cellar will broadcast an event to others nodes when you perform an action.</p><p>The nodes list could be discovered (using multicast/unicast), or explicitly defined (using a couple hostname or IP<br/>and port list).</p><p>Cellar is able to synchronize:</p><ul style="list-style: square"><li>bundles (remote, local, or from an OBR)</li><li>config</li><li>features</li></ul><p>The second purpose is to provide a Distributed OSGi runtime. It means that using Cellar, you are able to call an OSGi<br/>service located on a remote instance. See the <a href="Transport and DOSGi.html">Transport and DOSGi</a> section of the user guide.</p><h2
id="Cellarnetwork">Cellar network</h2><p>Cellar relies on Hazelcast (http://www.hazelcast.com), a memory data grid implementation.</p><p>You have a full access to the Hazelcast configuration (in etc/hazelcast.xml) allowing you to specify the network<br/>configuration.</p><p>Especially, you can enable or not the multicast support and choose the multicast group and port number.</p><p>You can also configure on which interface and IP address you configure Cellar and port number used by Cellar:</p><pre>
- <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>
-</pre><p>By default, the Cellar node will start from network port 5701, each new node will use an incremented port number.</p><h2 id="Crosstopology">Cross topology</h2><p><img border="0" src="../images/cross_topology.jpg"/></p><p>This is the default Cellar topology. Cellar is installed on every nodes, each node has the same function.</p><p>It means that you can perform actions on any node, it will be broadcasted to all others nodes.</p><h2 id="Startopology">Star topology</h2><p><img border="0" src="../images/star_topology.jpg"/></p><p>In this topology, if Cellar is installed on all nodes, you perform actions only on one specific node (the "manager").</p><p>To do that, the "manager" is a standard Cellar node, and the event producing is disable on all others nodes<br/>(cluster:producer-stop on all "managed" nodes).</p><p>Like this, only the "manager" will send event to the nodes (which are able to consumer and handle), but no event can<br/>be produced on the nodes.</p>
\ No newline at end of file
+ <h1 id="Introduction">Introduction</h1><h2 id="KarafCellarusecases">Karaf Cellar use cases</h2><p>The first purpose of Cellar is to synchronize the state of several Karaf instances (named nodes).</p><p>Cellar provides dedicated shell commands and MBeans to administrate the cluster, and manipulate the resources on the cluster.</p><p>It's also possible to enable local resources listeners: these listeners broadcast local resource changes as cluster events.<br/>Please note that this behavior is disabled by default as it can have side effects (especially when a node is stopped).<br/>Enabling listeners is at your own risk.</p><p>The nodes list could be discovered (using unicast or multicast), or "staticly" defined (using a couple hostname or IP<br/>and port list).</p><p>Cellar is able to synchronize:</p><ul style="list-style: square"><li>bundles (remote, local, or from an OBR)</li><li>config</li><li>features</li><li>eventadmin</li></ul><p>Optionally, Cellar also support sync
hronization of OSGi EventAdmin, OBR (URLs and bundles).</p><p>The second purpose is to provide a Distributed OSGi runtime. It means that using Cellar, you are able to call an OSGi<br/>service located on a remote instance. See the <a href="Transport and DOSGi.html">Transport and DOSGi</a> section of the user guide.</p><p>Finally, Cellar also provides "runtime clustering" by providing dedicated feature like:</p><ul style="list-style: square"><li>HTTP load balancing</li><li>HTTP sessions replication</li><li>log centralization<p>Please, see the sections dedicated to those features.</p><h2 id="Crosstopology">Cross topology</h2><p><img border="0" src="../images/cross_topology.jpg"/></p><p>This is the default Cellar topology. Cellar is installed on every nodes, each node has the same function.</p><p>It means that you can perform actions on any node, it will be broadcasted to all others nodes.</p><h2 id="Startopology">Star topology</h2><p><img border="0" src="../images/star_topology.jpg"/><
/p><p>In this topology, if Cellar is installed on all nodes, you perform actions only on one specific node (the "manager").</p><p>To do that, the "manager" is a standard Cellar node, and the event producing is disable on all others nodes<br/>(cluster:producer-stop on all "managed" nodes).</p><p>Like this, only the "manager" will send event to the nodes (which are able to consumer and handle), but no event can<br/>be produced on the nodes.</p></li></ul>
\ No newline at end of file
Modified: karaf/site/production/manual/cellar/latest/user-guide/nodes.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/cellar/latest/user-guide/nodes.html?rev=1655556&r1=1655555&r2=1655556&view=diff
==============================================================================
--- karaf/site/production/manual/cellar/latest/user-guide/nodes.html (original)
+++ karaf/site/production/manual/cellar/latest/user-guide/nodes.html Thu Jan 29 09:13:24 2015
@@ -8,7 +8,7 @@
<link href="../css/style.css" rel="stylesheet" type="text/css"/>
<link href="../css/pygmentize.css" rel="stylesheet" type="text/css"/>
<title>
- Apache Karaf Cellar 3.0.0 Guides
+ Apache Karaf Cellar 3.0.2-SNAPSHOT Guides
</title>
</head>
<body>
@@ -40,7 +40,7 @@ karaf@root()> cluster:node-list
-------------------------------------
x | node2:5702 | node2 | 5702
| node1:5701 | node1 | 5701
-</pre><p>The starting 'x' indicates that it's the Karaf instance on which you are logged on (the local node).</p><h2 id="Testingnodes">Testing nodes</h2><p>You can ping a node to test it:</p><pre>
+</pre><p>The starting 'x' indicates that it's the Karaf instance on which you are logged on (the local node).</p><p>NB: if you don't see the other nodes there (whereas they should be there), it's probably due to a network issue. By default, Cellar uses multicast to discover the nodes.<br/>If your network or network interface don't support multicast, you have to switch to tcp-ip instead of multicast. See <a href="../architecture-guide/hazelcast.html">Core Configuration</a> for details.</p><p>NB: in Cellar 2.3.x, Cellar used both multicast and tcp-ip by default. Due to a change in Hazelcast, it's no more possible to have both. Now, in Cellar 3.0.x, the default<br/>configuration is multicast enabled, tcp-ip disabled. See <a href="../architecture-guide/hazelcast.html">Core Configuration</a> for details.</p><h2 id="Testingnodes">Testing nodes</h2><p>You can ping a node to test it:</p><pre>
karaf@root()> cluster:node-ping node1:5701
PING node1:5701
from 1: req=node1:5701 time=11 ms
@@ -48,13 +48,50 @@ from 2: req=node1:5701 time=12 ms
from 3: req=node1:5701 time=13 ms
from 4: req=node1:5701 time=7 ms
from 5: req=node1:5701 time=12 ms
-
-</pre><h2 id="Nodessync">Nodes sync</h2><p>Cellar allows nodes to 'sync' state. It currently covers features, configs, and bundles.</p><p>For instance, if you install a feature (eventadmin for example) on node1:</p><pre>
-karaf@root> feature:install eventadmin
-karaf@root()> feature:list |grep -i eventadmin
-eventadmin | 3.0.1 | x | standard-3.0.1 | OSGi Event Admin service specification for event-b
-</pre><p>You can see that the eventadmin feature has been installed on node2:</p><pre>
-karaf@root()> feature:list |grep -i eventadmin
-eventadmin | 3.0.1 | x | standard-3.0.1 | OSGi Event Admin service specification for event-b
-
-</pre><p>Features uninstall works in the same way. Basically, Cellar synchronisation is completely transparent.</p><p>Configuration is also synchronized.</p>
\ No newline at end of file
+</pre><h2 id="NodeComponentslistenerproducerhandlerconsumeandsynchronizer">Node Components: listener, producer, handler, consume, and synchronizer</h2><p>A Cellar node is actually a set of components, each component is dedicated to a special purpose.</p><p>The etc/org.apache.karaf.cellar.node.cfg configuration file is dedicated to the configuration of the local node.<br/>It's where you can control the status of the different components.</p><h3 id="Synchronizersandsyncpolicy">Synchronizers and sync policy</h3><p>A synchronizer is invoked when you:</p><ul><li>Cellar starts</li><li>a node joins a cluster group (see <a href="groups.html">groups</a> for details about cluster groups)</li><li>you explicitly call the cluster:sync command</li></ul><p>We have a synchronizer per resource: feature, bundle, config, obr (optional).</p><p>Cellar supports three sync policies:</p><ul><li>cluster (default): if the node is the first one in the cluster, it pushes its local state to the cluster, else if
it's<p>not the first node in the cluster, the node will update its local state with the cluster one (meaning that the cluster<br/>is the master).</p></li><li>node: in this case, the node is the master, it means that the cluster state will be overwritten by the node state.</li><li>disabled: in this case, it means that the synchronizer is not used at all, meaning the node or the cluster are not<p>updated at all (at sync time).</p><p>You can configure the sync policy (for each resource, and each cluster group) in the etc/org.apache.karaf.cellar.groups.cfg<br/>configuration file:</p><pre>
+default.bundle.sync = cluster
+default.config.sync = cluster
+default.feature.sync = cluster
+default.obr.urls.sync = cluster
+</pre></li></ul><p>The cluster:sync command allows you to "force" the sync:</p><pre>
+karaf@node1()> cluster:sync
+Synchronizing cluster group default
+ bundle: done
+ config: done
+ feature: done
+ obr.urls: No synchronizer found for obr.urls
+</pre><p>It's also possible to sync only a resource using:</p><ul><li><del>b (</del>-bundle) for bundle</li><li><del>f (</del>-feature) for feature</li><li><del>c (</del>-config) for configuration</li><li><del>o (</del>-obr) for OBR URLs</li></ul><p>or a given cluster group using the <del>g (</del>-group) option.</p><h3 id="Producerconsumerandhandlers">Producer, consumer, and handlers</h3><p>To notify the other nodes in the cluster, Cellar produces a cluster event.</p><p>For that, the local node uses a producer to create and send the cluster event.<br/>You can see the current status of the local producer using the cluster:producer-status command:</p><pre>
+karaf@node1()> cluster:producer-status
+ | Node | Status
+-----------------------------
+x | 172.17.42.1:5701 | ON
+</pre><p>The cluster:producer-stop and cluster:producer-start commands allow you to stop or start the local cluster event<br/>producer:</p><pre>
+karaf@node1()> cluster:producer-stop
+ | Node | Status
+-----------------------------
+x | 172.17.42.1:5701 | OFF
+karaf@node1()> cluster:producer-start
+ | Node | Status
+-----------------------------
+x | 172.17.42.1:5701 | ON
+</pre><p>When the producer is off, it means that the node is "isolated" from the cluster as it doesn't send "outbound" cluster events<br/>to the other nodes.</p><p>On the other hand, a node receives the cluster events on a consumer. Like for the producer, you can see and control the<br/>consumer using dedicated command:</p><pre>
+karaf@node1()> cluster:consumer-status
+ | Node | Status
+---------------------------
+x | localhost:5701 | ON
+karaf@node1()> cluster:consumer-stop
+ | Node | Status
+---------------------------
+x | localhost:5701 | OFF
+karaf@node1()> cluster:consumer-start
+ | Node | Status
+---------------------------
+x | localhost:5701 | ON
+</pre><p>When the consumer is off, it means that node is "isolated" from the cluster as it doesn't receive "inbound" cluster events<br/>from the other nodes.</p><p>Different cluster events are involved. For instance, we have cluster event for feature, for bundle, for configuration, for OBR, etc.<br/>When a consumer receives a cluster event, it delegates the handling of the cluster event to a specific handler, depending of the<br/>type of the cluster event.<br/>You can see the different handlers and their status using the cluster:handler-status command:</p><pre>
+karaf@node1()> cluster:handler-status
+ | Node | Status | Event Handler
+--------------------------------------------------------------------------------------
+x | localhost:5701 | ON | org.apache.karaf.cellar.config.ConfigurationEventHandler
+x | localhost:5701 | ON | org.apache.karaf.cellar.bundle.BundleEventHandler
+x | localhost:5701 | ON | org.apache.karaf.cellar.features.FeaturesEventHandler
+</pre><p>You can stop or start a specific handler using the cluster:handler-stop and cluster:handler-start commands.</p><p>When a handler is stopped, it means that the node will receive the cluster event, but will not update the local resources<br/>dealt by the handler.</p><h3 id="Listeners">Listeners</h3><p>The listeners are listening for local resource change.</p><p>For instance, when you install a feature (with feature:install), the feature listener traps the change and broadcast this<br/>change as a cluster event to other nodes.</p><p>To avoid some unexpected behaviors (especially when you stop a node), most of the listeners are switch off by default.</p><p>The listeners status are configured in the etc/org.apache.karaf.cellar.node.cfg configuration file.</p><p>NB: enabling listeners is at your own risk. We encourage you to use cluster dedicated commands and MBeans to manipulate<br/>the resources on the cluster.</p><h2 id="Clusteredresources">Clustered resources</h2><p>Cellar pr
ovides dedicated commands and MBeans for clustered resources.</p><p>Please, go into the <a href="groups.html">cluster groups</a> section for details.</p>
\ No newline at end of file
Modified: karaf/site/production/manual/cellar/latest/user-guide/obr.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/cellar/latest/user-guide/obr.html?rev=1655556&r1=1655555&r2=1655556&view=diff
==============================================================================
--- karaf/site/production/manual/cellar/latest/user-guide/obr.html (original)
+++ karaf/site/production/manual/cellar/latest/user-guide/obr.html Thu Jan 29 09:13:24 2015
@@ -8,7 +8,7 @@
<link href="../css/style.css" rel="stylesheet" type="text/css"/>
<link href="../css/pygmentize.css" rel="stylesheet" type="text/css"/>
<title>
- Apache Karaf Cellar 3.0.0 Guides
+ Apache Karaf Cellar 3.0.2-SNAPSHOT Guides
</title>
</head>
<body>
Modified: karaf/site/production/manual/cellar/latest/user-guide/services_registries.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/cellar/latest/user-guide/services_registries.html?rev=1655556&r1=1655555&r2=1655556&view=diff
==============================================================================
--- karaf/site/production/manual/cellar/latest/user-guide/services_registries.html (original)
+++ karaf/site/production/manual/cellar/latest/user-guide/services_registries.html Thu Jan 29 09:13:24 2015
@@ -8,7 +8,7 @@
<link href="../css/style.css" rel="stylesheet" type="text/css"/>
<link href="../css/pygmentize.css" rel="stylesheet" type="text/css"/>
<title>
- Apache Karaf Cellar 3.0.0 Guides
+ Apache Karaf Cellar 3.0.2-SNAPSHOT Guides
</title>
</head>
<body>
Modified: karaf/site/production/manual/cellar/latest/user-guide/transport.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/cellar/latest/user-guide/transport.html?rev=1655556&r1=1655555&r2=1655556&view=diff
==============================================================================
--- karaf/site/production/manual/cellar/latest/user-guide/transport.html (original)
+++ karaf/site/production/manual/cellar/latest/user-guide/transport.html Thu Jan 29 09:13:24 2015
@@ -8,7 +8,7 @@
<link href="../css/style.css" rel="stylesheet" type="text/css"/>
<link href="../css/pygmentize.css" rel="stylesheet" type="text/css"/>
<title>
- Apache Karaf Cellar 3.0.0 Guides
+ Apache Karaf Cellar 3.0.2-SNAPSHOT Guides
</title>
</head>
<body>