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/06/30 14:24:59 UTC
karaf git commit: Start update of manual for 4.0.x
Repository: karaf
Updated Branches:
refs/heads/master 223ca778c -> f97e31741
Start update of manual for 4.0.x
Project: http://git-wip-us.apache.org/repos/asf/karaf/repo
Commit: http://git-wip-us.apache.org/repos/asf/karaf/commit/f97e3174
Tree: http://git-wip-us.apache.org/repos/asf/karaf/tree/f97e3174
Diff: http://git-wip-us.apache.org/repos/asf/karaf/diff/f97e3174
Branch: refs/heads/master
Commit: f97e317415ab089388221edad516d3fb69fd494f
Parents: 223ca77
Author: Jean-Baptiste Onofré <jb...@apache.org>
Authored: Tue Jun 30 14:24:44 2015 +0200
Committer: Jean-Baptiste Onofré <jb...@apache.org>
Committed: Tue Jun 30 14:24:44 2015 +0200
----------------------------------------------------------------------
manual/src/main/webapp/overview.conf | 4 +-
manual/src/main/webapp/quick-start.conf | 86 +++++++++++++-------
manual/src/main/webapp/users-guide/cdi.conf | 71 +++++-----------
.../main/webapp/users-guide/configuration.conf | 47 +++++++----
manual/src/main/webapp/users-guide/console.conf | 22 +++--
5 files changed, 129 insertions(+), 101 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/karaf/blob/f97e3174/manual/src/main/webapp/overview.conf
----------------------------------------------------------------------
diff --git a/manual/src/main/webapp/overview.conf b/manual/src/main/webapp/overview.conf
index 18e80dd..7c9f296 100644
--- a/manual/src/main/webapp/overview.conf
+++ b/manual/src/main/webapp/overview.conf
@@ -5,6 +5,8 @@ Apache Karaf is a modern and polymorphic container.
It's a lightweight, powerful, and enterprise ready container powered by OSGi.
You can deploy different kind of applications in Karaf, OSGi or non-OSGi.
+Thanks to his flexibility, Karaf is the perfect container for micro services architecture, integration platform, big data platform, and much more.
+
Apache Karaf uses either Apache Felix Framework or Eclipse Equinox OSGi frameworks, providing additional features on top of the framework.
Apache Karaf can be scaled from a very lightweight container to a fully features enterprise service: it's a very flexible and extensible container, covering all the major needs.
@@ -19,7 +21,7 @@ Here is a short list of provided features:
* *Advanced Logging System*: Apache Karaf supports a large set of Logging framework (slf4j, log4j, etc). Whatever the
logging framework you use, Apache Karaf centralizes the configuration in one file.
* *Provisioning*: Apache Karaf supports a large set of URL where you can install your application (Maven repository, HTTP,
- file, etc). It also provides the concept of "Karaf Feature" which is a way to describe your application.
+ file, etc). It also provides the concept of "Karaf Features" which is a way to describe your application.
* *Management*: Apache Karaf is an enterprise-ready container, providing a lot of management indicators and operations
via JMX.
* *Remote*: Apache Karaf embeds an SSHd server allowing you to use the console remotely. The management layer is also
http://git-wip-us.apache.org/repos/asf/karaf/blob/f97e3174/manual/src/main/webapp/quick-start.conf
----------------------------------------------------------------------
diff --git a/manual/src/main/webapp/quick-start.conf b/manual/src/main/webapp/quick-start.conf
index 943477c..91f97c3 100644
--- a/manual/src/main/webapp/quick-start.conf
+++ b/manual/src/main/webapp/quick-start.conf
@@ -4,7 +4,7 @@ This instructions should help you get Apache Karaf up and running in 5 to 15 min
h2. Prerequisites
-Karaf requires a Java SE 7 environment to run. Refer to [http://www.oracle.com/technetwork/java/javase/] for details on how to download and install Java SE 1.7 or greater.
+Karaf requires a Java SE 7 or Java SE 8 environment to run. Refer to [http://www.oracle.com/technetwork/java/javase/] for details on how to download and install Java SE 1.7 or greater.
* Open a Web browser and access the following URL: [http://karaf.apache.org/index/community/download.html]
* Download the binary distribution that matches your system (zip for windows, tar.gz for unixes)
@@ -31,7 +31,7 @@ You should see the following information on the command line console:
/ /| |/ /_/ / / / /_/ / __/
/_/ |_|\__,_/_/ \__,_/_/
- Apache Karaf (3.0.0)
+ Apache Karaf (4.0.0)
Hit '<tab>' for a list of available commands
and '[cmd] --help' for help on a specific command.
@@ -45,13 +45,16 @@ h2. Some shell Basics
You can now run your first command. Simply type the {{<tab>}} key in the console.
{code:borderStyle=solid}
-karaf@root> Display all 183 possibilities? (y or n)
-*:config *:dev *:feature *:instance *:jaas *:kar *:log *:package
-*:region *:service *:shell *:ssh addbundle addfilter addregion alias
-cancel cl clear clone config config:cancel config:delete config:edit
-config:list config:property-append config:property-delete config:property-list config:property-set config:update connect create
-date delete destroy dev dev:dump-create display dump-create each
+karaf@root()> Display all 294 possibilities? (y or n)
...
+shell:logout shell:more shell:new shell:printf shell:sleep shell:sort shell:source
+shell:stack-traces-print shell:tac shell:tail shell:threads shell:watch shell:wc shell:while
+shutdown sleep sort source ssh ssh ssh-host-change
+ssh-port-change ssh:ssh stack-traces-print start start-level status stop
+su sudo system system:framework system:name system:property system:shutdown
+system:start-level system:version tac tail threads tree-show uninstall
+update user-add user-delete user-list version version-list wait
+watch wc while
{code}
You can then grab more specific help for a given command using the {{--help}} option for this command:
@@ -64,22 +67,32 @@ DESCRIPTION
Lists all installed bundles.
SYNTAX
- bundle:list [options]
+ bundle:list [options] [ids]
+
+ARGUMENTS
+ ids
+ The list of bundle (identified by IDs or name or name/version) separated by whitespaces
OPTIONS
- -u
- Shows the update locations
- --help
- Display this help message
- --table
- Show bundles using a shell table
-t
Specifies the bundle threshold; bundles with a start-level less than this value will not get printed out.
- -l
- Show the locations
+ --no-format
+ Disable table rendered output
-s
Shows the symbolic name
+ -l
+ Show the locations
+ --no-ellipsis
+ --help
+ Display this help message
+ -u
+ Shows the update locations
+ --context, -c
+ Use the given bundle context
+ (defaults to 0)
+ -r
+ Shows the bundle revisions
{code}
Note that the console supports tab completion so if your start typing a command it will show possible completions and also auto complete if there is only one completion.
@@ -90,26 +103,35 @@ While you will learn in the Karaf user's guide how to fully use and leverage Apa
In the console, run the following commands:
{code}
-karaf@root()> feature:repo-add camel 2.10.0
-Adding feature url mvn:org.apache.camel.karaf/apache-camel/2.10.0/xml/features
+karaf@root()> feature:repo-add camel 2.15.2
+Adding feature url mvn:org.apache.camel.karaf/apache-camel/2.15.2/xml/features
karaf@root()> feature:install camel-spring
-karaf@root()> bundle:install -s mvn:org.apache.camel/camel-example-osgi/2.10.1
+karaf@root()> bundle:install -s mvn:org.apache.camel/camel-example-osgi/2.15.2
+Bundle ID: 82
{code}
-The example installed is using Camel to start a timer every 2 seconds and output a message on the console.
+The example installed is using Camel to start a timer every 2 seconds and output a message in the log.
The previous commands download the Camel features descriptor and install the example feature.
-{code}
->>>> SpringDSL set body: Fri Jan 07 11:59:51 CET 2011
->>>> SpringDSL set body: Fri Jan 07 11:59:53 CET 2011
->>>> SpringDSL set body: Fri Jan 07 11:59:55 CET 2011
+
+You can display the log in the shell:
{code}
+karaf@root()> log:display
+...
+2015-06-30 13:39:44,731 | INFO | timer://myTimer | ExampleRouter | 53 - org.apache.camel.camel-core - 2.15.2 | Exchange[ExchangePattern: InOnly, BodyType: String, Body: SpringDSL set body: Tue Jun 30 13:39:44 CEST 2015]
+2015-06-30 13:39:46,730 | INFO | timer://myTimer | MyTransform | 82 - camel-example-osgi - 2.15.2 | >>>> SpringDSL set body: Tue Jun 30 13:39:46 CEST 2015
+2015-06-30 13:39:46,731 | INFO | timer://myTimer | ExampleRouter | 53 - org.apache.camel.camel-core - 2.15.2 | Exchange[ExchangePattern: InOnly, BodyType: String, Body: SpringDSL set body: Tue Jun 30 13:39:46 CEST 2015]
+2015-06-30 13:39:48,730 | INFO | timer://myTimer | MyTransform | 82 - camel-example-osgi - 2.15.2 | >>>> SpringDSL set body: Tue Jun 30 13:39:48 CEST 2015
+2015-06-30 13:39:48,730 | INFO | timer://myTimer | ExampleRouter | 53 - org.apache.camel.camel-core - 2.15.2 | Exchange[ExchangePattern: InOnly, BodyType: String, Body: SpringDSL set body: Tue Jun 30 13:39:48 CEST 2015]
+{code}
h3. Stopping and uninstalling the sample application
-To stop this demo, run the following command:
+To stop and uninstall the demo, run the following command:
+
{code}
-karaf@root()> bundle:stop org.apache.camel.camel-example-osgi
+karaf@root()> bundle:stop camel-example-osgi
+karaf@root()> bundle:uninstall camel-example-osgi
{code}
h2. Stopping Karaf
@@ -118,9 +140,17 @@ To stop Karaf from the console, enter {{^D}} in the console:
{code}
^D
{code}
+
Alternatively, you can also run the following command:
+
+{code}
+karaf@root()> system:shutdown
+{code}
+
+halt is also an alias to system:shutdown:
+
{code}
-system:shutdown
+karaf@root()> halt
{code}
h3. Cleaning the Karaf state
http://git-wip-us.apache.org/repos/asf/karaf/blob/f97e3174/manual/src/main/webapp/users-guide/cdi.conf
----------------------------------------------------------------------
diff --git a/manual/src/main/webapp/users-guide/cdi.conf b/manual/src/main/webapp/users-guide/cdi.conf
index 6cbcb16..be474a4 100644
--- a/manual/src/main/webapp/users-guide/cdi.conf
+++ b/manual/src/main/webapp/users-guide/cdi.conf
@@ -7,43 +7,32 @@ h2. Pax CDI
Apache Karaf supports different CDI containers by using Pax CDI.
-Pax CDI is pre-referenced in Apache Karaf. To register the Pax CDI features, you can do:
-
-{code}
-karaf@root()> feature:repo-add pax-cdi
-{code}
-
-This command will register the latest pax-cdi features.
+Pax CDI is pre-loaded in Apache Karaf.
You can see now a set of new CDI features available:
{code}
karaf@root()> feature:list|grep -i cdi
-openwebbeans | 1.2.1 | | | enterprise-4.0.0-SNAPSHOT | Apache OpenWebBeans CDI container support
-weld | 2.1.1.Final | | | enterprise-4.0.0-SNAPSHOT | JBoss Weld CDI container support
-pax-cdi | 0.8.0 | | | org.ops4j.pax.cdi-0.8.0 | Provide CDI support
-pax-cdi-1.1 | 0.8.0 | | | org.ops4j.pax.cdi-0.8.0 | Provide CDI 1.1 support
-pax-cdi-1.2 | 0.8.0 | | | org.ops4j.pax.cdi-0.8.0 | Provide CDI 1.2 support
-pax-cdi-weld | 0.8.0 | | | org.ops4j.pax.cdi-0.8.0 | Weld CDI support
-pax-cdi-1.1-weld | 0.8.0 | | | org.ops4j.pax.cdi-0.8.0 | Weld CDI 1.1 support
-pax-cdi-1.2-weld | 0.8.0 | | | org.ops4j.pax.cdi-0.8.0 | Weld CDI 1.2 support
-pax-cdi-openwebbeans | 0.8.0 | | | org.ops4j.pax.cdi-0.8.0 | OpenWebBeans CDI support
-pax-cdi-web | 0.8.0 | | | org.ops4j.pax.cdi-0.8.0 | Web CDI support
-pax-cdi-1.1-web | 0.8.0 | | | org.ops4j.pax.cdi-0.8.0 | Web CDI 1.1 support
-pax-cdi-1.2-web | 0.8.0 | | | org.ops4j.pax.cdi-0.8.0 | Web CDI 1.2 support
-pax-cdi-web-weld | 0.8.0 | | | org.ops4j.pax.cdi-0.8.0 | Weld Web CDI support
-pax-cdi-1.1-web-weld | 0.8.0 | | | org.ops4j.pax.cdi-0.8.0 | Weld Web CDI 1.1 support
-pax-cdi-1.2-web-weld | 0.8.0 | | | org.ops4j.pax.cdi-0.8.0 | Weld Web CDI 1.2 support
-pax-cdi-web-openwebbeans | 0.8.0 | | | org.ops4j.pax.cdi-0.8.0 | OpenWebBeans Web CDI support
-deltaspike-core | 1.0.0 | | | org.ops4j.pax.cdi-0.8.0 | Apache Deltaspike core support
-deltaspike-jpa | 1.0.0 | | | org.ops4j.pax.cdi-0.8.0 | Apache Deltaspike jpa support
+pax-cdi | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Provide CDI support
+pax-cdi-1.1 | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Provide CDI 1.1 support
+pax-cdi-1.2 | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Provide CDI 1.2 support
+pax-cdi-weld | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Weld CDI support
+pax-cdi-1.1-weld | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Weld CDI 1.1 support
+pax-cdi-1.2-weld | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Weld CDI 1.2 support
+pax-cdi-openwebbeans | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | OpenWebBeans CDI support
+pax-cdi-web | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Web CDI support
+pax-cdi-1.1-web | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Web CDI 1.1 support
+pax-cdi-1.2-web | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Web CDI 1.2 support
+pax-cdi-web-weld | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Weld Web CDI support
+pax-cdi-1.1-web-weld | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Weld Web CDI 1.1 support
+pax-cdi-1.2-web-weld | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Weld Web CDI 1.2 support
+pax-cdi-web-openwebbeans | 0.12.0 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | OpenWebBeans Web CDI support
+deltaspike-core | 1.2.1 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Apache Deltaspike core support
+deltaspike-jpa | 1.2.1 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Apache Deltaspike jpa support
+deltaspike-partial-bean | 1.2.1 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Apache Deltaspike partial bean support
+deltaspike-data | 1.2.1 | | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Apache Deltaspike data support
{code}
-{warning}
-Starting from Apache Karaf 3.0.1, the {{feature:repo-add pax-cdi}} command is no more required.
-Pax CDI features are now automatically included in the Apache Karaf enterprise features.
-{warning}
-
h2. CDI Containers
Thanks to Pax CDI, Apache Karaf supports multiple CDI implementation versions, and different CDI containers.
@@ -57,16 +46,9 @@ Apache Karaf provides a ready to use feature for Apache OpenWebBeans.
The {{openwebbeans}} feature automatically install the Pax CDI features and the Apache OpenWebBeans bundles:
{code}
-karaf@root()> feature:install openwebbeans
-{code}
-
-{warning}
-With Apache Karaf 3.0.0, don't forget to register the pax-cdi features repository first with:
-
-{code}
-karaf@root()> feature:repo-add pax-cdi
+karaf@root()> feature:install http
+karaf@root()> feature:install pax-cdi-openwebbeans
{code}
-{warning}
h3. JBoss Weld CDI container
@@ -75,14 +57,5 @@ Apache Karaf provides a ready to use feature for JBoss Weld.
The {{weld}} feature automatically install the Pax CDI features and the JBoss Weld bundles:
{code}
-karaf@root()> feature:install weld
+karaf@root()> feature:install pax-cdi-weld
{code}
-
-{warning}
-With Apache Karaf 3.0.0, don't forget to register the pax-cdi features repository first with:
-
-{code}
-karaf@root()> feature:repo-add pax-cdi
-{code}
-{warning}
-
http://git-wip-us.apache.org/repos/asf/karaf/blob/f97e3174/manual/src/main/webapp/users-guide/configuration.conf
----------------------------------------------------------------------
diff --git a/manual/src/main/webapp/users-guide/configuration.conf b/manual/src/main/webapp/users-guide/configuration.conf
index d2730d7..d9d5801 100644
--- a/manual/src/main/webapp/users-guide/configuration.conf
+++ b/manual/src/main/webapp/users-guide/configuration.conf
@@ -37,6 +37,7 @@ felix.fileinstall.filter = .*\\.cfg
felix.fileinstall.poll = 1000
felix.fileinstall.noInitialDelay = true
felix.fileinstall.log.level = 3
+felix.fileinstall.log.default = jul
...
{code}
@@ -54,6 +55,7 @@ Karaf starts or wait for a certain time. If {{true}}, Apache Karaf polls the con
service starts.
* {{felix.fileinstall.log.level}} is the log message verbosity level of the configuration polling service. More
this value is high, more verbose the configuration service is.
+* {{felix.fileinstall.log.default}} is the logging framework to use, {{jul}} meaning Java Util Logging.
You can change the configuration at runtime by directly editiing the configuration file.
@@ -92,7 +94,7 @@ Properties:
service.pid = org.apache.karaf.log
size = 500
pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n
- felix.fileinstall.filename = file:/opt/apache-karaf-3.0.0/etc/org.apache.karaf.log.cfg
+ felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg
...
{code}
@@ -104,12 +106,12 @@ For instance, you can display details on one specific configuration using the fo
karaf@root()> config:list "(service.pid=org.apache.karaf.log)"
----------------------------------------------------------------
Pid: org.apache.karaf.log
-BundleLocation: mvn:org.apache.karaf.log/org.apache.karaf.log.core/3.0.0
+BundleLocation: mvn:org.apache.karaf.log/org.apache.karaf.log.core/4.0.0
Properties:
+ felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg
+ pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n
service.pid = org.apache.karaf.log
size = 500
- pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n
- felix.fileinstall.filename = file:/opt/apache-karaf-3.0.0/etc/org.apache.karaf.log.cfg
{code}
h3. {{config:edit}}
@@ -141,10 +143,10 @@ Assuming that you edited the {{org.apache.karaf.log}} configuration, you can do:
{code}
karaf@root()> config:property-list
+ felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg
+ pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n
service.pid = org.apache.karaf.log
size = 500
- pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n
- felix.fileinstall.filename = file:/opt/apache-karaf-3.0.0/etc/org.apache.karaf.log.cfg
{code}
h3. {{config:property-set}}
@@ -157,10 +159,10 @@ you can do:
{code}
karaf@root()> config:property-set size 1000
karaf@root()> config:property-list
+ felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg
+ pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n
service.pid = org.apache.karaf.log
size = 1000
- pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n
- felix.fileinstall.filename = file:/opt/apache-karaf-3.0.0/etc/org.apache.karaf.log.cfg
{code}
If the property doesn't exist, the {{config:property-set}} command creates the property.
@@ -177,7 +179,7 @@ Properties:
service.pid = org.apache.karaf.log
size = 1000
pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n
- felix.fileinstall.filename = file:/opt/apache-karaf-3.0.0/etc/org.apache.karaf.log.cfg
+ felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg
{code}
{warning}
@@ -198,7 +200,7 @@ karaf@root()> config:property-list
service.pid = org.apache.karaf.log
size = 5001
pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n
- felix.fileinstall.filename = file:/opt/apache-karaf-3.0.0/etc/org.apache.karaf.log.cfg
+ felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg
{code}
Like the {{config:property-set}} command, if the property doesn't exist, the {{config:property-set}} command creates
@@ -216,7 +218,7 @@ Properties:
service.pid = org.apache.karaf.log
size = 5001
pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n
- felix.fileinstall.filename = file:/opt/apache-karaf-3.0.0/etc/org.apache.karaf.log.cfg
+ felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg
{code}
{warning}
@@ -236,14 +238,14 @@ karaf@root()> config:property-list
service.pid = org.apache.karaf.log
size = 500
pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n
- felix.fileinstall.filename = file:/opt/apache-karaf-3.0.0/etc/org.apache.karaf.log.cfg
+ felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg
test = test
karaf@root()> config:property-delete test
karaf@root()> config:property-list
service.pid = org.apache.karaf.log
size = 500
pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n
- felix.fileinstall.filename = file:/opt/apache-karaf-3.0.0/etc/org.apache.karaf.log.cfg
+ felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg
{code}
You can use the {{config:property-delete}} command outside the configuration edit mode, by specifying the {{-p}} (for configuration pid) option:
@@ -275,7 +277,7 @@ Properties:
service.pid = org.apache.karaf.log
size = 500
pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n
- felix.fileinstall.filename = file:/opt/apache-karaf-3.0.0/etc/org.apache.karaf.log.cfg
+ felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg
test = test
{code}
@@ -297,7 +299,7 @@ Properties:
service.pid = org.apache.karaf.log
size = 500
pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n
- felix.fileinstall.filename = file:/opt/apache-karaf-3.0.0/etc/org.apache.karaf.log.cfg
+ felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg
{code}
h3. {{config:delete}}
@@ -329,6 +331,21 @@ karaf@root()> config:list "(service.pid=my.config)"
karaf@root()>
{code}
+h3. {{config:meta}}
+
+The {{config:meta}} command lists the meta type information related to a given configuration.
+
+It allows you to get details about the configuration properties: key, name, type, default value, and description:
+
+{code}
+karaf@root()> config:meta -p org.apache.karaf.log
+Meta type informations for pid: org.apache.karaf.log
+key | name | type | default | description
+---------------------------------------------------------------------------------------------------------------------------------------
+size | Size | int | 500 | size of the log to keep in memory
+pattern | Pattern | String | %d{ABSOLUTE} | %-5.5p | %-16.16t | %-32.32c{1} | %-32.32C %4L | %m%n | Pattern used to display log entries
+{code}
+
h2. JMX ConfigMBean
On the JMX layer, you have a MBean dedicated to the management of the configurations: the ConfigMBean.
http://git-wip-us.apache.org/repos/asf/karaf/blob/f97e3174/manual/src/main/webapp/users-guide/console.conf
----------------------------------------------------------------------
diff --git a/manual/src/main/webapp/users-guide/console.conf b/manual/src/main/webapp/users-guide/console.conf
index 40b40e6..e508793 100644
--- a/manual/src/main/webapp/users-guide/console.conf
+++ b/manual/src/main/webapp/users-guide/console.conf
@@ -6,10 +6,14 @@ To see a list of the available commands in the console, you can use the {{help}}
{code}
karaf@root()> help
-COMMANDS
-bundle
+bundle Enter the subshell
bundle:capabilities Displays OSGi capabilities of a given bundles.
-bundle:classes Displays a list of classes contained in the bundle
+bundle:classes Displays a list of classes/resources contained in the bundle
+bundle:diag Displays diagnostic information why a bundle is not Active
+bundle:dynamic-import Enables/disables dynamic-import for a given bundle.
+bundle:find-class Locates a specified class in any deployed bundle
+bundle:headers Displays OSGi headers of a given bundles.
+bundle:id Gets the bundle ID.
...
{code}
@@ -18,7 +22,7 @@ You have the list of all commands with a short description.
You can use the tab key to get a quick list of all commands:
{code}
-karaf@root()> Display all 280 possibilities? (y or n)
+karaf@root()> Display all 294 possibilities? (y or n)
...
{code}
@@ -86,7 +90,7 @@ FIRST
{{shell:completion}} can inform you about the current completion mode used. You can also provide the new completion mode that you want.
-GLOBAL completion mode is the default one in Karaf 3.0.0 (mostly for transition purpose).
+GLOBAL completion mode is the default one in Karaf 4.0.0 (mostly for transition purpose).
GLOBAL mode doesn’t really use subshell: it’s the same behavior as in previous Karaf versions.
@@ -269,8 +273,11 @@ h3. Pipe
You can pipe the output of one command as input to another one. It's a pipe, using the | character:
{code}
-karaf@root()> feature:list | grep -i war
-war | 4.0.0 | | standard-4.0.0 | Turn Karaf as a full WebContainer
+karaf@root()> feature:list |grep -i war
+pax-war | 4.1.4 | | Uninstalled | org.ops4j.pax.web-4.1.4 | Provide support of a full WebContainer
+pax-war-tomcat | 4.1.4 | | Uninstalled | org.ops4j.pax.web-4.1.4 |
+war | 4.0.0 | | Uninstalled | standard-4.0.0 | Turn Karaf as a full WebContainer
+blueprint-web | 4.0.0 | | Uninstalled | standard-4.0.0 | Provides an OSGI-aware Servlet ContextListener fo
{code}
h3. Grep, more, find, ...
@@ -298,7 +305,6 @@ Karaf console provides some core commands similar to Unix environment:
* {{shell:more}} is a file pager
* {{shell:new}} creates a new Java object
* {{shell:printf}} formats and prints arguments
-* {{shell:tac}} captures stdin and returns it as a string
* {{shell:sleep}} sleeps for a bit then wakes up
* {{shell:sort}} writes sorted concatenation of all files to stdout
* {{shell:source}} executes commands contained in a script