You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@karaf.apache.org by cs...@apache.org on 2013/10/24 10:10:59 UTC
svn commit: r1535303 - in /karaf/trunk/manual/src/main/webapp/users-guide:
child-instances.conf failover.conf http.conf jmx.conf security.conf
web-applications.conf
Author: cschneider
Date: Thu Oct 24 08:10:58 2013
New Revision: 1535303
URL: http://svn.apache.org/r1535303
Log:
KARAF-1186 Some more fixes to the manual
Modified:
karaf/trunk/manual/src/main/webapp/users-guide/child-instances.conf
karaf/trunk/manual/src/main/webapp/users-guide/failover.conf
karaf/trunk/manual/src/main/webapp/users-guide/http.conf
karaf/trunk/manual/src/main/webapp/users-guide/jmx.conf
karaf/trunk/manual/src/main/webapp/users-guide/security.conf
karaf/trunk/manual/src/main/webapp/users-guide/web-applications.conf
Modified: karaf/trunk/manual/src/main/webapp/users-guide/child-instances.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/child-instances.conf?rev=1535303&r1=1535302&r2=1535303&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/child-instances.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/child-instances.conf Thu Oct 24 08:10:58 2013
@@ -4,7 +4,7 @@ A child instance of Karaf is a copy that
h2. Using the instance console commands
-The *instance* console commands allow you to create and manage instances of Karaf on the same machine. Each new runtime is a child instance of the runtime that created it. You can easily manage the children using names instead of network addresses. For details on the *admin* commands, see the [{{admin}} commands|/commands/admin].
+The *instance* console commands allow you to create and manage instances of Karaf on the same machine. Each new runtime is a child instance of the runtime that created it. You can easily manage the children using names instead of network addresses. For details on the *instance* commands, see the [{{instance}} commands|/commands/admin].
h2. Creating child instances
Modified: karaf/trunk/manual/src/main/webapp/users-guide/failover.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/failover.conf?rev=1535303&r1=1535302&r2=1535303&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/failover.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/failover.conf Thu Oct 24 08:10:58 2013
@@ -1,10 +1,10 @@
h1. Failover Deployments
-Karaf provides failover capability using either a simple lock file system or a JDBC locking mechanism. In both cases, a container-level lock system allows bundles to be preloaded into the slave Karaf instance in order to provide faster failover performance.
+Karaf provides failover capability using either a simple lock file or a JDBC locking mechanism. In both cases, a container-level lock system allows bundles to be preloaded into the slave Karaf instance in order to provide faster failover performance.
h2. Simple lock file
-The simple lock file mechanism is intended for failover configurations where instances reside on the same host machine.
+The simple lock file mechanism is intended for failover configurations where instances reside on the same host machine or share a file system with lock support.
To use this feature, edit the {{$KARAF_HOME/etc/system.properties}} file as follows on each system in the master/slave setup:
@@ -48,6 +48,7 @@ karaf.lock.jdbc.timeout=30
* The "sample" database referred to above will be created if it does not exist.
* The first Karaf instance to acquire the locking table is the master instance.
* If the connection to the database is lost, the master instance tries to gracefully shutdown, allowing a slave instance to become master when the database service is restored. The former master will require a manual restart.
+* For 2.2.x, 2.3.x, 3.0.x you need to rename the database Driver jar to prefix with 'karaf-' in order for karaf to pick it up, otherwise you will see karaf just hang on startup and the log will show you that it could not find the driver.
h3. JDBC locking on Oracle
@@ -93,8 +94,6 @@ h3. MySQL
Make sure you have the MySQL driver jar file in the Karaf {{lib}} folder before starting Karaf.
-*NOTE*: for 2.2.x, 2.3.x, 3.0.x you need to rename the MySQL Driver jar to prefix with 'karaf-' in order for karaf to pick it up, otherwise you will see karaf just hang on startup and the log will show you that it could not find the driver.
-
Then make you update the properties in {{$KARAF_HOME/etc/system.properties}} to look something like this example:
{noformat}
@@ -113,8 +112,6 @@ h3. PostgreSQL
Make sure you have the PostgreSQL driver jar file in the Karaf {{lib}} folder before starting Karaf.
-*NOTE*: for 2.2.x, 2.3.x, 3.0.x you need to rename the PostgreSQL Driver jar to prefix with 'karaf-' in order for karaf to pick it up, otherwise you will see karaf just hang on startup and the log will show you that it could not find the driver.
-
Then make you update the properties in {{$KARAF_HOME/etc/system.properties}} to look something like this example:
{noformat}
Modified: karaf/trunk/manual/src/main/webapp/users-guide/http.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/http.conf?rev=1535303&r1=1535302&r2=1535303&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/http.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/http.conf Thu Oct 24 08:10:58 2013
@@ -34,7 +34,7 @@ h2. Using the Pax Web whiteboard extende
The Pax Web whiteboard extender is an enhancement of the http feature. So use the following command to install:
{code}
-root@karaf> features:install http-whiteboard
+root@karaf> feature:install http-whiteboard
{code}
The [Pax Web whiteboard|http://team.ops4j.org/wiki/display/ops4j/Pax+Web+Extender+-+Whiteboard] extender listens to services
@@ -56,3 +56,4 @@ So it is much more convenient than regis
The above snippet publishes the Servlet MyServlet on http://localhost:8080/myServlet.
Please keep in mind that the Whiteboard pattern for Servlets is not standardized and only works with Pax Web.
+
Modified: karaf/trunk/manual/src/main/webapp/users-guide/jmx.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/jmx.conf?rev=1535303&r1=1535302&r2=1535303&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/jmx.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/jmx.conf Thu Oct 24 08:10:58 2013
@@ -43,11 +43,7 @@ Apache Karaf provides the following MBea
h2. JMX Operations and ACL
-Karaf 3.x provides support of Access Lists (ACL) to the JMX operations.
-
-Whenever a JMX operation is invoked, the roles of the current user are checked against the required roles for this operation.
-
-This is done through a JMX interceptor which is added through the following command line option:
+Karaf 3.x provides support of Access Control Lists (ACL) to the JMX operations. Whenever a JMX operation is invoked, the roles of the current user are checked against the required roles for this operation. This is done through a JMX interceptor which is added through the following command line option:
{code}
-Djavax.management.builder.initial=org.apache.karaf.management.boot.KarafMBeanServerBuilder
@@ -126,14 +122,11 @@ By default, all "read-only" operations (
The org.apache.karaf:type=security,area=jmx MBean can be used to check whether the current user can access a certain MBean or invoke a specific operation on it.
This MBean can be used by management clients (monitoring tools, etc) to decide whether to show certain MBeans or operations to the end user.
-h1. Registering its own MBean(s)
+h1. Registering user MBeans
-The Karaf container exposes a MBeanServer as an OSGI service. This server is created when Karaf boots and can be used to registers its own MBeans. The processus is really simple as it only
-requires that the bean/pojo of the project extend the javax.management.StandardMBean class and implements an interface where the name of the class MUST contain the extension MBean.
+The Karaf container exposes an MBeanServer as an OSGI service. This server is created when Karaf boots and can be used to registers its own MBeans. The processus is really simple as it only requires that the bean/pojo of the project extend the javax.management.StandardMBean class and implements an interface where the name of the class MUST contain the extension MBean.
-Karaf 3.x simplifies a lot the process of custom MBean registration.
-
-You just have to write your MBean and register it as an OSGi service (using Blueprint for instance), providing the JMX ObjectName property:
+Karaf 3.x uses Aries JMX to facilitate registering MBeans. Simply publish you MBean as an OSGi service (using Blueprint for instance), providing the JMX ObjectName property:
{code}
<bean id="customMBean" class="...."/>
@@ -145,4 +138,5 @@ You just have to write your MBean and re
</service>
{code}
-The customMBean is a simple POJO implementing the MBeanRegistration interface (and your own interface).
\ No newline at end of file
+The customMBean is a simple POJO implementing the MBeanRegistration interface (and your own interface).
+
Modified: karaf/trunk/manual/src/main/webapp/users-guide/security.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/security.conf?rev=1535303&r1=1535302&r2=1535303&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/security.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/security.conf Thu Oct 24 08:10:58 2013
@@ -78,7 +78,7 @@ org.osgi.framework.bootdelegation = ...,
h2. Users, groups, and roles
-An user can be a member of a group or have roles assigned directly.
+A user can be a member of a group or have roles assigned directly.
Groups typically have one or more roles assigned. Users that are part (member) of that group will get these roles
associated too.
Users have the union of the roles associated with their groups together with their own roles. When logging in, the user
Modified: karaf/trunk/manual/src/main/webapp/users-guide/web-applications.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/web-applications.conf?rev=1535303&r1=1535302&r2=1535303&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/web-applications.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/web-applications.conf Thu Oct 24 08:10:58 2013
@@ -4,7 +4,7 @@ h2. Installing war support
Install the war feature (and the sub-features it requires) -
{noformat}
-karaf@root> features:install war
+karaf@root> feature:install war
{noformat}
The Jetty server should now be listening on {{http://localhost:8181/}}., but with no published applications available. To configure the port see the [HTTP Service config | http].
@@ -33,4 +33,5 @@ karaf@root()> web:list
ID | State | Web-State | Level | Web-ContextPath | Name
----------------------------------------------------------------------------
95 | Active | Deployed | 80 | /sample | tomcat-sample (0)
-{noformat}
\ No newline at end of file
+{noformat}
+