Installing the wrapper - 7.3

Talend ESB Container Administration Guide

Version
7.3
Language
English
Product
Talend Cloud
Talend Data Fabric
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for ESB
Talend Real-Time Big Data Platform
Module
Talend ESB
Talend Runtime
Content
Administration and Monitoring
Design and Development
Installation and Upgrade
Last publication date
2023-09-13

First, to install the wrapper, simply:

  1. Browse to the bin folder of the Talend Runtime Container directory, then launch:
    • trun.bat in Administrator mode on Windows

    • trun as root user on Linux

  2. To install the wrapper feature, simply type:

    • karaf@trun> feature:install wrapper on Windows.

    • trun@root> feature:install wrapper on Linux.

    Once installed, 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.
    
    SYNTAX
       wrapper:install [options]
    
    OPTIONS
       -d, --display
          The display name of the service.
       --help
          Display this help message
    
       -s, --start-type
          Mode in which the service is installed. AUTO_START or 
          DEMAND_START (Default: AUTO_START)
          (defaults to AUTO_START)
    
       -n, --name
          The service name that will be used when installing the 
          service. (Default: Karaf)
          (defaults to karaf)
    
       -D, --description
          The description of the service.
          (defaults to null)
    
  3. To set up the installation of the service, type in the following command:
    • karaf@trun> wrapper:install on Windows.

    • trun@root> wrapper:install on Linux.

    Warning:

    In Windows you may get the following message when attempting to install the service:

    wrapper  | OpenSCManager failed - Access is denied. (0x5)

    In this case launch the Command Prompt in Administrator mode. Right-click Command Prompt in the Start menu and select Run as administrator.

For instance, to register Talend Runtime Container as a service (depending on the running OS), in automatic start mode, simply type:

  • For Windows:

    karaf@trun> wrapper:install -s AUTO_START -n TALEND-ESB-CONTAINER  -d Talend-ESB-Container -D "Talend ESB Container Service"
  • For Linux:

    trun@root> wrapper:install -s AUTO_START -n TALEND-ESB-CONTAINER  -d Talend-ESB-Container -D "Talend ESB Container Service"

Here is an example of wrapper:install command executing on Windows (Note: this also contains instructions on how to remove the service):

karaf@trun> wrapper:install -s AUTO_START -n TALEND-ESB-CONTAINER 
-d Talend-ESB-Container  -D "Talend ESB Container Service"

Creating file: C:\work\-release\Talend-ESB-V\container\bin\
TALEND-ESB-CONTAINER-wrapper.exe
Creating file: C:\work\-release\Talend-ESB-V\container\etc\
TALEND-ESB-CONTAINER-wrapper.conf
Creating file: C:\work\-release\Talend-ESB-V\container\bin\
TALEND-ESB-CONTAINER-service.bat
Creating file: C:\work\-release\Talend-ESB-V\container\lib\
wrapper.dll
Creating file: C:\work\-release\Talend-ESB-V\container\lib\
karaf-wrapper.jar
Creating file: C:\work\-release\Talend-ESB-V\container\lib\
karaf-wrapper-main.jar

Setup complete.  You may wish to tweak the JVM properties in the 
wrapper configuration file:
        C:\work\-release\Talend-ESB-V\container\etc\TALEND-
ESB-CONTAINER-wrapper.conf
before installing and starting the service.

To install the service, run:
  C:> C:\work\-release\Talend-ESB-V\container\bin\
TALEND-ESB-CONTAINER-service.bat install

Once installed, to start the service run:
  C:> net start "TALEND-ESB-CONTAINER"

Once running, to stop the service run:
  C:> net stop "TALEND-ESB-CONTAINER"

Once stopped, to remove the installed the service run:
  C:> C:\work\-release\Talend-ESB-V\container\bin\
TALEND-ESB-CONTAINER-service.bat remove

Here is an example of wrapper:install command executing on Linux:

trun@root> wrapper:install -s AUTO_START -n TALEND-ESB-CONTAINER  \
        -d Talend-ESB-Container -D "Talend ESB Container Service"
Creating file: /home/onofreje/-release/Talend-ESB-V/container/
bin/KARAF-wrapper
Creating file: /home/onofreje/-release/Talend-ESB-V/container/
bin/KARAF-service
Creating file: /home/onofreje/-release/Talend-ESB-V/container/
etc/KARAF-wrapper.conf
Creating file: /home/onofreje/-release/Talend-ESB-V/container/
lib/libwrapper.so
Creating file: /home/onofreje/-release/Talend-ESB-V/container/
lib/karaf-wrapper.jar
Creating file: /home/onofreje/-release/Talend-ESB-V/container/
lib/karaf-wrapper-main.jar

Setup complete.  You may want to tweak the JVM properties in the wrapper 
configuration file:
        /home/onofreje/apache-karaf-2.1.3/etc/KARAF-wrapper.conf
before installing and starting the service.