Karaf

Table of Contents

1. Description
2. Setup
   • The module manages the following
   • Setup requirements
   • Beginning with karaf
3. Usage - Configuration options and additional functionality
   • How to manage multiple karaf instances
4. Reference
   • Parameters
     • version
     • rootdir
     • install_from
     • karaf_file_name
     • karaf_zip_url
     • service_user_name
     • service_user_id
     • service_group_name
     • service_group_id
     • java_home
     • default_env_vars
     • karaf_ssh_host
     • karaf_ssh_port
     • karaf_ssh_user
     • karaf_custom_properties
     • karaf_startup_feature_repos
     • karaf_startup_feature_boots
     • mvn_repositories
     • file_maven_settings
     • file_karaf_logging

Description

This module sets up Karaf instances.

Current version used by this module is Karaf 4.0.9.

Setup

The module manages the following

• Download or copy and extract karaf zip file
• Configure karaf
• Install karaf as a service

Setup requirements

• puppetlabs-java for Java installation

Beginning with karaf

Declare the top-level karaf class and set up an instance:

class { 'karaf':
}

Usage

• Installation, make sure service is running and will be started at boot time :

class { 'karaf':
}

This will install and configure a service named 'karaf-instance1'.

• You can specify repos to be added on karaf startup, as well as features to start during karaf boot

class { 'karaf':
   karaf_startup_feature_repos => ['mvn:org.apache.camel.karaf/apache-camel/2.18.1/xml/features'],
   karaf_startup_feature_boots => ['jndi', 'jms', 'camel', 'camel-swagger', 'camel-jms']
}

• You can override karaf default logging configuration file by providing your own:

class { 'karaf':
   file_karaf_logging    => 'puppet:///modules/karaf/karaf/etc/org.ops4j.pax.logging.cfg'
}

• If you need to update your maven settings (for instance if karaf needs to retrieve maven dependencies from nexus), you can override maven settings:

class { 'karaf':
   file_maven_settings   => 'puppet:///modules/karaf_is/maven/settings.xml'
}

How to manage multiple karaf instances

$karaf_instances = {
  'instance1' => {
    karaf_ssh_port          => 8101,
    karaf_rmi_registry_port => 1099,
    karaf_rmi_server_port   => 44444,
  },
  'instance2'  => {
    karaf_ssh_port          => 8102,
    karaf_rmi_registry_port => 1098,
    karaf_rmi_server_port   => 44445,
  },
}

class { 'karaf':
  instances => $karaf_instances
}

Reference

Parameters

All parameters are optional.

version

String. Directory path where kara will be installed.

rootdir

String. Karaf version to install (eg. 4.0.9).

install_from

String. 'web' or 'file'. If web, zip package is retrieved from url. If not, zip package has to be provided in module files/karaf/dist directory.

karaf_file_name

String. name of karaf directory when unzipped.

karaf_zip_url

String. Url of karaf zip. Used id install_from web

service_user_name

String. User name of user to run karaf

service_user_id

String. User id of user to run karaf

service_group_name

String. Group name of user to run karaf

service_group_id

String. Group id of user to run karaf

java_home

String. java home

default_env_vars

Array. Environment variables used in setenv.sh file. Example : default_env_vars => { 'JAVA_MIN_MEM' => '256M' }

karaf_ssh_host

String. ssh host to connect to karaf console.

karaf_ssh_port

String. ssh port to connect to karaf console.

karaf_ssh_user

String. ssh user to connect to karaf console.

karaf_custom_properties

Array. custom properties to extand karaf properties in etc/custom.properties file.

karaf_startup_feature_repos

Array. List of repos to declare at karaf startup.

karaf_startup_feature_boots

Array. List of features to automatically start on karf boot.

mvn_repositories

String. Maven repositories to override the ones in ${karaf.home}/etc/org.ops4j.pax.url.mvn.cfg file under org.ops4j.pax.url.mvn.repositories property.

file_maven_settings

String. Path of file to override maven settings.

file_karaf_logging

String. Path of file to override karaf logging.