karaf

This cookbook installs Apache Karaf.

Usage

Use the provided resources to install karaf and configure users and features.

Requirements

• java cookbook
• ark cookbook

Platform

• Tested on CentOS 6.6, CentOS 7.2 and Ubuntu 14.04 (via Kitchen)

Resources

karaf

karaf 'install karaf' do
  install_java  true
  version       '4.0.7'
  user         'someuser'  
  action        :install
end

Actions

• :install - Installs Karaf and the karaf-service wrapper feature, and starts the service.
• :remove - Removes Karaf and the karaf-service wrapper

Attributes

• install_java - Whether or not to install Java. (default: true)
• source_url - Optional URL to download the Karaf file tar file from.
• version - The version of Karaf to install.
• install_path - Optional install path. (default: /usr/local)
• user - The user to run karaf-service as. (default: root)
• retry_count - The number of times to retry when performing Karaf client actions. This is important for slower platforms but generally shouldn't need to be changed. (default: 20)
• retry_delay - The number of seconds to wait when retrying a Karaf client action. This is important for slower platforms but generally shouldn't need to be changed. (default: 3)

Note: When setting the user to run Karaf as, it is assumed the user is already configured properly. When installing features, Maven may use a local repository for the user, which may require a home directory to be set.

karaf_feature_repository

karaf_feature_repository 'hawtio' do
  version 		'1.4.51'
  :install
end

Actions

• :install - Installs the specified feature repository.

Attributes

• install_path - The path to the installation folder. Needs to match the value in karaf. Will be cleaned-up/deprecated once a link is added from this resource to karaf. (default: '/usr/local')
• repository_name - The name of the repository to add. (name attribute)
• version - The version of the repository to add. (default: '')

karaf_feature

karaf_feature 'hawtio' do
  :install
end

Actions

• :install - Installs the specified feature.

Attributes

• install_path - The path to the installation folder. Needs to match the value in karaf. Will be cleaned-up/deprecated once a link is added from this resource to karaf. (default: '/usr/local')
• feature_name - The name of the feature to add. (name attribute)
• version - The version of the feature to add. (default: '')

karaf_bundle

karaf_bundle 'com.fasterxml.jackson.core/jackson-core' do
  version '2.4.3'
  start   true
  :install
end

Actions

• :install - Installs the specified bundle.

Attributes

• install_path - The path to the installation folder. Needs to match the value in karaf. Will be cleaned-up/deprecated once a link is added from this resource to karaf. (default: '/usr/local')
• bundle_name - The name of the feature to add. (name attribute)
• version - The version of the feature to add. (default: '')
• wrap - If this bundle needs to be wrapped. Prepends . (default: false)
• start - Whether or not to start the bundle. This may be dependent on the version of Karaf, and if it supports -s for the bundle:install command. (default: false)

karaf_user

Manages the users defined in user.properties

karaf_user 'newuser' do
  groups    ['group1', 'group2']
  password  'ultrafubar'
  :create
end

Actions

• :create - Creates or updates the specified karaf user.

Attributes

• install_path - The path to the installation folder. Needs to match the value in karaf. Will be cleaned-up/deprecated once a link is added from this resource to karaf. (default: '/usr/local')
• user_name - The name of the user to create. (name attribute)
• password - The password for the user.
• groups - An array of groups to add the user to.

karaf_group

Manages the groups defined in user.properties

karaf_group 'newgroup' do
  roles   ['role1', 'role2']
  :create
end

Actions

• :create - Creates or updates the specified karaf group.

Attributes

• install_path - The path to the installation folder. Needs to match the value in karaf. Will be cleaned-up/deprecated once a link is added from this resource to karaf. (default: '/usr/local')
• group_name - The name of the group to create. (name attribute)
• roles - An array of roles to add the group to.

Notes

This resource automatically adds the (apparently) required group role to the group definition. That is:

karaf_group 'newgroup' do
  roles   ['role1', 'role2']
  :create
end

Will generate this line in user.properties:

_g_\:newgroup = group,role1,role2,

Troubleshooting

Installing the Karaf service wrapper sometimes encounters issues. The install log log is located at /tmp/karaf-install.log

Known Issues

The service wrapper component does not reliably install, depending on the version of Karaf and Centos.

• 4.0.7 - works fine with Java 8
• 4.0.4 - works fine
• 3.0.6 (and above?) - Not working
• 3.0.5 - Supports systemd, WORKS FINE
• 3.0.4 -
  • Centos 6 fails; call to feature:install service-wrapper appears to not be working.
  • Centos 7 has similar issue.
• 3.0.3 - No systemd file in wrapper; so Centos 7 fails.

Contributing

1. Fork the repository on Github
2. Create a named feature branch (like add_component_x)
3. Write your change
4. Write tests for your change
5. Run the tests, ensuring they all pass
6. Run foodcritic and rubocop to make sure code is clean.
7. Submit a Pull Request using Github

License and Authors

Authors: Jason Capriotti