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/26 21:52:56 UTC
svn commit: r1176015 - in
/karaf/branches/karaf-2.2.x/manual/src/main/webapp: manual.conf
users-guide/child-instances.conf users-guide/colorized-console.conf
users-guide/index.conf users-guide/jmx.conf
Author: jbonofre
Date: Mon Sep 26 19:52:56 2011
New Revision: 1176015
URL: http://svn.apache.org/viewvc?rev=1176015&view=rev
Log:
[KARAF-786] Add the JMX documentation
Added:
karaf/branches/karaf-2.2.x/manual/src/main/webapp/users-guide/jmx.conf
Modified:
karaf/branches/karaf-2.2.x/manual/src/main/webapp/manual.conf
karaf/branches/karaf-2.2.x/manual/src/main/webapp/users-guide/child-instances.conf
karaf/branches/karaf-2.2.x/manual/src/main/webapp/users-guide/colorized-console.conf
karaf/branches/karaf-2.2.x/manual/src/main/webapp/users-guide/index.conf
Modified: karaf/branches/karaf-2.2.x/manual/src/main/webapp/manual.conf
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.2.x/manual/src/main/webapp/manual.conf?rev=1176015&r1=1176014&r2=1176015&view=diff
==============================================================================
--- karaf/branches/karaf-2.2.x/manual/src/main/webapp/manual.conf (original)
+++ karaf/branches/karaf-2.2.x/manual/src/main/webapp/manual.conf Mon Sep 26 19:52:56 2011
@@ -53,6 +53,7 @@ h1. Users Guide
{include:users-guide/web-applications.conf}
{include:users-guide/wrapper.conf}
{include:users-guide/jre-tuning.conf}
+{include:users-guide/jmx.conf}
h1. Developers Guide
{include:developers-guide/branding-console.conf}
Modified: karaf/branches/karaf-2.2.x/manual/src/main/webapp/users-guide/child-instances.conf
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.2.x/manual/src/main/webapp/users-guide/child-instances.conf?rev=1176015&r1=1176014&r2=1176015&view=diff
==============================================================================
--- karaf/branches/karaf-2.2.x/manual/src/main/webapp/users-guide/child-instances.conf (original)
+++ karaf/branches/karaf-2.2.x/manual/src/main/webapp/users-guide/child-instances.conf Mon Sep 26 19:52:56 2011
@@ -13,7 +13,7 @@ You create a new runtime instance by typ
As shown in the following example, {{admin:create}} causes the runtime to create a new runtime installation in the active runtime's {{instances/[name]} directory. The new instance is a new Karaf instance and is assigned an SSH port number based on an incremental count starting at 8101 and a RMI registry port number based on an incremental count starting at 1099.
{code}
-karaf@root>admin:create finn
+karaf@root> admin:create finn
Creating new instance on SSH port 8106 and RMI port 1100 at: /home/fuse/esb4/instances/finn
Creating dir: /home/fuse/esb4/instances/finn/bin
Creating dir: /home/fuse/esb4/instances/finn/etc
Modified: karaf/branches/karaf-2.2.x/manual/src/main/webapp/users-guide/colorized-console.conf
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.2.x/manual/src/main/webapp/users-guide/colorized-console.conf?rev=1176015&r1=1176014&r2=1176015&view=diff
==============================================================================
--- karaf/branches/karaf-2.2.x/manual/src/main/webapp/users-guide/colorized-console.conf (original)
+++ karaf/branches/karaf-2.2.x/manual/src/main/webapp/users-guide/colorized-console.conf Mon Sep 26 19:52:56 2011
@@ -5,13 +5,13 @@ The default Karaf installation does not
You first need to install the JNA library:
{code}
-osgi:install wrap:mvn:http://download.java.net/maven/2!net.java.dev.jna/jna/3.1.0
+karaf@root> osgi:install wrap:mvn:http://download.java.net/maven/2!net.java.dev.jna/jna/3.1.0
{code}
Next you need either restart karaf or you run the following Karaf commands to refresh the Karaf Console:
{code}
-osgi:list | grep "Apache Karaf :: Shell Console"
+karaf@root> osgi:list | grep "Apache Karaf :: Shell Console"
{code}
Take note of the ID of the bundle, in my case it was 14 and then run:
Modified: karaf/branches/karaf-2.2.x/manual/src/main/webapp/users-guide/index.conf
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.2.x/manual/src/main/webapp/users-guide/index.conf?rev=1176015&r1=1176014&r2=1176015&view=diff
==============================================================================
--- karaf/branches/karaf-2.2.x/manual/src/main/webapp/users-guide/index.conf (original)
+++ karaf/branches/karaf-2.2.x/manual/src/main/webapp/users-guide/index.conf Mon Sep 26 19:52:56 2011
@@ -21,3 +21,4 @@ h1. Karaf Users Guide
* [Web applications|/users-guide/web-applications]
* [OS integration|/users-guide/wrapper]
* [JRE packages tuning|/users-guide/jre-tuning]
+* [Monitoring and Administration using JMX|/users-guide/jmx]
Added: karaf/branches/karaf-2.2.x/manual/src/main/webapp/users-guide/jmx.conf
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.2.x/manual/src/main/webapp/users-guide/jmx.conf?rev=1176015&view=auto
==============================================================================
--- karaf/branches/karaf-2.2.x/manual/src/main/webapp/users-guide/jmx.conf (added)
+++ karaf/branches/karaf-2.2.x/manual/src/main/webapp/users-guide/jmx.conf Mon Sep 26 19:52:56 2011
@@ -0,0 +1,23 @@
+
+
+h1. Monitoring and Administration using JMX
+
+Apache Karaf provides a large set of MBeans that allow you to fully monitore and administrate Karaf using any JMX client
+(like jconsole for instance).
+
+You can find more or less the same actions that you can do using the shell commands on the JMX layer.
+
+Apache Karaf provides the following MBeans:
+
+* org.apache.karaf:type=admin to administrate the child instances
+* org.apache.karaf:type=bundles to manipulate the OSGi bundles
+* org.apache.karaf:type=config to manipulate the Karaf configuration files (in the etc folder) and the ConfigAdmin layer
+* org.apache.karaf:type=dev to get information and manipulate the OSGi framework
+* org.apache.karaf:type=diagnostic to create information file (dump) about Karaf activity
+* org.apache.karaf:type=features to manipulate the Karaf features
+* org.apache.karaf:type=log to manipulate to logging layer
+* org.apache.karaf:type=packages to manipulate to PackageAdmin layer and get information about exported and imported packages
+* org.apache.karaf:type=services to get information about the OSGi services
+* org.apache.karaf:type=system to shutdown the Karaf container itself
+* org.apache.karaf:type=web to get information about the Web bundles (installed with the war feature)
+* org.apache.karaf:type=obr to manipulate the OBR layer (installed with the obr feature)
\ No newline at end of file