Talend ESB Container Administration Guide

5.0_b

Talend ESB Container: Administration Guide
Publication date 13 February 2012 Copyright © 2011-2012 Talend Inc.

Copyleft
This documentation is provided under the terms of the Creative Commons Public License (CCPL). For more information about what you can and cannot do with this documentation in accordance with the CCPL, please read: http://creativecommons.org/licenses/by-nc-sa/2.0/ This document may include documentation produced at The Apache Software Foundation which is licensed under The Apache License 2.0.

Notices
Talend and Talend ESB are trademarks of Talend, Inc. Apache CXF, CXF, Apache Karaf, Karaf, Apache Camel, Camel, Apache Maven, Maven, Apache Archiva, Archiva are trademarks of The Apache Foundation. Eclipse Equinox is a trademark of the Eclipse Foundation. SoapUI is a trademark of SmartBear Software. All other brands, product names, company names, trademarks and service marks are the properties of their respective owners.

Table of Contents
1. Introduction .............................................................................................................. 1 1.1. Structure of this manual ................................................................................... 1 2. Directory Structure .................................................................................................... 3 3. Starting/Stopping Talend ESB Runtime ......................................................................... 5 3.1. Starting Talend ESB Runtime ........................................................................... 5 3.2. Stopping Talend ESB Runtime .......................................................................... 6 4. Starting/Stopping Talend ESB Infrastructure Components ................................................. 8 4.1. Starting the Service Locator .............................................................................. 8 4.2. Stopping the Service Locator ............................................................................ 8 4.3. Starting Service Activity Monitoring .................................................................. 9 4.4. Stopping Service Activity Monitoring ................................................................. 9 4.5. Starting the Security Token Service (STS) ........................................................... 9 4.6. Stopping the Security Token Service (STS) ......................................................... 9 4.7. Starting all three Talend ESB infrastructure services .............................................. 9 4.8. Stopping all three Talend ESB infrastructure services ........................................... 10 5. Using Console ........................................................................................................ 11 5.1. Viewing commands from the Karaf console ....................................................... 11 5.2. Karaf Console command summary ................................................................... 12 6. Deploying Multiple Karaf Containers .......................................................................... 18 6.1. Deploying multiple containers using configuration adaption scripts ......................... 18 7. Remote Console ...................................................................................................... 20 7.1. Configuring remote instances .......................................................................... 20 7.2. Connecting and disconnecting remotely ............................................................. 21 7.3. Stopping a remote instance ............................................................................. 22 8. Commands supplied by Apache CXF and Camel ........................................................... 23 8.1. Commands supplied by CXF ........................................................................... 24 8.2. Commands supplied by Camel ......................................................................... 24 9. Security ................................................................................................................. 25 9.1. Managing users and passwords ........................................................................ 25 9.2. Managing roles ............................................................................................. 25 9.3. Enabling password encryption ......................................................................... 26 9.4. Available realms ........................................................................................... 26 9.5. Deploying security providers ........................................................................... 29 10. Logging System ..................................................................................................... 31 10.1. Configuration .............................................................................................. 31 10.2. Console Log Commands ............................................................................... 32 10.3. Advanced Configuration ............................................................................... 32 11. Deployer .............................................................................................................. 35 11.1. Features deployer ........................................................................................ 36 11.2. Spring deployer ........................................................................................... 36 11.3. Wrap deployer ............................................................................................ 36 11.4. War deployer .............................................................................................. 38 12. Servlet Context ...................................................................................................... 39 12.1. Configuration .............................................................................................. 39 12.2. Configuring the context ................................................................................ 40 13. Provisioning .......................................................................................................... 41 13.1. Example: Deploying a sample feature .............................................................. 41 13.2. Repositories ................................................................................................ 42 13.3. Commands ................................................................................................. 46 13.4. Service configuration ................................................................................... 47 14. Web Applications .................................................................................................. 48 14.1. Installing WAR support ................................................................................ 48 14.2. Deploying a WAR to the installed web feature .................................................. 50 15. Monitoring and Administration using JMX ................................................................. 51 16. Installing the Talend Runtime container as a service ..................................................... 52 16.1. Introduction ................................................................................................ 52

Talend ESB Container Administration Guide

iii

............................. Installation ................................... Supported platforms .....................................2.................3....................................4.................2................................................. 16..16..... 17.........3............. On Linux ................................. Troubleshooting Talend ESB ....... Installation on Linux ......... Memory Allocation Parameters ......... 16........................................................... On Windows .................................................................................... 52 53 54 57 57 58 58 Talend ESB Container Administration Guide iv .............. 17.. 17................................1........................................................................................................... 17.....................

6...........8..................... 15. 5.......... 5................. config Scope commands ...................................1............................................... Ports configured by the configuration scripts ........ Miscellaneous Scope commands ................................................................................................................10.....7.......................1.................................. Karaf Management MBeans ..................... Camel commands ....................................................... 12 12 13 13 14 14 15 15 16 17 19 24 24 51 Talend ESB Container Administration Guide v ....................List of Tables 5..................................4...........9..........2..........1...........................2............................ 5................................. 5......................................... OBR Scope commands ............................... 5.................................................6.................................. 5........................................................................................................................5................................................................ admin Scope commands ............................................................................ CXF commands ................... OSGi Scope commands ..... Shell Scope commands .................... 8.... 5.......................... 5........... log Scope commands ..... 5.1................. jaas Scope commands ........................................ 8......................... dev Scope commands ............................................................................. features Scope commands ...3......................

• Chapter 5. • Chapter 6. Note As the Talend ESB container is based on Apache Karaf.please see Talend ESB Getting Started Guide for this. Deploying Multiple Karaf Containers describes how to adapt the configuration to deploy multiple containers at the same machine. It is NOT a tutorial on getting started with Karaf .1. • Chapter 4. Using Console gives a list of the console commands available. Directory Structure describes the directory layout of a Talend ESB installation. Starting/Stopping Talend ESB Infrastructure Components describes how to start and stop the infrastructure components of Talend ESB. Talend ESB Container Administration Guide 1 . • Chapter 3.Chapter 1. except when explicitly stressed otherwise. Structure of this manual The following chapters are in this manual: • Chapter 2. Starting/Stopping Talend ESB Runtime describes the various options that are available to start and stop Talend ESB. 1. the two terms are used interchangeably within this document. This container administration manual is intended to provide information on Karaf tooling commands and general administration. Introduction Talend ESB provides an Apache Karaf-based ESB container preconfigured to support Apache Camel routing and Apache CXF-based services (both REST and SOAP-based).

• Chapter 8. • Chapter 11. • Chapter 10. Web Applications describes deploying WAR-based web applications into Talend ESB Runtime. Deployer describes deploying bundles or re-defined groups of bundles (called features). Logging System describes configuring and using the logging system. • Chapter 13. Thus when you install a feature and it will install all of its bundles defined under it. Remote Console describes how to access Talend ESB using a remote console. Provisioning describes how the provisioning system uses xml repositories that define sets of features (bundles). Introduction • Chapter 7. Talend ESB Container Administration Guide 2 . • Chapter 9.Chapter 1. Commands supplied by Apache CXF and Camel describes commands provided by CXF and Camel. Monitoring and Administration using JMX lists the MBeans available to monitor and administrate Karaf using any JMX client. • Chapter 17. Troubleshooting Talend ESB describes how to fix problems related to JVM memory allocation parameters running Talend ESB. • Chapter 14. Security describes how to configure security with Talend ESB. • Chapter 15.

php. The standard directory layout of a Talend ESB installation is as follows: • /bin: startup scripts • /etc: configuration files • /keystores: KeyStore files for JobServer SSL connection • /data: working directory • /cache: OSGi framework bundle cache • /generated-bundles: temporary folder used by the deployer • /log: log files • /deploy: hot deploy directory • /instances: directory containing child instances • /lib: contains the bootstrap libraries • /lib/ext: directory for JRE extensions • /lib/endorsed: directory for endorsed libraries • /system: OSGi bundles repository.talend.Chapter 2. Directory Structure The Talend ESB software may be downloaded from http://www. laid out as a Maven 2 repository Talend ESB Container Administration Guide 3 .com/download.

you can wipe out this directory.Chapter 2. which has the same effect as using the clean option [6]. Directory Structure Note The data folder contains all the working and temporary files for Karaf. If you want to restart from a clean state. Talend ESB Container Administration Guide 4 .

${Talend-ESBVersion}\container . Starting/Stopping Talend ESB Runtime This chapter describes how to start and stop Talend ESB Runtime and the various options that are available. Talend ESB Container Administration Guide 5 . go to: cd [karaf_install_dir] where karaf_install_dir is the directory in which Karaf was installed.Chapter 3. you need to wait a few seconds for initialization to complete before entering the commands..1. 3. e. the job commands may not.g.1. 3. Starting Talend ESB Runtime Wait initally for commands to become available After starting Talend ESB Runtime. Karaf starts the non core bundles in the background. For the binary distribution. On Windows From a console window. change to the installation directory and run Talend ESB Runtime.1. So even if the console is already available.

for example: /usr/local/${TalendESB-Version}/container . On Linux From a console window. Starting/Stopping Talend ESB Runtime Then type: bin\trun. Karaf can be reset to a clean state by simply deleting the [karaf_install_dir]/data folder. For the binary distribution. Starting Talend ESB Runtime without console Karaf can be started without the console if you don't intend to use it (one can always connect using the remote ssh access) using the following command: bin\trun.1. Then type: bin/trun Warning Do NOT close the console or shell in which Karaf was started. 3.bat 3.bat (Windows) bin\start (Linux).2.1.Chapter 3. change to the installation directory and run Talend ESB Runtime. Alternatively. Talend ESB Container Administration Guide 6 . 3.4. 3. do: cd [karaf_install_dir] where karaf_install_dir is the directory in which Karaf was installed. with an optional -f (force) flag to avoid a yes/no confirmation. as that will terminate Karaf (unless Karaf was started using the nohup command).3.bat server (Windows) bin\trun server (Linux).2. Stopping Talend ESB Runtime Within the Karaf console. add clean to the above start command.1. you can perform a clean shutdown of Karaf by using the osgi:shutdown command. Starting Talend ESB Runtime in the background Karaf can be easily started as a background process using the following command: bin\start.

