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/12/20 08:47:12 UTC
svn commit: r1720992 [8/8] - in /karaf/site/production/manual/latest: ./
commands/ developers-guide/ users-guide/
Modified: karaf/site/production/manual/latest/users-guide/jndi.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/users-guide/jndi.html?rev=1720992&r1=1720991&r2=1720992&view=diff
==============================================================================
--- karaf/site/production/manual/latest/users-guide/jndi.html (original)
+++ karaf/site/production/manual/latest/users-guide/jndi.html Sun Dec 20 07:47:05 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 4.0.2-SNAPSHOT Guides
+ Apache Karaf 4.0.3 Guides
</title>
</head>
<body>
Modified: karaf/site/production/manual/latest/users-guide/jpa.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/users-guide/jpa.html?rev=1720992&r1=1720991&r2=1720992&view=diff
==============================================================================
--- karaf/site/production/manual/latest/users-guide/jpa.html (original)
+++ karaf/site/production/manual/latest/users-guide/jpa.html Sun Dec 20 07:47:05 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 4.0.2-SNAPSHOT Guides
+ Apache Karaf 4.0.3 Guides
</title>
</head>
<body>
Modified: karaf/site/production/manual/latest/users-guide/jta.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/users-guide/jta.html?rev=1720992&r1=1720991&r2=1720992&view=diff
==============================================================================
--- karaf/site/production/manual/latest/users-guide/jta.html (original)
+++ karaf/site/production/manual/latest/users-guide/jta.html Sun Dec 20 07:47:05 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 4.0.2-SNAPSHOT Guides
+ Apache Karaf 4.0.3 Guides
</title>
</head>
<body>
Modified: karaf/site/production/manual/latest/users-guide/kar.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/users-guide/kar.html?rev=1720992&r1=1720991&r2=1720992&view=diff
==============================================================================
--- karaf/site/production/manual/latest/users-guide/kar.html (original)
+++ karaf/site/production/manual/latest/users-guide/kar.html Sun Dec 20 07:47:05 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 4.0.2-SNAPSHOT Guides
+ Apache Karaf 4.0.3 Guides
</title>
</head>
<body>
Modified: karaf/site/production/manual/latest/users-guide/log.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/users-guide/log.html?rev=1720992&r1=1720991&r2=1720992&view=diff
==============================================================================
--- karaf/site/production/manual/latest/users-guide/log.html (original)
+++ karaf/site/production/manual/latest/users-guide/log.html Sun Dec 20 07:47:05 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 4.0.2-SNAPSHOT Guides
+ Apache Karaf 4.0.3 Guides
</title>
</head>
<body>
Modified: karaf/site/production/manual/latest/users-guide/monitoring.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/users-guide/monitoring.html?rev=1720992&r1=1720991&r2=1720992&view=diff
==============================================================================
--- karaf/site/production/manual/latest/users-guide/monitoring.html (original)
+++ karaf/site/production/manual/latest/users-guide/monitoring.html Sun Dec 20 07:47:05 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 4.0.2-SNAPSHOT Guides
+ Apache Karaf 4.0.3 Guides
</title>
</head>
<body>
@@ -103,7 +103,9 @@
<div class="wiki-content">
<h1 id="MonitoringandManagementusingJMX">Monitoring and Management using JMX</h1><p>Apache Karaf provides a complete JMX layer.</p><p>You can remotely connect to a running Apache Karaf instance using any JMX client (like jconsole).</p><p>The Apache Karaf features provide a set of MBeans, dedicating for the monitoring and management.</p><h2 id="Connecting">Connecting</h2><p>Apache Karaf exposes a complete MBean server that you can use remotely.</p><p>The default port number is 1099.</p><p>The JMX URL to use by default is:</p><pre>
service:jmx:rmi:///jndi/rmi://localhost:1099/karaf-root
-</pre><p>You have to provide an username and password to access to the JMX layer.<br/>The JMX layer user the security framework, and so, by default, it uses the users defined in <tt>etc/users.properties</tt>.</p><p>You can change the port numbers of the JMX layer in the <tt>etc/org.apache.karaf.management.cfg</tt> configuration file.</p><h2 id="Configuration">Configuration</h2><p>The Apache Karaf JMX management layer is configured in the <tt>etc/org.apache.karaf.management.cfg</tt> configuration file:</p><pre>
+</pre><p>If don't need the remote JMX at all, users can remove </p><pre>
+-Dcom.sun.management.jmxremote
+</pre><p>from bin/karaf|bin/karaf.bat to avoid opening the RMI listening port.</p><p>You have to provide an username and password to access to the JMX layer.<br/>The JMX layer user the security framework, and so, by default, it uses the users defined in <tt>etc/users.properties</tt>.</p><p>You can change the port numbers of the JMX layer in the <tt>etc/org.apache.karaf.management.cfg</tt> configuration file.</p><h2 id="Configuration">Configuration</h2><p>The Apache Karaf JMX management layer is configured in the <tt>etc/org.apache.karaf.management.cfg</tt> configuration file:</p><pre>
################################################################################
#
# Licensed to the Apache Software Foundation (ASF) under one or more
Modified: karaf/site/production/manual/latest/users-guide/obr.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/users-guide/obr.html?rev=1720992&r1=1720991&r2=1720992&view=diff
==============================================================================
--- karaf/site/production/manual/latest/users-guide/obr.html (original)
+++ karaf/site/production/manual/latest/users-guide/obr.html Sun Dec 20 07:47:05 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 4.0.2-SNAPSHOT Guides
+ Apache Karaf 4.0.3 Guides
</title>
</head>
<body>
Modified: karaf/site/production/manual/latest/users-guide/provisioning-schema.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/users-guide/provisioning-schema.html?rev=1720992&r1=1720991&r2=1720992&view=diff
==============================================================================
--- karaf/site/production/manual/latest/users-guide/provisioning-schema.html (original)
+++ karaf/site/production/manual/latest/users-guide/provisioning-schema.html Sun Dec 20 07:47:05 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 4.0.2-SNAPSHOT Guides
+ Apache Karaf 4.0.3 Guides
</title>
</head>
<body>
@@ -107,7 +107,7 @@ features/core/src/main/resources/org/apa
features/core/src/main/resources/org/apache/karaf/features/karaf-features-1.2.0.xsd
features/core/src/main/resources/org/apache/karaf/features/karaf-features-1.1.0.xsd
features/core/src/main/resources/org/apache/karaf/features/karaf-features-1.0.0.xsd
[... 6 lines stripped ...]
Modified: karaf/site/production/manual/latest/users-guide/provisioning.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/users-guide/provisioning.html?rev=1720992&r1=1720991&r2=1720992&view=diff
==============================================================================
--- karaf/site/production/manual/latest/users-guide/provisioning.html (original)
+++ karaf/site/production/manual/latest/users-guide/provisioning.html Sun Dec 20 07:47:05 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 4.0.2-SNAPSHOT Guides
+ Apache Karaf 4.0.3 Guides
</title>
</head>
<body>
@@ -141,7 +141,9 @@ serviceRequirements=default
</config>
</pre><p>The <tt>name</tt> attribute of the <tt><config/></tt> element corresponds to the configuration PID (see the <a href="configuration.html">Configuration section</a> for details).</p><p>The installation of the feature will have the same effect as dropping a file named <tt>com.foo.bar.cfg</tt> in the <tt>etc</tt> folder.</p><p>The content of the <tt><config/></tt> element is a set of properties, following the key=value standard.</p><h2 id="Featureconfigurationfiles">Feature configuration files</h2><p>Instead of using the <tt><config/></tt> element, a feature can specify <tt><configfile/></tt> elements.</p><pre>
<configfile finalname="/etc/myfile.cfg" override="false">URL</configfile>
-</pre><p>Instead of directly manipulating the Apache Karaf configuration layer (as when using the <tt><config/></tt> element), the<br/><tt><configfile/></tt> element takes directly a file specified by a URL, and copy the file in the location specified by the<br/><tt>finalname</tt> attribute. The location is relative from the <tt>KARAF_BASE</tt> variable. If the file is already present at<br/>the desired location it is kept and the deployment of the configuration file is skipped, as a already existing file might<br/>contain customization. This behaviour can be overriden by <tt>override</tt> set to true. </p><p>The file URL is any URL supported by Apache Karaf (see the <a href="urls.html">Artifacts repositories and URLs</a> of the user guide for details).</p><h3 id="Requirements">Requirements</h3><p>A feature can also specify expected requirements. The feature resolver will try to satisfy the requirements. For that, it checks<br/>the features and bundles capabilities and will au
tomatically install the bundles to satisfy the requirements.</p><p>For instance, a feature can contain:</p><pre>
+</pre><p>Instead of directly manipulating the Apache Karaf configuration layer (as when using the <tt><config/></tt> element), the<br/><tt><configfile/></tt> element takes directly a file specified by a URL, and copy the file in the location specified by the<br/><tt>finalname</tt> attribute.</p><p>If not specified, the location is relative from the <tt>KARAF_BASE</tt> variable. It's also possible to use variable like<br/>${karaf.home}, ${karaf.base}, ${karaf.etc}, or even system properties.</p><p>For instance:</p><pre>
+<configfile finalname="${karaf.etc}/myfile.cfg" override="false">URL</configfile>
+</pre><p>If the file is already present at the desired location it is kept and the deployment of the configuration file is skipped,<br/>as a already existing file might contain customization. This behaviour can be overriden by <tt>override</tt> set to true.</p><p>The file URL is any URL supported by Apache Karaf (see the <a href="urls.html">Artifacts repositories and URLs</a> of the user guide for details).</p><h3 id="Requirements">Requirements</h3><p>A feature can also specify expected requirements. The feature resolver will try to satisfy the requirements. For that, it checks<br/>the features and bundles capabilities and will automatically install the bundles to satisfy the requirements.</p><p>For instance, a feature can contain:</p><pre>
<requirement>osgi.ee;filter:="&osgi.ee=JavaSE)(!(version>1.8)))"/requirement>
</pre><p>The requirement specifies that the feature will work by only if the JDK version is not 1.8 (so basically 1.7).</p><p>The features resolver is also able to refresh the bundles when an optional dependency is satisfy, rewiring the optional import.</p><h2 id="Commands">Commands</h2><h3 id="featurerepolist"><tt>feature:repo-list</tt></h3><p>The <tt>feature:repo-list</tt> command lists all registered features repository:</p><pre>
karaf@root()> feature:repo-list
Modified: karaf/site/production/manual/latest/users-guide/remote.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/users-guide/remote.html?rev=1720992&r1=1720991&r2=1720992&view=diff
==============================================================================
--- karaf/site/production/manual/latest/users-guide/remote.html (original)
+++ karaf/site/production/manual/latest/users-guide/remote.html Sun Dec 20 07:47:05 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 4.0.2-SNAPSHOT Guides
+ Apache Karaf 4.0.3 Guides
</title>
</head>
<body>
Modified: karaf/site/production/manual/latest/users-guide/security.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/users-guide/security.html?rev=1720992&r1=1720991&r2=1720992&view=diff
==============================================================================
--- karaf/site/production/manual/latest/users-guide/security.html (original)
+++ karaf/site/production/manual/latest/users-guide/security.html Sun Dec 20 07:47:05 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 4.0.2-SNAPSHOT Guides
+ Apache Karaf 4.0.3 Guides
</title>
</head>
<body>
Modified: karaf/site/production/manual/latest/users-guide/start-stop.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/users-guide/start-stop.html?rev=1720992&r1=1720991&r2=1720992&view=diff
==============================================================================
--- karaf/site/production/manual/latest/users-guide/start-stop.html (original)
+++ karaf/site/production/manual/latest/users-guide/start-stop.html Sun Dec 20 07:47:05 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 4.0.2-SNAPSHOT Guides
+ Apache Karaf 4.0.3 Guides
</title>
</head>
<body>
Modified: karaf/site/production/manual/latest/users-guide/tuning.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/users-guide/tuning.html?rev=1720992&r1=1720991&r2=1720992&view=diff
==============================================================================
--- karaf/site/production/manual/latest/users-guide/tuning.html (original)
+++ karaf/site/production/manual/latest/users-guide/tuning.html Sun Dec 20 07:47:05 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 4.0.2-SNAPSHOT Guides
+ Apache Karaf 4.0.3 Guides
</title>
</head>
<body>
Modified: karaf/site/production/manual/latest/users-guide/update.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/users-guide/update.html?rev=1720992&r1=1720991&r2=1720992&view=diff
==============================================================================
--- karaf/site/production/manual/latest/users-guide/update.html (original)
+++ karaf/site/production/manual/latest/users-guide/update.html Sun Dec 20 07:47:05 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 4.0.2-SNAPSHOT Guides
+ Apache Karaf 4.0.3 Guides
</title>
</head>
<body>
Modified: karaf/site/production/manual/latest/users-guide/urls.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/users-guide/urls.html?rev=1720992&r1=1720991&r2=1720992&view=diff
==============================================================================
--- karaf/site/production/manual/latest/users-guide/urls.html (original)
+++ karaf/site/production/manual/latest/users-guide/urls.html Sun Dec 20 07:47:05 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 4.0.2-SNAPSHOT Guides
+ Apache Karaf 4.0.3 Guides
</title>
</head>
<body>
@@ -101,7 +101,7 @@
</td>
<td height="100%" width="100%">
<div class="wiki-content">
-<h1 id="ArtifactsrepositoriesandURLs">Artifacts repositories and URLs</h1><p>// TODO temp<br/>The main information provided by a feature is the set of OSGi bundles that defines the application. Such bundles are URLs pointing to the actual bundle jars. For example, one would write the following definition:</p><pre>
+<h1 id="ArtifactsrepositoriesandURLs">Artifacts repositories and URLs</h1><p>The main information provided by a feature is the set of OSGi bundles that defines the application. Such bundles are URLs pointing to the actual bundle jars. For example, one would write the following definition:</p><pre>
<bundle>http://repo1.maven.org/maven2/org/apache/servicemix/nmr/org.apache.servicemix.nmr.api/1.0.0-m2/org.apache.servicemix.nmr.api-1.0.0-m2.jar</bundle>
</pre><p>Doing this will make sure the above bundle is installed while installing the feature.</p><p>However, Karaf provides several URL handlers, in addition to the usual ones (file, http, etc...). One of these is the Maven URL handler, which allow reusing maven repositories to point to the bundles.</p><p>You can deploy bundles from file system without using Maven</p><p>As we can use file: as protocol handler to deploy bundles, you can use the following syntax to deploy bundles when they are<br/>located in a directory which is not available using Maven</p><pre>
<bundle>file:base/bundles/org.apache.servicemix.nmr.api-1.0.0-m2.jar</bundle>
Modified: karaf/site/production/manual/latest/users-guide/webconsole.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/users-guide/webconsole.html?rev=1720992&r1=1720991&r2=1720992&view=diff
==============================================================================
--- karaf/site/production/manual/latest/users-guide/webconsole.html (original)
+++ karaf/site/production/manual/latest/users-guide/webconsole.html Sun Dec 20 07:47:05 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 4.0.2-SNAPSHOT Guides
+ Apache Karaf 4.0.3 Guides
</title>
</head>
<body>
Modified: karaf/site/production/manual/latest/users-guide/webcontainer.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/users-guide/webcontainer.html?rev=1720992&r1=1720991&r2=1720992&view=diff
==============================================================================
--- karaf/site/production/manual/latest/users-guide/webcontainer.html (original)
+++ karaf/site/production/manual/latest/users-guide/webcontainer.html Sun Dec 20 07:47:05 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 4.0.2-SNAPSHOT Guides
+ Apache Karaf 4.0.3 Guides
</title>
</head>
<body>
Modified: karaf/site/production/manual/latest/users-guide/wrapper.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/users-guide/wrapper.html?rev=1720992&r1=1720991&r2=1720992&view=diff
==============================================================================
--- karaf/site/production/manual/latest/users-guide/wrapper.html (original)
+++ karaf/site/production/manual/latest/users-guide/wrapper.html Sun Dec 20 07:47:05 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 4.0.2-SNAPSHOT Guides
+ Apache Karaf 4.0.3 Guides
</title>
</head>
<body>
@@ -188,11 +188,15 @@ Ubuntu/Debian Linux system detected:
To uninstall the service :
$ rm /etc/init.d/karaf-service
-</pre><p>You can note that <tt>wrapper:install</tt> command detected the running operating system ("Ubuntu/Debian Linux system detected").</p><p>You have a complete explanation and list of system commands to perform to integrate Apache Karaf in your system:</p><pre>
+</pre><p>You can note that <tt>wrapper:install</tt> command detected the running operating system ("Ubuntu/Debian Linux system detected").</p><p>You have a complete explanation and list of system commands to perform to integrate Apache Karaf in your systemV:</p><pre>
ln -s /opt/apache-karaf-4.0.0/bin/karaf-service /etc/init.d/
update-rc.d karaf-service defaults
-</pre><h2 id="Uninstall">Uninstall</h2><p>The <tt>wrapper:install</tt> provides the system commands to perform to uninstall the service/daemon).</p><p>For instance, on Ubuntu/Debian, to uninstall the Apache Karaf service, you have to remove the <tt>karaf-service</tt> script from the runlevel scripts:</p><pre>
+</pre><p>Karaf also supports systemd service, so you can use systemctl instead of SystemV based service:</p><pre>
+systemctl enable /opt/apache-karaf-4.0.2/bin/karaf.service
+</pre><p>This will enable Karaf at system boot.</p><h2 id="Uninstall">Uninstall</h2><p>The <tt>wrapper:install</tt> provides the system commands to perform to uninstall the service/daemon).</p><p>For instance, on Ubuntu/Debian, to uninstall the Apache Karaf service, you have to remove the <tt>karaf-service</tt> script from the runlevel scripts:</p><pre>
rm /etc/init.d/karaf-service
+</pre><p>If you prefered the systemd service instead of systemV:</p><pre>
+systemctl disable karaf
</pre><p>You can remove the "Wrapper Service" installer after that:</p><pre>
karaf@root()> feature:uninstall service-wrapper
</pre><h2 id="NoteforMacOSusers">Note for MacOS users</h2><p>On MacOS you can install the service for an user or for the system.</p><p>If you want to add bin/org.apache.karaf.KARAF as user service move this file into ~/Library/LaunchAgents/:</p><pre>
@@ -342,7 +346,7 @@ wrapper.ntservice.starttype=AUTO_START
# Allow the service to interact with the desktop.
wrapper.ntservice.interactive=false
-</pre>
+</pre><h3 id="systemd">systemd</h3><p>The Karaf service wrapper also support Linux systemd service.</p>
</div>
</td>
</tr>