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 2011/09/17 08:08:47 UTC
svn commit: r1171910 - in
/karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp: manual.conf
user-guide/index.conf user-guide/obr.conf
Author: jbonofre
Date: Sat Sep 17 06:08:47 2011
New Revision: 1171910
URL: http://svn.apache.org/viewvc?rev=1171910&view=rev
Log:
[KARAF-857] Add Cellar OBR support in the user guide
Added:
karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/user-guide/obr.conf
Modified:
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/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=1171910&r1=1171909&r2=1171910&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 Sat Sep 17 06:08:47 2011
@@ -31,6 +31,8 @@ h1. User Guide
{include:user-guide/deploy.conf}
{include:user-guide/nodes.conf}
{include:user-guide/groups.conf}
+{include:user-guide/obr.conf}
+{include:user-guide/cloud.conf}
h1. Architecture Guide
{include:architecture-guide/overview.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=1171910&r1=1171909&r2=1171910&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 Sat Sep 17 06:08:47 2011
@@ -4,4 +4,5 @@ h1. Karaf Cellar User Guide
* [Start Karaf Cellar|/user-guide/deploy]
* [Nodes in Karaf Cellar|/user-guide/nodes]
* [Groups in Karaf Cellar|/user-guide/groups]
+* [OBR in Karaf Cellar|/user-guide/obr]
* [Cellar Cloud Discovery|/user-guide/cloud]
Added: karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/user-guide/obr.conf
URL: http://svn.apache.org/viewvc/karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/user-guide/obr.conf?rev=1171910&view=auto
==============================================================================
--- karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/user-guide/obr.conf (added)
+++ karaf/cellar/branches/cellar-2.2.x/manual/src/main/webapp/user-guide/obr.conf Sat Sep 17 06:08:47 2011
@@ -0,0 +1,85 @@
+h1. OBR Support
+
+Apache Karaf Cellar is able to "broadcast" OBR actions between the cluster nodes (of the same group).
+
+h2. Enable OBR support
+
+To enable the Cellar OBR support, you have to install the cellar-obr feature:
+
+{code}
+karaf@root> features:install cellar-obr
+{code}
+
+Of course, if the Cellar core feature is already install, you can use it to install the cellar-core features on all
+nodes of the same group:
+
+{code}
+karaf@root> cluster:features-install group cellar-obr
+{code}
+
+The Cellar OBR feature will install the Karaf OBR feature which provides the OBR service (RepositoryAdmin).
+
+h2. Register repository URL in a cluster
+
+The cluster:obr-addurl command register a OBR repository URL (repository.xml) in a cluster group:
+
+{code}
+karaf@root> cluster:obr-addurl group file://path/to/repository.xml
+karaf@root> cluster:obr-addurl group http://karaf.cave.host:9090/cave/repo-repository.xml
+{code}
+
+The OBR repository URLs are stored in a cluster distributed set. It allows new nodes to register the distributed URLs:
+
+{code}
+karaf@root> cluster:obr-listurl group
+file://path/to/repository.xml
+http://karaf.cave.host:9090/cave/repo-repository.xml
+{code}
+
+When a repository is registered in the distributed OBR, Cave maintains a distributed set of bundles available on the
+OBR of a cluster group:
+
+{code}
+karaf@root> cluster:obr-list group
+ NAME SYMBOLIC NAME VERSION
+[Apache ServiceMix :: Specs :: Java Persistence API 1.4 ] [org.apache.servicemix.specs.java-persistence-api-1.1.1 ] [1.9.0.SNAPSHOT ]
+[camel-jms ] [org.apache.camel.camel-jms ] [2.9.0.SNAPSHOT ]
+[camel-example-spring-javaconfig ] [org.apache.camel.camel-example-spring-javaconfig ] [2.8.1.SNAPSHOT ]
+[Apache ServiceMix :: Features :: Examples :: WSDL First OSGi Package :: CXF BC Bundle] [wsdl-first-cxfbc-bundle ] [4.4.0.SNAPSHOT ]
+[camel-dozer ] [org.apache.camel.camel-dozer ] [2.9.0.SNAPSHOT ]
+[OPS4J Pax Web - Extender - Whiteboard ] [org.ops4j.pax.web.pax-web-extender-whiteboard ] [1.0.6 ]
+[OPS4J Pax Web - Runtime ] [org.ops4j.pax.web.pax-web-runtime ] [1.0.6.SNAPSHOT ]
+[camel-mina ] [org.apache.camel.camel-mina ] [2.9.0.SNAPSHOT ]
+[camel-jackson ] [org.apache.camel.camel-jackson ] [2.9.0.SNAPSHOT ]
+[camel-example-route-throttling ] [org.apache.camel.camel-example-route-throttling ] [2.9.0.SNAPSHOT ]
+{code}
+
+When you remove a repository URL from the distributed OBR, the bundles distributed set is updated:
+
+{code}
+karaf@root> cluster:obr-removeurl group http://karaf.cave.host:9090/cave/repo-repository.xml
+{code}
+
+h2. Deploying bundles using the cluster OBR
+
+You can deploy a bundle (and the bundles in dependency) using the OBR on a given cluster group:
+
+{code}
+karaf@root> cluster:obr-deploy group bundleId
+{code}
+
+The bundle ID is the symbolic name (as displayed by the cluster:obr-list command). If you don't provide the version, the OBR deploys the latest version
+available. To provide the version, use comma after the symbolic name:
+
+{code}
+karaf@root> cluster:obr-deploy group org.apache.servicemix.specs.java-persistence-api-1.1.1
+karaf@root> cluster:obr-deploy group org.apache.camel.camel-jms,2.9.0.SNAPSHOT
+{code}
+
+The OBR will automatically install the bundles required to satisfy the bundle dependencies.
+
+By default, the deploy command doesn't start the bundle. To start the bundles just after the deployment, you can use the -s option:
+
+{code}
+karaf@root> cluster:obr-deploy -s group org.ops4j.pax.web.pax-web-runtime
+{code}
\ No newline at end of file