bat (Windows) or bin/stop (Linux). it's also possible to delay the shutdown using the time argument. you can run bin\stop. in which hh is the hour (1 or 2 digits) and mm is the minute of the hour (in two digits). Further. Second.Chapter 3. it can be in the format +m. exiting the shell using logout or Ctrl+D will also terminate the Karaf instance. from a command shell. Examples: The following command will shutdown Karaf at 10:35am: osgi:shutdown 10:35 The following command will shutdown Karaf in 10 minutes: osgi:shutdown +10 Talend ESB Container Administration Guide 7 . The argument now is an alias for +0. The time argument can have different formats. Starting/Stopping Talend ESB Runtime If you're running from the main console. it can be an absolute time in the format hh:mm. in which m is the number of minutes to wait. For more advanced functionality. First.

2.1. Stopping the Service Locator Within the Talend Runtime container you can shutdown the Service Locator by typing: tesb:stop-locator Talend ESB Container Administration Guide 8 . 4. Starting the Service Locator After starting the Talend Runtime container. Starting/Stopping Talend ESB Infrastructure Components This chapter describes how to start and stop the infrastructure components of Talend ESB. 4.Chapter 4. enter the following command at the console prompt: tesb:start-locator Standalone version of the Service Locator Alternatively there is a standalone version of the Service Locator described in the Talend ESB Getting Started Guide.

Stopping Service Activity Monitoring At the console. Starting all three Talend ESB infrastructure services After starting Talend Runtime container. Stopping the Security Token Service (STS) At the console. Starting Service Activity Monitoring After starting the Talend Runtime container.7. you can shutdown Service Activity Monitoring by typing: tesb:stop-sam 4. enter the following command at the console prompt: tesb:start-sam 4. you can shutdown the Security Token Service (STS) by typing: tesb:stop-sts 4.6.3. a port conflict may arise while starting an infrastructure component. Talend ESB Container Administration Guide 9 .4. In this case tesb:start-all will not try to start the remaining infrastructure components. enter the following command at the console prompt: tesb:start-sts 4. Starting/Stopping Talend ESB Infrastructure Components 4. Stop all infrastructure services using tesb:stop-all and restart them after adapting the configuration. Starting the Security Token Service (STS) After starting Talend Runtime container.Chapter 4. enter the following command at the console prompt: tesb:start-all Port Conflicts If there is another Talend Runtime container running at the same machine and you forgot to adapt the configuration of the used ports.5. There are configuration scripts simplifying this task.

Chapter 4. Stopping all three Talend ESB infrastructure services At the console you can shutdown all three Talend ESB infrastructure services by typing: tesb:stop-all Talend ESB Container Administration Guide 10 . Starting/Stopping Talend ESB Infrastructure Components 4.8.

1. Viewing commands from the Karaf console To see a list of the available commands in the console press the tab at the prompt.Chapter 5. completion may be available on options and arguments too. --installed Talend ESB Container Administration Guide 11 . so if you want to see the commands in the osgi group. Depending on the commands. SYNTAX features:list [options] OPTIONS --help Display this help message -i. type the first letters and hit tab. Using Console 5. The tab key toggles completion anywhere on the line. type the command followed by --help or use the help command followed by the name of the command: karaf@trun> features:list --help DESCRIPTION features:list Lists all existing features available from the defined repositories. To view help on a particular command.

Chapter 5. Lists all existing container instances. Creates a new container instance. change-rmi-server. View the command-line or online help as discussed in the previous section for information about the various arguments and options available with each command.2. grouped by scope (family of commands). Admin Scope The commands within the admin: scope involve administration tasks. 5. Config Scope The commands within the config: scope are used to modify configuration data of Karaf instances (data stored in the /etc folder of the Karaf instance. Table 5. including starting and stopping Karaf instances and connecting to them remotely. 5. Changes the RMI registry port (used by management layer) of an existing container instance. admin Scope commands Command change-opts change-rmiregistry-port Parameters [options] name javaOpts [options] name port Description Changes the java options of an existing container instance.1. Destroys an existing container instance. Karaf Console command summary The following tables summarize the out-of-the-box commands available with Karaf. config Scope commands Command cancel Parameters [options] Description Cancels the changes to the configuration being edited. Note there is also a ConfigMBean that can be used to do this configuration within JMX.2.2.2. Changes the RMI server port (used by management layer) of an existing container instance.) Updates take effect immediately without need of restarting Karaf. Changes the secure shell port of an existing container instance.[options] name port port change-ssh-port connect create destroy list rename start stop [options] name port [options] name [command] [options] name [options] name [options] [options] name new-name [options] name [options] name 5. Starts an existing container instance. Talend ESB Container Administration Guide 12 . Connects to an existing container instance. Stops an existing container instance.1.2. Renames an existing container instance. Using Console Display a list of all installed features only Help for each command is also available online at the Apache Karaf website. Table 5.

Dev Scope The commands within the dev: scope are used to providing logging and other system output help to the administrator. Appends the given value to an existing property or creates the property with the specified name and value. Deletes a property from the edited configuration. Table 5.Chapter 5. OSGi Framework options. Talend ESB Container Administration Guide 13 .3. Lists existing configurations. Creates or edits a configuration. Sets a property configuration. which are predefined collections of bundles used to implement specific services. features Scope commands Command addUrl info Parameters [options] urls [options] name [version] Description Adds a list of repository URLs to the features service. dev Scope commands Command create-dump dynamic-import framework print-stack-traces restart show-tree watch Parameters [options] [name] [options] id [options] [framework] [options] [print] [options] [options] id [options] [urls] Description Creates zip archive with diagnostic info. Table 5. Restart Karaf.4. Shows information about selected information. Using Console Command delete edit list propappend Parameters [options] pid [options] pid [options] [query] [options] [query] Description Delete a configuration. Lists properties from the currently edited configuration. Features Scope The commands within the features: scope are used to provide support for Karaf features. Shows the tree of bundles based on the wiring information.2.2. Prints the full stack trace in the console when the execution of a command throws an exception. in the currently edited the propdel proplist propset update [options] property [options] [options] property value [options] Saves and propagates changes configuration being edited.3. Enables/disables dynamic-import for a given bundle. from 5. Watches and updates bundles.4. 5.

jaas Scope commands Command cancel realms manage pending roleadd roledel update useradd userdel users Parameters [options] [options] [options] realm [options] [options] username role [options] username role [options] [options] username password [options] username [options] Description Cancel the modification of a JAAS realm. Lists all versions of a feature available from the currently available repositories.2. Using Console Command install list listRepositories listUrl listVersions refreshUrl removeRepository removeUrl uninstall Parameters [options] feature [options] [options] [options] [options] feature [options] urls [options] repository [options] urls [options] features Description Installs a feature with the specified name and version. Manage user and roles of a Jaas Realm. Table 5. Table 5. Uninstalls a feature with the specified name and version. Lists all existing features available from the defined repositories. Talend ESB Container Administration Guide 14 . Displays a list of all defined repository URLs. Delete a role from a user.5. Lists the modification on the active realm/module. Displays a list of all defined repositories. 5.Chapter 5. Lists the users of the active realm/module. Removes the given list of repository URLs from the features service. Reloads the list of available features from the repositories.5. Add a user. JAAS Scope The commands within the jaas: scope are used for management of JAAS users and realms.6.2. Log Scope The commands within the log: scope are used for management of system logs. Removes the specified repository features service.6. 5. Update JAAS realm. Delete a user. log Scope commands Command clear Parameters [options] Description Clear log entries. Add a role to a user. Lists the modifications on the active realm/ module.

Shows the resolution output for a given set of requirements. Using Console Command display display-exception get set tail Parameters [options] [options] [options] [logger] [options] level [logger] [options] Description Displays log entries. [options] id [startLevel] Gets or sets the start level of a given bundle. starting and stopping. Prints information about OBR bundles. Installs one or more bundles.2.8. Reloads the repositories to obtain a fresh list of bundles. Continuously display log entries.7.8. OSGi Scope The commands within the osgi: scope handle bundle maintenance (installation. Deploys a list of bundles using OBR service. OSGi Scope commands Command bundle-level headers info install Parameters [options] [ids] [options] [ids] [options] [urls] Description Displays OSGi headers of a given bundle. 5. Displays detailed information of a given bundle.) as well as some container-level actions.7.2. Displays the last occurred exception from the log. Table 5. OBR Scope commands Command addUrl deploy find info list listUrl refreshUrl removeUrl resolve source start Parameters [options] urls [options] bundles [options] requirements [options] bundles [options] [packages] [options] [options] [urls] [options] [urls] [options] requirements [options] folder bundles [options] bundles Description Adds a list of repository URLs to the OBR service. optionally providing the given packages. Removes a list of repository URLs from the OBR service. etc. Displays the repository URLs currently associated with the OBR service. Table 5.Chapter 5. Talend ESB Container Administration Guide 15 . Lists OBR bundles. Downloads the sources for an OBR bundle. 5. OBR Scope The commands within the obr: scope are used to link to OSGi bundle repositories (OBRs) and install bundles defined within them. Deploys and starts a list of bundles using OBR. Sets the log level. Shows the currently set log level. Find OBR bundles for a given filter.

Stop bundle(s). Shuts the framework down. Echoes or prints arguments to STDOUT.Chapter 5. Prints command history. Optionally writes the content to a file. Gets or sets the system start level. Starts bundle(s). Update bundle. Table 5.9. Lists OSGi services. Using Console Command list ls refresh resolve restart shutdown start start-level stop uninstall update Parameters [options] [options] [ids] [options] [ids] [options] [ids] [options] [ids] [options] [time] [options] ids [options] [level] [options] ids [options] ids [options] id [location] Description Lists all installed bundles. Formats and prints arguments. Disconnects shell from current session. Shell Scope The commands within the shell: scope are used to provide terminal window commands in the OSGi shell. Executes system processes.9. Resolve bundle(s).2. Sleeps for a bit then wakes up. Writes sorted concatenation of all files to standard output. Shell Scope commands Command cat clear each echo exec grep head history if info java logout more new printf sleep sort source tac Parameters [options] paths or urls [options] Description Displays the content of a file or URL. [options] [options] condition ifTrue [ifFalse] [options] [options] className [arguments] [options] [options] [options] class [args] [options] format [args] [options] duration [options] [files] [options] script [args] [options] Talend ESB Container Administration Guide 16 . File pager. [options] [arguments] [options] command [options] pattern [options] [paths or urls] Displays the first lines of a file. Refresh a bundle. Executes a Java standard application. Clears the console buffer. Run a script Captures the STDIN and returns it as a string. Creates a new java object. If/Then/Else block. Prints lines matching the given pattern. 5. [options] values function Execute a closure on a list of arguments. Stops and restarts bundle(s). Uninstall bundle(s). Prints system information.

