LibraryToggle FramesPrintFeedback

Configuring Standalone Containers Using the Command Console

Revision History

Overview

The command console's config shell provides commands for editing the configuration of a standalone container. The commands allow you to inspect the container's configuration, add new PIDs, and edit the properties of any PID used by the container. These configuration changes are applied directly to the container and will persist across container restarts.

For more details on the config commands see Config Console Commands in Console Reference.

Listing the current configuration

The config:list command will show all of the PIDs currently in use by the container. As shown in Example 18, the output from config:list contains all of the PIDs and all of the properties for each of the PIDs.

Example 18. Output of the config:list Command

...
----------------------------------------------------------------
Pid:            org.ops4j.pax.logging
BundleLocation: mvn:org.ops4j.pax.logging/pax-logging-service/1.4
Properties:
   log4j.appender.out.layout.ConversionPattern = %d{ABSOLUTE} | %-5.5p | %-16.16
t | %-32.32c{1} | %-32.32C %4L | %m%n
   felix.fileinstall.filename = org.ops4j.pax.logging.cfg
   service.pid = org.ops4j.pax.logging
   log4j.appender.stdout.layout.ConversionPattern = %d{ABSOLUTE} | %-5.5p | %-16
.16t | %-32.32c{1} | %-32.32C %4L | %m%n
   log4j.appender.out.layout = org.apache.log4j.PatternLayout
   log4j.rootLogger = INFO, out, osgi:VmLogAppender
   log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
   log4j.appender.out.file = C:\apache\apache-servicemix-7.1.0.fuse-047/data/log/karaf.log
   log4j.appender.stdout = org.apache.log4j.ConsoleAppender
   log4j.appender.out.append = true
   log4j.appender.out = org.apache.log4j.FileAppender
----------------------------------------------------------------
Pid:            org.ops4j.pax.web
BundleLocation: mvn:org.ops4j.pax.web/pax-web-runtime/0.7.1
Properties:
   org.apache.karaf.features.configKey = org.ops4j.pax.web
   service.pid = org.ops4j.pax.web
   org.osgi.service.http.port = 8181
----------------------------------------------------------------
...

Listing the container's configuration is a good idea before editing a container's configuration. You can use the output to ensure that you know the exact PID to change.

Editing the configuration

Editing a container's configuration involves a number of commands and must be done in the proper sequence. Not following the proper sequence can lead to corrupt configurations or the loss of changes.

To edit a container's configuration:

  1. Start an editing session by typing config:edit PID.

    PID is the PID for the configuration you are editing. It must be entered exactly. If it does not match the desired PID, the container will create a new PID with the specified name.

  2. Remind yourself of the available properties in a particular configuration by typing config:proplist.

  3. Use one of the editing commands to change the properties in the configuration.

    The editing commands include:

    • config:propappend—appends a new property to the configuration

    • config:propset—set the value for a configuration property

    • config:propdel—delete a property from the configuration

  4. Update the configuration in memory and save it to disk by typing config:update.

[Note]Note

To exit the configuration, without saving your changes, type config:cancel.

Example 19 shows a configuration editing session that changes a container's logging behavior.

Example 19. Editing a Configuration

FuseESB@root> config:edit org.apache.karaf.log
FuseESB@root> config:proplist
   service.pid = org.apache.karaf.log
   size = 500
   felix.fileinstall.filename = org.apache.karaf.log.cfg
   pattern = %d{ABSOLUTE} | %-5.5p | %-16.16t | %-32.32c{1} | %-32.32C %4L | %m%n
FuseESB@root> config:propset size 300
FuseESB@root> config:update

Comments powered by Disqus