2. They're listed in the below table. Table 5.Chapter 5.10. Using Console Command tail Parameters [path or url] Description Displays the last lines of a file.10. Miscellaneous Scope commands Command packages:exports packages:imports ssh:ssh ssh:sshd web:list wrapper:install Parameters [options] [ids] [options] [ids] [options] hostname [command] [options] [options] [options] Description Displays exported packages. Displays imported packages. Install the container as a system service in the OS. Creates a SSH server Lists details for war bundles. Miscellaneous Scopes There are a few scopes that offer just one or two commands each. Connects to a remote SSH server. 5. Talend ESB Container Administration Guide 17 .

In particular. Deploying multiple containers using configuration adaption scripts In order to avoid conflicts between multiple container instances. 6. Start the second container with default settings.sh for the second container copy source scripts/configureC3.Chapter 6. after starting the container from the container directory. in the Karaf console.1. All necessary parameters adjustments are done using a single script call.sh for the first container copy source scripts/configureC2. and then run the Karaf configuration adaption script at the Karaf prompt to update and save the new settings.sh resets the parameters to the default values Talend ESB Container Administration Guide 18 . use: source scripts/configureC1. They are based on the edit and propset commands described above. Changes performed by the Karaf configuration adaption scripts are persistent and reflected in the configuration files in container/etc.sh for the third container copy source scripts/configureC0. there are Karaf configuration adaption scripts which automate the adjustment of potentially conflicting parameters. (Ensure the container with the default settings isn't running). Deploying Multiple Karaf Containers This chapter describes how to adapt the configuration to deploy multiple containers at the same machine.

Chapter 6. so change the ports in the Karaf configuration adaption scripts and rerun these to apply the changes. Deploying Multiple Karaf Containers The ports which are configured using the scripts are described in the table below: Table 6.sh 8041 9002 1100 44445 8102 8010 8011 8898 configureC2. Talend ESB Container Administration Guide 19 . it is recommended to shut down and restart the container after applying a configuration adaption script. recheck that there is not already a container running using the default parameters.sh 8042 9003 1101 44446 8103 8020 8021 8908 configureC3. Troubleshooting If you get the "Port already in use exception" when starting alternate-container. but for the Jobserver parameters in Talend Enterprise ESB this is not yet possible. Ports configured by the configuration scripts Parameter HTTP Port HTTPS Port RMI Registry Port RMI Server Port SSH Port Command Port File Transfer Port Monitoring Port configureC0. Most of the parameter changes will be adapted "on the fly".sh 8040 9001 1099 44444 8101 8000 8001 8888 configureC1. If you are still getting the error.1.sh 8043 9004 1102 44447 8104 8030 8031 8918 Restart Container To make shure the new parameters are used. it may also be that the port is actually in use by an unrelated process.

# define helper functions bundle-by-sn = { bm = new java.shell. // each (bundles) { $bm put ($it symbolicName) $it } .Chapter 7.karaf. Remote Console 7. The SSH hostname and port number is configured in the [karaf_install_dir]/etc/ org.cfg configuration file with the following defaults values: sshPort=8101 sshHost=0. When you start Karaf. but you'll need to restart the ssh console in order for it to use the new parameters.0.apache. it enables a remote console that can be accessed over SSH from any other Karaf console or plain SSH client. The remote console provides all the features of the local console and gives a remote user complete control over the container and services running inside of it. Talend ESB can be remotely managed using a remote console.0 sshRealm=karaf hostKey=${karaf.key You can change this configuration using the config commands or by editing the above file. Configuring remote instances It does not always make sense to manage an instance a Talend ESB instance using the local console.base}/etc/host.HashMap .util.1. // Talend ESB Container Administration Guide 20 .0. $bm get $1 } bundle-id-by-sn = { b = (bundle-by-sn $1) .

type: > bin/client --help Talend ESB Container Administration Guide 21 . run the following command from the karaf-install-dir directory: bin/client. if you were using the client within a larger script.ssh) 7.0 /local/apache-karaf-2. Information about the currently connected instance is returned. For example.2.0. you could append console commands as follows: bin/client -a 8101 -h hostname -u tadmin -p tadmin features:install wrapper To display the available options for the client. /local/apache-karaf-2.2.karaf. To confirm that you have connected to the correct Karaf instance.apache.1. type shell:info at the karaf> prompt.Chapter 7.1. you would provide a hostname. Karaf Karaf home Karaf base OSGi Framework JVM Java Virtual Machine .shell config:propset sshPort 8102 config:update # force a restart osgi:restart --force (bundle-id-by-sn org.shell. Using the ssh:ssh command You can connect to a remote Karaf's console using the ssh:ssh command.. And.eclipse.5. as shown. See Chapter 9.0 org. username and password to connect to a remote instance.2.osgi . to quickly connect to a Karaf instance running in server mode on the same machine.karaf. Security for more information.R35x_v20090827 Java HotSpot(TM) Server VM version 14.1-b02 7. Connecting and disconnecting remotely 7. Remote Console if { $b } { $b bundleId } { -1 } } # edit config config:edit org.0.. More usually. karaf@trun> ssh:ssh -l tadmin -P tadmin -p 8101 hostname Warning The default password is tadmin but we recommend changing it.3. Using the Karaf client The Karaf client allows you to securely connect to a remote Karaf instance without having to launch a Karaf instance locally.apache.2. port.

2. you can stop the remote instance using osgi:shutdown. Note Pressing Ctrl+D in a remote console simply closes the remote connection and returns you to the local shell without shutting off the remote instance.4. Using a plain SSH client You can also connect using a plain SSH client from your *nix system or Windows SSH client like Putty.2.1. run the following from the karaf-install-dir/lib directory: bin/client -u tadmin -p tadmin -a 8101 hostname osgi:shutdown Talend ESB Container Administration Guide 22 . the client will be put in an interactive mode 7. press Ctrl+D.3. Disconnecting from a remote console To disconnect from a remote console.3.3. 7. Using the Karaf client To stop a remote instance using the Karaf client. 7. Remote Console Apache Karaf client -a [port] specify the port to connect to -h [host] specify the host to connect to -u [user] specify the user name -p [password] specify the password --help shows this help message -v raise verbosity -r [attempts] retry connection establishment (up to attempts times) -d [delay] intra-retry delay (defaults to 2 seconds) [commands] commands to run If no commands are specified.2.3. ~$ ssh -p 8101 tadmin@localhost tadmin@localhost's password: 7. Using the remote console If you have connected to a remote console using ssh:ssh or the Karaf client. shell:logout or simply logout at the Karaf prompt. Stopping a remote instance 7.Chapter 7.

Chapter 8. Commands supplied by Apache CXF and Camel These are commands that are related to Apache CXF and Camel functionality. SYNTAX cxf:list-endpoints [options] [bus] ARGUMENTS bus OPTIONS --help Display this help message The CXF bus name where to look for the Endpoints Talend ESB Container Administration Guide 23 . To view help on a particular command. but you need to install Camel / CXF features in native Karaf to use these commands. Note CXF and Camel are already preconfigured in the Talend OSGi container. type the command followed by --help or use the help command followed by the name of the command: karaf@trun> cxf:list-endpoints --help DESCRIPTION cxf:list-endpoints Lists all CXF Endpoints on a Bus.

Tip Use TAB key for completion on the name parameters below.1.org/. Commands supplied by Camel These commands related to Camel functionality.x.1. bus is CXF bus name where to look for the Endpoint. bus is CXF bus name where to look for the Endpoint. Table 8. For more information on CXF.apache. These are for version Camel 2. which is the current version used by Talend ESB. Camel commands Command camel:list-contexts camel:list-routes camel:info-context Parameters [options] [options] [options] name Description Lists the Camel contexts available in the current Karaf instance Displays the list of Camel routes available in the current Karaf instance Displays detail information about a given Camel context Starts the given Camel context Stops the given Camel context Provides detail information about a Camel route Renders the route in XML Starts the given route Stops the given route camel:start-context [options] name camel:stop-context [options] name camel:info-route camel:show-route camel:start-route camel:stop-route [options] name [options] name [options] name [options] name Talend ESB Container Administration Guide 24 . endpoint is the Endpoint name to stop.org/karaf.8. Help for these commands is available at http:// camel. Commands supplied by Apache CXF and Camel 8.html. endpoint is the Endpoint name to start.Chapter 8. Table 8. CXF commands Command cxf:list-busses cxf:list-endpoints cxf:stop-endpoint busid endpointName cxf:start-endpoint busid endpointName Parameters [options] [options] [bus] [options] bus endpoint Description Lists all CXF Busses bus is the optional CXF bus name where to look for the Endpoints stops a CXF Endpoint on a Bus. starts a CXF Endpoint on a Bus.2. Commands supplied by CXF These commands related to CXF functionality. [options] bus endpoint 8. see http:// cxf.2.apache.

properties Talend ESB Container Administration Guide 25 . Security 9.1.role]. The default user name is tadmin and the associated password is tadmin too.role][.. Managing users and passwords The default security configuration uses a property file located at karaf-install-dir/etc/ users.Chapter 9. JMX and WebConsole) all use a global role based authorization system.2. 9. The users are currenly used in three different places in Karaf: • access to the SSH console • access to the JMX management layer • access to the Web console Those three ways all delegate to the same JAAS based security authentication. The users.. each line defining a user. Managing roles JAAS roles can be used by various components.properties to store authorized users and their passwords. The default role name is configured in the etc/system. its password and the associated roles: user=password[. We strongly encourage you to change the default password by editing the above file before moving Karaf into production. The three management layers (SSH.properties file contains one or more lines.

All users authenticating for the management layer must have this role defined. This file uses the properties file format.1.role system property and the default value is admin.enabled true config:update # force a restart dev:restart The passwords will be encrypted automatically in the etc/users.properties </jaas:module> Talend ESB Container Administration Guide 26 .apache.4. The syntax for this value is the following: [classname:]principal where classname is the class name of the principal object (defaults to org.karaf.base]/etc/users.3.karaf. Encrypted passwords are prepended with {CRYPT} so that are easy to recognize.RolePrincipal) and principal is the name of the principal of that class (defaults to admin). 9. Note that roles can be changed for a given layer using ConfigAdmin in the following configurations: Layer SSH JMX Web PID org. its password and the associated roles: user=password[.modules.apache.apache.Chapter 9. <jaas:config name="karaf"> <jaas:module className= "org.jaas config:propset encryption. Enabling password encryption In order to not keep the passwords in plain text. each line defining a user.properties configuration file the first time the user logs in.admin.apache. the passwords can be stored encrypted in the configuration file.shell org.PropertiesLoginModule" flags="required"> users = $[karaf. This can be easily enabled using the following commands: # edit config config:edit org.karaf.role][. Security using the karaf. It uses a properties text file to load the users.karaf.management org.jaas. Available realms Karaf comes with several login modules that can be used to integrate into your environment.apache.webconsole Value sshRole jmxRole role 9. 9. The format of the properties are as follows.apache.4..jaas.karaf.karaf.modules. passwords and roles from. PropertiesLoginModule This login module is the one configured by default.role].properties..

2. this configuration uses a pid value for the process ID of the configuration containing user definitions.3. See the example below: <jaas:config name="karaf"> <jaas:module className="org. with the use of the following parameters. the prefix osgi: needs to be provided.password query.sql. passwords and roles.4.1.apache. Instead of users for the PropertiesLoginModule. The data source and the queries for password and role retrieval are configurable.JDBCLoginModule" flags="required"> datasource = osgi:javax.role = SELECT ROLE FROM ROLES WHERE USERNAME=? </jaas:module> </jaas:config> 9.karaf.karaf.jaas. Passing a data source as a JNDI name To use an JNDI name.3.modules.DataSource/ \\ (osgi. Name datasource query.4.DataSource/ \\ Talend ESB Container Administration Guide 27 . the prefix jndi: needs to be provided.password = SELECT PASSWORD FROM USERS WHERE USERNAME=? query.service.sql.jdbc. Passing a data source as an OSGi ldap filter To use an OSGi ldap filter. <jaas:config name="karaf"> <jaas:module className="org. OsgiConfigLoginModule The OsgiConfigLoginModule uses the OSGi ConfigurationAdmin service to provide the users.jndi. provided a data source (normal or XA).jaas. The example below assumes the use of Aries JNDI to expose services via JNDI. Security </jaas:config> 9.name=jdbc/karafdb) query.modules.role Description The datasource as on OSGi ldap filter or as JDNI name The SQL query that retries the password of the user The SQL query that retries the roles of the user 9.2.4. 9. passwords and roles from.3.JDBCLoginModule" flags="required"> datasource = jndi:aries:services/javax.jdbc. JDBCLoginModule The JDBCLoginModule uses a database to load the users.apache.Chapter 9.4.

username is specified.jndi.context.password = SELECT PASSWORD FROM USERS WHERE USERNAME=? query. Define the initial context factory used to connect to the LDAP server. e. the user lookup will be performed only at the first level (ONELEVEL).LdapCtxFactory If "true" or if the protocol on the connection.g. If "false". cn If "true". the role lookup will be performed only at the first level (ONELEVEL). ou=role. the role lookup will be recursive (SUBTREE).apache. The default is com. bind the users on the LDAP to check passwords.search.dc=apache.Chapter 9. Security (osgi.password user.filter role. if it's not provided.keyalias ssl.ldap.dc=org The LDAP filter used to looking for user's role. ldap://hostname Admin username to connect to the LDAP.algorithm ssl. The key store must be deployed using a jaas:keystore configuration. e.username connection. e.truststore Description The LDAP connection URL.filter user.base. Admin password to connect to the LDAP.subtree authentication initial.service.sun.4. The LDAPLoginModule supports the following parameters: Name connection. Define the authentication backend used on the LDAP server. e.g.attribute role.dc=org The LDAP filter used to looking for user. This parameter is optional.modules.karaf.LDAPLoginModule" Talend ESB Container Administration Guide 28 .provider ssl. (uid=%u) where %u will be replaced by the username.protocol ssl.g.jaas. The key alias to use for SSL The trust store name to use for SSL.g.jndi. e. A example of LDAPLoginModule usage follows: <jaas:config name="karaf"> <jaas:module className="org.subtree role.factory ssl ssl.keystore ssl. an SSL connection will be used The provider name to use for SSL The protocol name to use for SSL (SSL for example) The algorithm to use for the KeyManagerFactory and TrustManagerFactory (PKIX for example) The key store name to use for SSL. (member:=uid=%u) The LDAP role attribute containing the role string used by Karaf. e. the user lookup will be recursive (SUBTREE).dn user.g. The default is simple. If "false".ldap. The LDAP base DN used to looking for roles.name=jdbc/karafdb) query. the LDAP connection will be anonymous. LDAPLoginModule The LDAPLoginModule uses a LDAP to load the users and roles. ou=user.4. The LDAP base DN used to looking for user.url connection.name.dn role.url is ldaps.role = SELECT ROLE FROM ROLES WHERE USERNAME=? </jaas:module> </jaas:config> 9.search. If "true".dc=apache. Only used if the connection. The trust store must be deployed using a jaas:keystore configuration.base.g.

base.search.LDAPLoginModule" flags="required"> connection. One way to deploy such providers is to put them in the JRE folder at $JAVA_HOME/jre/ lib/ext and modify each provider's security policy configuration ($JAVA_HOME/jre/lib/security/ java. that they need to be signed and be available on the boot classpath.ldap.dc=org role.algorithm=PKIX </jaas:module> </jaas:config> <jaas:keystore name="ks" path="file:///${karaf.subtree = true role.base.dc=apache.security) in order to register them.search.dn = ou=users.karaf.ou=system role.Chapter 9.attribute = cn role. Security flags="required"> connection.jaas.dc=org user.url = ldaps://localhost:10636 user. However Talend ESB offers a simple way to configure additional security providers: • put your provider jar in [karaf-install-dir]/lib/ext • modify the [karaf-install-dir]/etc/config.subtree = true role.base.filter = (cn=%u) user.url = ldap://localhost:389 user.dn = ou=user.home}/etc/trusted.5. such as BouncyCastle.name.subtree = true authentication = simple ssl.protocol=SSL ssl.name.filter = (uid=%u) user.truststore=ks ssl. The JVM imposes some restrictions about the use of such provider JAR files.ks" keystorePassword="secret" /> 9.dn = ou=group.dn = ou=groups.search.subtree = true authentication = simple </jaas:module> </jaas:config> If you want to use an SSL connection.base.properties configuration file to add the following property: Talend ESB Container Administration Guide 29 . it has a global effect and requires that all servers are configured accordingly.apache.filter = (uniqueMember=uid=%u) role.filter = (member:=uid=%u) role. the following configuration can be used as an example: <ext:property-placeholder /> <jaas:config name="karaf" rank="1"> <jaas:module className="org. namely.attribute = cn role. While this approach works fine.dc=apache.search.modules.ou=system user. Deploying security providers Some applications require specific security providers to be available.

BouncyCastleProvider In addition.Chapter 9.yyy The value of this property is a comma separated list of the provider class names to register.bootdelegation property in the same configuration file: org.provider.security.jce. you may want to provide access to the classes from those providers from the system bundle so that all bundles can access those. Security org.providers = \\ org.bootdelegation = .security..karaf.org.osgi.framework.. For example: org.osgi.karaf.bouncycastle.framework.bouncycastle* Talend ESB Container Administration Guide 30 .providers = xxx.apache..apache. It can be done by modifying the org.

Logging System Karaf provides a powerful logging system based on OPS4j Pax Logging.cfg You can edit this file at runtime and any change will be reloaded and be effective immediately.pax. Talend ESB Container Administration Guide 31 .1. Configuration file The configuration of the logging system uses a standard Log4j configuration file at the following location: [karaf_install_dir]/etc/org. In addition to being a standard OSGi Log service. 10.1.logging. view and change the log levels.Chapter 10. Configuration 10.ops4j.1. it supports the following APIs: • Apache Commons Logging • SLF4J • Apache Log4j • Java Util Logging Karaf also comes with a set of console commands that can be used to display.

you can turn on this appender on by adding it to the list of configured appenders using the log4j..apache.rootLogger property • the out appender is the one enabled by default. However. log4j.3. if you want to debug something. When debugging a problem in Karaf you may want to change the level of logging information that is displayed on the console. log4j..2. you might want to run the following commands: <log:set DEBUG . Changing the log levels The default logging configuration sets the logging levels so that the log file will provide enough information to monitor the behavior of the runtime and provide clues about what caused a problem. Logging System 10.1. the default configuration will not provide enough information to debug most problems.rootLogger=DEBUG. The most useful logger to change when trying to debug an issue with Karaf is the root logger..log. 10. < log:display Note that the log levels set using the log:set commands are not persistent and will be lost upon restart. The log commands have a separate configuration file: [karaf_install_dir]/etc/org.. Configuring the appenders The default logging configuration defines three appenders: • the stdout console appender is disabled by default. You can easily change the parameters to control the number of files using maxBackupIndex and their size maxFileSize.cfg file..logging.cfg 10. “Log Scope” for a full list. Talend ESB Container Administration Guide 32 . out.. with the locale console disabled).rootLogger=DEBUG.. Advanced Configuration The logging backend uses Log4j. do something . You will want to set its logging level to DEBUG in the org.2. The default configuration uses the bundle symbolic name as the file name to log to 10.3. osgi:VmLogAppender .threshold=WARN . To configure those in a persistent way. but offers a number of additional features. osgi:VmLogAppender log4j. For example.see Section 5. out. Console Log Commands The log scope comes with several commands -.karaf.appender.Chapter 10.1.stdout. The example below shows how to set the root logger to DEBUG but limiting the information displayed on the console to >WARN.2.ops4j.pax.6. If you plan to run Karaf in server mode only (i. • the sift appender can be used instead to provide a per-bundle log file.e. stdout.. It logs events to a number of rotating log files of a fixed size. you should edit the configuration file mentioned above using the config commands or directly using a text editor of your choice.

name: the symbolic-name of the bundle • bundle.varia.appender.filter.[appender-name].4.appender.id: the id of the bundle from which the class is loaded • bundle.errorhandler=[error-handler-class] log4j.filter.log4j.[appender-name].JMSAppender .errorhandler.net.f1.apache. Error handlers Error handlers can be added using the following syntax: log4j.filter.f1. Filters Appender filters can be added using the following syntax: log4j.3.log4j.async=org.errorhandler.root-ref=[true|false] log4j.3. Logging System 10. Nested appenders Nested appenders can be added using the following syntax: log4j.LevelMin=DEBUG 10.5.apache.[appender-name].appenders=jms log4j.1.[appender-name].AsyncAppender log4j.appender.appender.[appender-name].2.appender-ref=[appender-ref] 10.appender.appender.appenders= // [comma-separated-list-of-appender-names] Below is a real example: log4j.appender.LevelMax=FATAL log4j.f1=org.appender.appender.log4j.3.version: the version of the bundle 10.filter.[option]=[value] Below is a real example: log4j.LevelRangeFilter log4j.filter.out.errorhandler.[appender-name].apache.logger-ref=[logger-ref] log4j.appender..out.[filter-name]. Below is a configuration example for this appender: Talend ESB Container Administration Guide 33 .async.Chapter 10. 10.[filter-name]=[filter-class] log4j..appender. OSGi specific MDC attributes Pax-Logging provides the following attributes by default: • bundle.3.appender.jms=org.appender.3. MDC sifting appender An MDC sifting appender is available to split the log events based on MDC attributes.out.[appender-name].3.

shell.shell.gogo.run(Thread. the underlying logging system will be able to see and use your appenders.Thread.5p | %-16.IllegalArgumentException: Command not found: *:foo at org.log4j.0_20] 10. } Then you need to package the appender in a jar with a Manifest like this: Manifest: Bundle-SymbolicName: org.0] at org.logging.console:2.data}/log/$\\{bundle.sift.file=${karaf.appender.1. it will display OSGi specific informations related to the class on that line: the bundle id.appender. you need to create an OSGi bundle and attach it as a fragment to the bundle with a symbolic name of org.sift=org.sift.ConversionPattern= \\ %d{ABSOLUTE} | %-5..execute (Closure.MDCSiftingAppender log4j.apache.Closure.6.apache.pax.apache.apache.1.gogo.karaf.1.appender.lang.log log4j.apache. Talend ESB Container Administration Guide 34 .1.apache.jline.PatternLayout log4j.runtime.runtime..java:637)[:1. Now you can use the appender in your log4j config file like shown in the config examples above.7.apache.appender.shell.executeStatement (Closure.0] at org. the bundle symbolic name and the bundle version..apache.sift.sift. Enhanced OSGi stack trace renderer This renderer is configured by default in Karaf and will give additional informations when printing stack traces.java:71)[21:org.32c{1} | %-32..java:169)[21:org.3.default=karaf log4j.32C %4L | %m%n log4j.runtime.gogo.FileAppender log4j.pax-logging-service .myappender Fragment-Host: org.CommandSessionImpl.log4j.felix.shell.sift.appender=org. Logging System log4j.apache.Chapter 10.1.gogo.Closure.console:2.shell.apache.key=bundle.sift. The information is appended at the end of each line in the following format id:name:version as shown below: java.karaf.ops4j.Console.0] at org.appender.Closure.apache.karaf.java:225)[21:org.console.run (Pipe.16t | %-32.6.pax.gogo.shell.1.java:79)[21:org.java:162)[21:org.appender.Pipe. This information can greatly help diagnosing problems in some cases.execute (Closure.karaf.karaf.appender.felix.appender.apache.shell.lang. This way.felix.mydomain.karaf.java:101)[21:org.felix.appender.logging.name\\}. For each line of the stack trace.apache.3.runtime.execute (CommandSessionImpl.run (Console.0] at org.layout.apache.felix. So for example you write a log4j appender: class MyAppender extends AppenderSkeleton { .append=true 10.console:2.appender.apache.name log4j.appender.console:2.ops4j.shell.appender.runtime.0] at org. Using your own appenders If you plan to use your own appenders.layout=org.shell.console:2.sift.karaf.shell.sift.shell.0] at java.shell.console:2.pax-logging-service.log4j.

The following diagram describes the architecture of the deployer. Deployer The Karaf deployer is used for deploying bundles or groups of bundles (called features) into the Karaf container.Chapter 11. Talend ESB Container Administration Guide 35 .

5) [32] [Active ] [Created ] [ 30] Apache Karaf :: Deployer :: Wrap Non OSGi Jar Karaf wrap deployer looks for jar files in the deploy folder.0. Removing the file from the deploy folder will uninstall the features.servicemix. The default imported packages are extracted from the Spring file definition and includes all classes referenced directly.wrap: (1. Spring deployer Karaf includes a deployer that is able to deploy plain blueprint or spring-dm configuration files. If you need to customize the generated manifest. Deployer 11.publish-context:=false.2. you can simply drop a Feature descriptor on that folder. The non-OSGi jar file is transformed into an OSGi bundle.0.3.Chapter 11. For example my-config-1. It's a standard deployer (you don't need to install additional Karaf features): karaf@trun> la|grep -i wrap [ 1] [Active ] [ ] [ 5] OPS4J Pax Url . \\ 11. Wrap deployer The wrap deployer allows you to hot deploy non-OSGi jar files ("classical" jar files) from the deploy folder. A bundle will be created and its installation (automatic) will trigger the installation of all features contained in the descriptor. you can do so by writing a feature descriptor like the following: <features> <repository>mvn:org.> <manifest> Require-Bundle= my-bundle </manifest> 11.0/xml/features</repository> <feature name="nmr-only"> <feature>nmr</feature> </feature> </features> For more informations about features.nmr/apache-servicemix-nmr/ 1.2. see the Chapter 13.xml will lead to name = my-config and version = 1. The deployer will transform on the fly any spring configuration file dropped into the deploy folder into a valid OSGi bundle. The jar files is considered as non-OSGi if the MANIFEST doesn't contain the Bundle-SymbolicName and Bundle-Version attributes.0. Features deployer To be able to hot deploy features from the deploy folder.create-asynchronously:=true Import-Package: [required packages] DynamicImport-Package: * The name and version of the file are extracted using a heuristic that will match common patterns.1. or if there is no MANIFEST at all. you can do so by including an xml element in your Spring configuration: <spring:beans . Provisioning.apache.1.. The deployer tries to populate Talend ESB Container Administration Guide 36 . The generated OSGi manifest will contain the following headers: Manifest-Version: 2 Bundle-SymbolicName: [name of the file] Bundle-Version: [version of the file] Spring-Context: *.1.. If you want to install a single feature.

org.commons.apache Created-By = 1. org.1_09-85 ("Apple Computer.apache.commons. org.commons.mutable.lang.resolution:=optional.enums.enum.lang.builder.org.lang.jar$ Bundle-SymbolicName=commons-lang&Bundle-Version=2.1 Originally-Created-By = 1.math.99-SNAPSHOT/deploy/commons-lang-2.apache.lang.apache.0 Bnd-LastModified = 1297248243231 X-Compile-Target-JDK = 1.exception".apache.commons.commons.uses:=org.5 Package = org. org.lang.apache.resolution:=optional.lang.apache.commons.apache.commons.lang.apache. Inc.uses:=org.apache.apache.enums.apache.org.lang.apache.3 Bundle-ManifestVersion = 2 Import-Package = org. org.3. uses:="org.lang.commons.commons.Chapter 11.commons. org.3.) Implementation-Title = Commons Lang Manifest-Version = 1. Talend ESB Container Administration Guide 37 .jar (which is not an OSGi bundle) into the deploy folder.commons.0_21 (Sun Microsystems Inc.lang.lang. if you simply copy commons-lang-2. you can see that the bundle exports all packages with optional resolution and that Bundle-SymbolicName and Bundle-Version have been populated: karaf@trun> osgi:headers 41 commons-lang (41) ----------------Specification-Title = Commons Lang Tool = Bnd-0.resolution:=optional. you will see: karaf@trun> la|grep -i commons-lang [ 41] [Active ] [ ] [ 60] commons-lang (2.commons.3.time. org.3 Implementation-Vendor-Id = org.apache.commons.99.lang.uses:=org.lang.lang.apache.math.apache. org.resolution:=optional.apache.resolution:=optional.apache.commons.resolution:=optional.apache.lang".357 Specification-Version = 2.mutable.3 Generated-By-Ops4j-Pax-From = wrap:file:/home/onofreje/workspace/karaf/ assembly/target/apache-karaf-2. org. org.lang.apache.apache.6. org.commons. For example.3) If you take a look on the commons-lang headers.") Ant-Version = Apache Ant 1. org. org. Deployer the Bundle-SymbolicName and Bundle-Version extracted from the jar file path.uses:=org.commons.lang X-Compile-Source-JDK = 1.commons.lang.commons.exception.enum.lang.apache.resolution:=optional.commons.lang.resolution:=optional.3 Extension-Name = commons-lang Implementation-Vendor = Apache Software Foundation Bundle-Name = commons-lang Bundle-SymbolicName = commons-lang Bundle-Version = 2.exception.text.apache.uses:="org.math.lang.lang.builder.builder.6.math.commons.apache.uses:="org.3 Specification-Vendor = Apache Software Foundation Implementation-Version = 2.lang.commons.apache.commons.lang.0.commons.apache.apache.commons.lang.resolution:=optional Export-Package = org. org.lang.commons.apache.commons. org.lang.commons.

apache.commons.commons.lang.apache.apache.uses:=org.time. org.lang 11.apache.lang. Web Applications for information on web application (war) deployment.commons. Talend ESB Container Administration Guide 38 .4.lang.lang.math". War deployer See Chapter 14.uses:=org.text.commons. Deployer org.Chapter 11.commons. org.apache.

Talend ESB Container Administration Guide 39 . First we look at the configuration files.apache.cfg The configuration of the port for the OSGi HTTP Service is specified in: [karaf_install_dir]/etc/ org.cxf. Please read the Servlet Transport on the Apache CXF website for additional information about this servlet context. The following section explains servlet context configuration in more detail. you can deploy into a servlet container.pax. Karaf and CXF provide servlet context custom configuration.web. Servlet Context A servlet context defines a set of methods which allows a servlet to communicate with its servlet container.ops4j.1. CXFServlet. for building services.cfg You can edit these files at runtime and any change will be reloaded and be effective immediately.Chapter 12. 12. Configuration Note The paths [karaf_install_dir]/ and [Talend-ESB-Version]/container are equivalent.osgi. using a servlet transport. For example. The configuration of the servlet context for the OSGi HTTP Service is specified in a file at the following location: [karaf_install_dir]/etc/org.

For example.cxf.osgi.apache.cfg file specified prefix for the services is: org. given an implementation class called GreeterImpl with endpoints greeter and greeterRest.apache.port=8040 12.2. Servlet Context 12.Chapter 12. the org.web.pax.cfg file specified port for the services is: org.2.hello_soap_http.osgi. the relative endpoint addresses would be configured as: <jaxws:endpoint id="greeter" implementor="org.1. Relative endpoint address The CXFServlet uses a relative address for the endpoint rather than a full http address.cxf.GreeterImpl" address="/Greeter1"/> <jaxrs:server id="greeterRest" serviceClass="org.ops4j.servlet.apache.hello_soap_http.GreeterImpl" address="/GreeterRest"/> The cumulative result of these changes is that the endpoint address for the servlet will be: http:// {server}:8040/services/Greeter1 and http://{server}:8040/services/GreeterRest Talend ESB Container Administration Guide 40 . Configuring the context When editing the files.service.context=/services The org.http.apache.

In the console. Such a mechanism is mainly provided by a set of commands available in the features shell.apache. The provisioning system uses xml "repositories" that define a set of features. yet flexible. Provisioning Karaf provides a simple. Example: Deploying a sample feature In the rest of this chapter. But as a quick demonstration.camel/camel-example-osgi/2. The output is as follows: >>>> SpringDSL set body: >>>> SpringDSL set body: >>>> SpringDSL set body: Fri Jan 07 11:59:51 CET 2011 Fri Jan 07 11:59:53 CET 2011 Fri Jan 07 11:59:55 CET 2011 Talend ESB Container Administration Guide 41 .1. we describe in detail the process involved in provisioning. These features:addUrl and features:install commands download the Camel features descriptor and install this example. run the following commands: features:addUrl mvn:org.Chapter 13. 13. way to provision applications or "features".0/xml/features features:install camel-example-osgi The example installed uses Camel to start a timer every 2 seconds and output a message on the console. we'll run a sample Apache Camel feature already present in the Talend ESB distribution.5.

Repositories So.apache.3. The feature is identified by its name which must be unique amongst all the repositories used and consists of a set of bundles that need to be installed along with some optional dependencies on other features and some optional configurations for the Configuration Admin OSGi service. 13.bundles.org/xmlns/features/v1.0. Provisioning 13. The complete xml schema for feature descriptor are available on Features XML Schema page.Chapter 13.apache.1.0.1.RELEASE"> <bundle>mvn:org. all the features defined in a repository are not installed at the launch of Apache Karaf (see Section 13. Bundles The main information provided by a feature is the set of OSGi bundles that defines the application.0.0.nmr/apache-servicemix-nmr/ \\ 1.RELEASE</bundle> <bundle>mvn:org. <features xmlns="http://karaf. first we look at feature repositories..servicemix..RELEASE</bundle> <bundle>mvn:org. Such bundles are URLs pointing to the actual bundle jars.karaf/apache-camel/2. References to features define in other repositories are allow and can be achieved by adding a list of repository.apache.4.0. Stopping and uninstalling the sample application To stop this demo. You may also verify your descriptor before adding it to Karaf by simply validation.0/xml/features </repository> <repository>mvn:org. one would write the following definition: Talend ESB Container Administration Guide 42 .5.springframework/spring-aop/3.springframework/spring-context/3.2.0"> <repository>mvn:org. Note: By default.apache.springframework/spring-beans/3.apache.4.0"> <feature name="spring" version="3. Here is an example of such a repository: <features xmlns="http://karaf. “Service configuration” for more information). each one representing an application that can be installed.servicemix.RELEASE</bundle> <bundle>mvn:org.2.0. Be careful when you define them as there is a risk of 'cycling' dependencies.apache.0_1</bundle> <bundle>mvn:org.0/xml/features</repository> <repository>mvn:org.2/xml/features </repository> .camel.0.RELEASE </bundle> </feature> </features> A repository includes a list of feature elements.4.aopalliance/1.springframework/spring-core/3.springframework/spring-context-support/3.bundles/ \\ org.apache.RELEASE</bundle> <bundle>mvn:org. It will allow Karaf to validate your repository before parsing.1. For example.4.karaf/apache-karaf/2.org/xmlns/features/v1.1.servicemix.4.4.0. even from IDE level. run the following command: features:uninstall camel-example-osgi 13. We recommend using this XML schema.4.

Chapter 13. Provisioning

<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>

\\

Doing this will make sure the above bundle is installed while installing the feature. 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.

13.2.1.1. Maven URL Handler
The equivalent of the above bundle would be: <bundle> mvn:org.apache.servicemix.nmr/org.apache.servicemix.nmr.api/1.0.0-m2 </bundle> In addition to being less verbose, the maven url handlers can also resolve snapshots and can use a local copy of the jar if one is available in your maven local repository. The org.ops4j.pax.url.mvn bundle resolves mvn URLs. This flexible tool can be configured through the configuration service. For example, to find the current repositories type: karaf@trun:/> config:list and the following will display:

Pid: org.ops4j.pax.url.mvn BundleLocation: mvn:org.ops4j.pax.url/pax-url-mvn/0.3.3 Properties: service.pid = org.ops4j.pax.url.mvn org.ops4j.pax.url.mvn.defaultRepositories = file:/opt/development/ \\ karaf/assembly/target/apache-felix-karaf-1.2.0-SNAPSHOT/ \\ system@snapshots org.ops4j.pax.url.mvn.repositories = http://repo1.maven.org/maven2, http://svn.apache.org/repos/asf/servicemix/m2-repo below = list of repositories and even before the local repository The repositories checked are controlled by these configuration properties. For example, org.ops4j.pax.url.mvn.repositories is a comma separated list of repository URLs specifying those remote repositories to be checked. So, to replace the defaults with a new repository at http://www.example.org/repo on the local machine:

karaf@trun:/> config:edit org.ops4j.pax.url.mvn karaf@trun:/> config:proplist service.pid = org.ops4j.pax.url.mvn org.ops4j.pax.url.mvn.defaultRepositories = file:/opt/development/karaf/ assembly/target/apache-felix-karaf-1.2.0-SNAPSHOT/system@snapshots org.ops4j.pax.url.mvn.repositories = http://repo1.maven.org/maven2, http://svn.apache.org/repos/asf/servicemix/m2-repo below = list of repositories and even before the local repository karaf@trun:/> config:propset org.ops4j.pax.url.mvn.repositories http://www.example.org/repo karaf@trun:/> config:update By default, snapshots are disabled. To enable an URL for snapshots append @snapshots. For example: http:// www.example.org/repo@snapshots. Repositories on the local are supported through file:/ URLs.

Talend ESB Container Administration Guide

43

Chapter 13. Provisioning

13.2.1.2. Bundle start-level
By default, the bundles deployed through the feature mechanism will have a start-level equals to the value defined in the configuration file config.properties with the variable karaf.startlevel.bundle=60. This value can be changed using the xml attribute start-level. <feature name='my-project' version='1.0.0'> <feature version='2.4.0'>camel-spring</feature> <bundle start-level='80'>mvn:com.mycompany.myproject/ myproject-dao</bundle> <bundle start-level='85'>mvn:com.mycompany.myproject/ myproject-service</bundle> <bundle start-level='85'>mvn:com.mycompany.myproject/ myproject-camel-routing</bundle> </feature>

\\ \\ \\

The advantage to define the start-level of a bundle is that you can deploy all your bundles including those of the project with the 'infrastructure' bundles required (e.g : camel, activemq) at the same time and you will have the guaranty when you use Spring Dynamic Module (to register service through OSGI service layer), Blueprint that by example Spring context will not be created without all the required services installed.

13.2.1.3. Bundle stop/start
The OSGI specification allows to install a bundle without starting it. To use this functionality, simply add the following attribute in your <bundle> definition <feature name='my-project' version='1.0.0'> <feature version='2.4.0'>camel-spring</feature> <bundle start-level='80' start='false'>mvn:com.mycompany.myproject/ myproject-dao</bundle> <bundle start-level='85' start='false'>mvn:com.mycompany.myproject/ myproject-service</bundle> <bundle start-level='85' start='false'>mvn:com.mycompany.myproject/ myproject-camel-routing</bundle> </feature>

\\ \\ \\

13.2.1.4. Bundle dependency
A bundle can be flagged as being a dependency. Such information can be used by resolvers to compute the final list of bundles to be installed.

13.2.2. Dependent Features
Dependent features are useful when a given feature depends on another feature to be installed. Such a dependency can be expressed easily in the feature definition: <feature name="jbi"> <feature>nmr</feature> ...

Talend ESB Container Administration Guide

44

Chapter 13. Provisioning

</feature> The effect of such a dependency is to automatically install the required nmr feature when the jbi feature will be installed. A version range can be specified on the feature dependency: <feature name="spring-dm"> <feature version="[2.5.6,4)">spring</feature> ... </feature> In such a case, if no matching feature is already installed, the feature with the highest version available in the range will be installed. If a single version is specified, this version will be chosen. If nothing is specified, the highest available will be installed.

13.2.3. Configurations
The configuration section allows to deploy configuration for the OSGi Configuration Admin service along a set of bundles. Here is an example of such a configuration: <config name="com.foo.bar"> myProperty = myValue </config> The name attribute of the configuration element will be used as the ManagedService PID for the configuration set in the Configuration Admin service. When using a ManagedServiceFactory, the name attribute is servicePid_aliasId_, where servicePid is the PID of the ManagedServiceFactory and aliasId is a label used to uniquely identify a particular service (an alias to the factory generated service PID). Deploying such a configuration has the same effect than dropping a file named com.foo.bar.cfg into the etc folder. The content of the configuration element is set of properties parsed using the standard java property mechanism. Such configuration as usually used with Spring-DM or Blueprint support for the Configuration Admin service, as in the following example, but using plain OSGi APIs will of course work the same way: <bean ...> <property name="propertyName" value="${myProperty}" /> </bean> <osgix:cm-properties id="cmProps" persistent-id="com.foo.bar"> <prop key="myProperty">myValue</prop> </osgix:cm-properties> <ctx:property-placeholder properties-ref="cmProps" /> There may also be cases where you want to make the properties from multiple configuration files available to your bundle context. This is something you may want to do if you have a multi-bundle application where there are application properties used by multiple bundles, and each bundle has its own specific properties. In that case, <ctx:property-placeholder> won't work as it was designed to make only one configuration file available to a bundle context. To make more than one configuration file available to your bundle-context you would do something like this: <beans:bean id="myBundleConfigurer" class= "org.springframework.beans.factory.config.PropertyPlaceholderConfig"> <beans:property name="ignoreUnresolvablePlaceholders" value="true"/> <beans:property name="propertiesArray"> <osgix:cm-properties id="myAppProps" persistent-id="myApp.props"/> <osgix:cm-properties id="myBundleProps" persistent-id="my.bundle.props"/> </beans:property>

Talend ESB Container Administration Guide

45

file and mvn.4.xml">mvn:org.g. In that case. For more informations about using the Configuration Admin service in Spring-DM.Chapter 13. <configfile finalname="/etc/jetty. we are using SpringDM with osgi as the primary namespace. A resolver will be use to obtain the list of bundles to actually install for a given feature.2. the resolver will use the OBR service to determine the list of bundles to install (bundles flagged as dependency will only be used as possible candidates to solve various constraints). Instead of using ctx:contextplaceholder we are using the "PropertyPlaceholderConfig" class. Feature resolver The resolver attribute on a feature can be set to force the use of a given resolver instead of the default resolution process. The obr resolver can be installed and used instead of the standard one. 13.version}/xml/jettyconfig</configfile> \\ 13.apache.xml).karaf/apache-karaf/ ${project. • features:refreshUrl: Reload the repositories to obtain a fresh list of features Karaf maintains a persistent list of these repositories so that if you add one URL and restart Karaf. The refreshUrl command is mostly used when developing features descriptors: when changing the descriptor. Commands 13. while the value references the Maven artifact to deploy.2. Configuration files In certain cases it is needed not only to provide configurations for the configuration admin service but to add additional configuration files e. Then we are passing in a beans array and inside of that array is where we set our osgix:cm-properties elements.3. the most common ones being http.5. The default resolver will simply return the list of bundles provided in the feature description. Repository management The following commands can be used to manage the list of descriptors known by Karaf. it can be handy to reload it in the Kernel without having to restart it or to remove then add again this URL. the features will still be available. Provisioning </beans:bean> In this example. This element "returns" a properties bean. 13. • features:addUrl: Add a list of repository URLs to the features service • features:removeUrl: Remove a list of repository URLs from the features service • features:listUrl: Display the repository URLs currently associated with the features service. a configuration file for jetty (jetty.1.3. Talend ESB Container Administration Guide 46 . It even might be help full to deploy a configuration file instead of a configuration for the config admin service since. To achieve this the attribute finalname shows the final destination of the configfile. see the Spring-DM documentation. They use URLs pointing to features descriptors. These URLs can use any protocol known to Apache Karaf.

3.Chapter 13.features. features:uninstall.cfg can be modified to customize the behavior when starting the Kernel for the first time.3. Examples To install features using mvn handler: features:addUrl mvn:org.apache.5.6. Service configuration A simple configuration file located in [FELIX:karaf]/etc/org. you can use the following syntax to deploy bundles when they are located in a directory which is not available using Maven: <features xmlns="http://karaf.xml To deploy bundles from file system without using Maven: As we can use file:// as protocol handler to deploy bundles. “Features Scope” for more information on these commands. 13. Talend ESB Container Administration Guide 47 .org/xmlns/features/v1.servicemix.SEC01.4. Provisioning 13.0.4.2.0-m2/xml/features features:install nmr \\ To use a file handler to deploy a features file (note the path is relative to the Apache Karaf installation directory): features:addUrl file:base/features/features. and features:list.5. This configuration file contains two properties: • featuresBoot: a comma separated list of features to install at startup • featuresRepositories: a comma separated list of feature repositories to load at startup This configuration file is of interest if you plan to distribute a Apache Karaf distribution which includes preinstalled features. See Section 5.0.apache.nmr/apache-servicemix-nmr/ 1. Features management Common features: scope commands used in features management include features:install.6.karaf.2. 13.apache.3.0"> <feature name="spring-web" version="2.SEC01"> <bundle>file:base/bundles/spring-web-2.jar</bundle> </feature> </features> Note the path again is relative to Apache Karaf installation directory.

0] ssh .2. 1.2.2.2. 14.1. List the available features karaf@trun> features:list State Name .0 Install the war feature (and the sub-features it requires) . karaf-2. .0 karaf-2.2.0] http [uninstalled] [2. [uninstalled] [2. Installing WAR support The following steps will install the "war" feature (support for deploying WAR files with Servlet and JSPs into a Jetty server) into your Karaf instance. . Web Applications Karaf provides an ability to deploying WAR-based web applications within the Jetty server contained in the Karaf instance.0] config [uninstalled] [2.0 karaf-2.2.0 karaf-2.0 karaf-2.karaf@trun> features:install war Note: you can use the -v or --verbose to see exactly what Karaf does Talend ESB Container Administration Guide 48 .0] war [uninstalled] [2. .0] webconsole [installed ] [2.0] obr [uninstalled] [2.2.2.2. .0 karaf-2.2.Chapter 14.2.2. 2.

0] war karaf-2.0.eclipse.6.0) Jetty (1.99-SNAPSHOT/xml/jettyconfig Installing bundle mvn:org.1.v20100715 Installing bundle mvn:org.99-SNAPSHOT Installing feature jetty 7.jetty/jetty-util/7.eclipse.1.0) Web .specs/ geronimo-servlet_2.1.v20100715 Installing bundle mvn:org.5_spec (1.jetty/jetty-servlet/7.pax.web/pax-web-api/0.0) Extender .0.WAR (1.jetty/jetty-xml/7. Verify the installed bundles were started karaf@trun> osgi:list START LEVEL 100 ID State Level .2-SNAPSHOT Installing bundle mvn:org. [installed ] [2.1.0) Url .0] http karaf-2.pax.2-SNAPSHOT Installing bundle mvn:org.eclipse. [ 32] [Active ] [ ] [ 60] [ 33] [Active ] [ ] [ 60] jetty (6.0.6.2-SNAPSHOT Installing bundle mvn:org.ops4j.v20100715 Installing bundle mvn:org.8.ops4j.web/pax-web-jetty/0.v20100715 Installing bundle mvn:org.v20100715 Installing bundle mvn:org. war-i: (1.servicemix.2-SNAPSHOT Installing bundle mvn:org.pax.Whiteboard [ 42] [Active ] [ ] [ 60] [ 41] [Active ] [ ] [ 60] Name geronimo-servlet_2.web/pax-web-extender-whiteboard/ 0.0) Jsp Support (1.0.8.2.2 Found installed bundle: org.1.ops4j.8.FileInstall Deployer (1.geronimo. .v20100715 Checking configuration file mvn:org.2) Apache ServiceMix :: Bundles :: OPS4J Pax OPS4J Pax OPS4J Pax OPS4J Pax OPS4J Pax OPS4J Pax OPS4J Pax (1.apache. 4.ops4j.99-SNAPSHOT Installing feature http 2.4) Talend ESB Container Administration Guide 49 .jetty/jetty-io/7. .web/pax-web-jsp/0.url/pax-url-war/1.6.0 [installed ] [2.eclipse.8.v20100715 Installing bundle mvn:org.2.0.2-SNAPSHOT Installing bundle mvn:org.6.1.pax.2-SNAPSHOT Installing bundle mvn:org. Web Applications karaf@trun> features:install -v war Installing feature war 2.2) [ 34] [Active ] [ ] [ 60] [ 35] [Active ] [ ] [ 60] [ 36] [Active ] [ ] [ 60] [ 37] [Active ] [ ] [ 60] [ 38] [Active ] [ ] [ 60] [ 39] [Active ] [ ] [ 60] [ 40] [Active ] [ ] [ 60] Extender .8.2.apache.0.jetty/jetty-continuation/7.ops4j.0) Service SPI (1.eclipse.1.eclipse.karaf/apache-karaf/ 2.22.6. .v20100715 Installing bundle mvn:org.pax.apache.8.jetty/jetty-server/7.ops4j.0.bundles.ops4j.5_spec/1. .1.pax.1.web/pax-web-spi/0.1. .1.2-SNAPSHOT Installing bundle mvn:org.pax. Verify the features were installed servicemix> features/list State Name .6.0.web/pax-web-deployer/0.web/pax-web-extender-war/ 0.8.1.2.jetty/jetty-http/7.2.Chapter 14.0) Runtime (1.eclipse.6.pax.0) OPS4J Pax OPS4J Pax Web Web Web Web Web Web Web API (1.jetty/jetty-security/7.8.1.ops4j.6.0 .war:.1.asm [10] Installing bundle mvn:org.v20100715 Installing bundle mvn:org.4 3.6.ops4j.2.web/pax-web-runtime/0. .1.eclipse.2-SNAPSHOT Installing bundle mvn:org.pax.

war?Bundle-SymbolicName= \\ tomcat-sample&Webapp-Context=/sample Then open your web browser and point to http://localhost:8181/sample/index.org/ \\ tomcat-5. Web Applications .org/wiki/display/paxweb/WAR+Extender Copy the updated WAR (archive or extracted files) to the deploy directory.5-doc/appdev/sample/sample.2. 1. The Jetty server should now be listening on http://localhost:8181/. you could use the following command: karaf@trun> osgi:install -s webbundle:http://tomcat.html. If you want to deploy a sample web application into Karaf. To deploy a WAR (JSP or Servlet) to Jetty. .ops4j. Deploying a WAR to the installed web feature The following steps will describe how to install a simple WAR file (with JSPs or Servlets) to the just installed web feature.MF to include the required OSGi headers as described here: http://team. Talend ESB Container Administration Guide 50 . 5. . update its MANIFEST. HTTP ERROR: 404 NOT_FOUND RequestURI=/ Powered by jetty:// 14. 2.Chapter 14.apache. but with no published applications available.

They provide more or less the same actions that you can do using the Karaf shell commands.apache.Chapter 15. The list of MBeans available: Table 15. JConsole provided in the Oracle or IBM JDK). Monitoring and Administration using JMX Apache Karaf provides a large set of MBeans that allow you to fully monitor and administrate Karaf using any JMX client (for example.1.karaf:type value) Description admin bundles config dev diagnostic features log packages services system web obr administrates the child instances manipulates the OSGi bundles manipulates the Karaf configuration files (in the /etc folder) and the ConfigAdmin layer provides information and administration of the OSGi framework used to create information files (dumps) about Karaf activity manipulate the Karaf features manipulate the logging layer manipulate the PackageAdmin layer and get information about exported and imported packages to get information about the OSGi services to shutdown the Karaf container itself to get information about the Web bundles (installed with the war feature) to manipulate the OBR layer (installed with the obr feature) Talend ESB Container Administration Guide 51 . Karaf Management MBeans MBean (org.

Supported platforms The following platforms are supported by the Wrapper: • AIX • FreeBSD • HP-UX. 32-bit and 64-bit versions • SGI Irix Talend ESB Container Administration Guide 52 . 16. and the ability to run services which interact with the desktop.1. The Wrapper correctly handles "user log outs" under Windows.Chapter 16.2. Karaf Wrapper (for service wrapper) makes it possible to install the Talend Runtime container as a Windows Service. Likewise. Introduction The Talend Runtime container is based on Apache Karaf. the scripts shipped with Karaf also make it very easy to install the Talend Runtime container as a daemon process on Unix systems. Installing the Talend Runtime container as a service 16. service dependencies.

and PPC systems. 16.6. --name The service name that will be used when installing the service. and x86 systems. (Default: Karaf) (defaults to karaf) -D. • Windows .2. Itanium. --description The description of the service. to register Talend Runtime container as a service (depending on the running OS). --help Display this help message -s. 2008 and Windows 7.Chapter 16. AUTO_START or DEMAND_START (Default: AUTO_START) (defaults to AUTO_START) -n. Installation The Wrapper is an optional feature. 2. Currently supported on both 32-bit and 64bit x86 and Itanium systems.x.x. the Wrapper can be run only in console mode. simply type: trun@root> features:install wrapper Once installed. --display The display name of the service. and Red Hat. 2.4. Ubuntu. Also known to run on Windows 98 and ME. To install it. Vista.x. Installing the Talend Runtime container as a service • Linux kernels 2.3. Currently supported on both 32-bit and 64-bit x86. Solaris 9 and 10. however due the lack of support for services in the OS. Currently supported on both 32-bit and 64-bit sparc.Windows 2000. • Macintosh OS X • Sun OS. in automatic start mode. XP. SYNTAX wrapper:install [options] OPTIONS -d. For instance. 2003. Known to work with Debian. but should work with any distribution. simply type: trun@root> wrapper:install -s AUTO_START -n TALEND-ESB-CONTAINER -d Talend-ESB-Container -D "Talend ESB Container Service" Talend ESB Container Administration Guide 53 . --start-type Mode in which the service is installed. (defaults to ) Using wrapper:install. you can install Talend Runtime container as a service. wrapper feature will provide wrapper:install new command in the trun: trun@root> wrapper:install --help DESCRIPTION wrapper:install Install the container as a system service in the OS.

1\container\bin\ TALEND-ESB-CONTAINER-service.1-release/Talend-ESB-V5.0. You may wish to tweak the JVM properties in the wrapper configuration file: C:\work\5.0. run: C:> C:\work\5.0.so Creating file: /home/onofreje/5.1-release\Talend-ESB-V5.1/container/ Talend ESB Container Administration Guide 54 .1-release\Talend-ESB-V5.1/container/ lib/libwrapper.0.0.1-release/Talend-ESB-V5.bat Creating file: C:\work\5.bat install Once installed.1-release\Talend-ESB-V5.jar Creating file: /home/onofreje/5.0.conf before installing and starting the service.1-release\Talend-ESB-V5.1\container\etc\TALENDESB-CONTAINER-wrapper.1-release\Talend-ESB-V5.jar Creating file: C:\work\5.0.0.0.0.1-release/Talend-ESB-V5.conf Creating file: /home/onofreje/5.0.0.0.conf Creating file: C:\work\5.0.exe Creating file: C:\work\5. Installation on Linux The same wrapper:install command may be executed on Linux.bat remove 16.1/container/ bin/KARAF-wrapper Creating file: /home/onofreje/5.1/container/ lib/karaf-wrapper.1-release/Talend-ESB-V5. To install the service.0.1\container\bin\ TALEND-ESB-CONTAINER-service.1-release\Talend-ESB-V5.0.1/container/ bin/KARAF-service Creating file: /home/onofreje/5.0.jar Setup complete.1\container\etc\ TALEND-ESB-CONTAINER-wrapper.0.0. to stop the service run: C:> net stop "TALEND-ESB-CONTAINER" Once stopped.1-release\Talend-ESB-V5.1\container\bin\ TALEND-ESB-CONTAINER-wrapper.1-release\Talend-ESB-V5.0.0.0.4. trun@root> wrapper:install -s AUTO_START -n TALEND-ESB-CONTAINER \ -d Talend-ESB-Container -D "Talend ESB Container Service" Creating file: /home/onofreje/5. to remove the installed the service run: C:> C:\work\5.0.0.1\container\lib\ karaf-wrapper-main.0.1-release/Talend-ESB-V5.1\container\lib\ wrapper.Chapter 16.1\container\bin\ TALEND-ESB-CONTAINER-service.dll Creating file: C:\work\5. Installing the Talend Runtime container as a service Here is an example of wrapper:install command executing on Windows: karaf@trun> wrapper:install -s AUTO_START -n TALEND-ESB-CONTAINER -d Talend-ESB-Container -D "Talend ESB Container Service" Creating file: C:\work\5.1-release\Talend-ESB-V5.0.0.0.1\container\lib\ karaf-wrapper.0.1/container/ etc/KARAF-wrapper.1-release/Talend-ESB-V5.0. to start the service run: C:> net start "TALEND-ESB-CONTAINER" Once running.

2. On Ubuntu/Debian Systems To install the service: $ ln -s /home/onofreje/5. On Redhat/Fedora/CentOS Systems To install the service: $ ln -s /home/onofreje/5.4.0.d/ $ chkconfig TALEND-ESB-CONTAINER-service --add To start the service when the machine is rebooted: $ chkconfig TALEND-ESB-CONTAINER-service on To disable starting the service when the machine is rebooted: $ chkconfig TALEND-ESB-CONTAINER-service off To start the service: $ service TALEND-ESB-CONTAINER-service start To stop the service: $ service TALEND-ESB-CONTAINER-service stop To uninstall the service : $ chkconfig TALEND-ESB-CONTAINER-service --del $ rm /etc/init.4.jar Setup complete.1/container/bin/TALEND-ESB-CONTAINERservice /etc/init.d/ To start the service when the machine is rebooted: $ update-rc.1. Subsequently.d/TALEND-ESB-CONTAINER-service 16.1.1-release/Talend-ESB-V5.1/container/bin/ TALEND-ESB-CONTAINER-service /etc/init.conf before installing and starting the service.Chapter 16.3/etc/KARAF-wrapper.d -f TALEND-ESB-CONTAINER-service remove To start the service: Talend ESB Container Administration Guide 55 .0. Installing the Talend Runtime container as a service lib/karaf-wrapper-main.0.d TALEND-ESB-CONTAINER-service defaults To disable starting the service when the machine is rebooted: $ update-rc.0. the way the service is installed depends upon your flavor of Linux: 16. You may want to tweak the JVM properties in the wrapper configuration file: /home/onofreje/apache-karaf-2.1-release/Talend-ESB-V5.

d/TALEND-ESB-CONTAINER-service Talend ESB Container Administration Guide 56 . Installing the Talend Runtime container as a service $ /etc/init.Chapter 16.d/TALEND-ESB-CONTAINER-service start To stop the service: $ /etc/init.d/TALEND-ESB-CONTAINER-service stop To uninstall the service : $ rm /etc/init.

Corresponds to the JVM parameter -XX:MaxPermSize Additionally the following parameters are used as default to enable class unloading from permanent generation which reduces the overall permanent generation space usage: -XX:+CMSClassUnloadingEnabled and -XX: +UseConcMarkSweepGC.1. Corresponds to the JVM parameter Xmx. Troubleshooting Talend ESB This chapter describes how to fix problems related to JVM memory allocation. Determines the start size of the Java heap memory. Using Talend ESB many classes are loaded. 17. Higher values may reduce garbage collection and improve performance. Java classes are loaded in permanent generation. Determines the maximum size of the Java heap memory. JAVA_MAX_MEM. Memory Allocation Parameters The Talend ESB start scripts define the JVM memory allocation parameters used for running Talend ESB. improve performance and avoid "Out of memory" exceptions. Increase if a "PermGen space" exception is thrown. This is a separate heap space that is normally not garbage collected. Increase if a "PermGen space" exception is thrown.Chapter 17. JAVA_PERM_MEM. This is a separate heap space that is normally not garbage collected. Determines the maximum size of permanent generation. JAVA_MIN_MEM. Determines the start size of permanent generation. Higher values may reduce garbage collection. Corresponds to the JVM parameter -XX:PermSize JAVA_MAX_PERM_MEM. Talend ESB Container Administration Guide 57 . Corresponds to the JVM parameter -Xms. specially when using security features and deploying multiple services to the same container.

3. On Linux Adapt the memory allocation parameters in the karaf start script at the following location: [karaf_install_dir]/bin/trun.bat. On Windows Adapt the memory allocation parameters in the karaf start script at the following location: [karaf_install_dir]/bin/trun.2. Talend ESB Container Administration Guide 58 . Determined by the script variable $JAVA_SIXTY_FOUR you can set different values depending whether your JVM is 64-bit.Chapter 17. 17. 64-bit-JVMs need significantly more memory. Troubleshooting Talend ESB 17. Determined by the script variable %Bit_64% you can set different values depending whether your JVM is 64-bit. 64-bit-JVMs need significantly more memory.