Forge Home

Modules

Resources

PuppetEcosystemPuppet CommunityUpdates

karaf

Installs, configures, and manages Apache Karaf instances.
Project URLRSS FeedReport issues

343 downloads

69 latest version

4.7 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.4.0 (latest)
  • 0.3.0
  • 0.1.0
released Mar 18th 2024
This version is compatible with:
  • Puppet Enterprise 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x
  • Puppet >= 7.9.0 < 9.0.0
  • , , , , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'wimvr-karaf', '0.4.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add wimvr-karaf
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install wimvr-karaf --version 0.4.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

wimvr/karaf — version 0.4.0 Mar 18th 2024

karaf

Table of Contents

  1. Description
  2. Setup - The basics of getting started with karaf
  3. Usage - Configuration options and additional functionality
  4. Limitations
  5. Development - Guide for contributing to the module

Description

Module to install Apache Karaf and manage instances.

Setup

Beginning with karaf

To install Apache Karaf on your server with default parameters, declare the [karaf][] class:

class { 'karaf': }

Usage

In case you want to run Karaf with a different account, you can configure it:

class { 'karaf':
    service_user_name  => 'myuser',
    service_user_id    => 1050,
    service_group_name => 'mygroup',
    service_group_id   => 1050,
}

If you want to use an already existing account to run Karaf, tell the module not to create the account. You can omit the service_user_id and service_group_id. The service_user_name and service_group_name still need to be provided:

class { 'karaf':
    manage_user        => false,
    service_user_name  => 'myuser',
    service_group_name => 'mygroup',
}

To store data and logs in other directory:

class { 'karaf':
    pidfile          => '/store/karaf/karaf.pid',
    default_env_vars => {
                            'KARAF_DATA' => '/store/karaf/data/',
                            'KARAF_LOG'  => '/store/karaf/logs/',
    },
}

To use your own repository, with authentication:

class { 'karaf':
    mvn_repositories => ['https://www.example.com/repository/my-repo/@id=central@snapshots'],
    m2_settings      => {
                        'servers' => [{
                            'id'       => 'central',
                            'username' => 'myuser',
                            'password' => 'secret',
                        }],
                        'mirrors' => [{
                            'id'       => 'central',
                            'name'     => 'My Repository',
                            'url'      => 'https://www.example.com/repository/my-repo/',
                            'mirrorOf' => '*',
                        }]
                        },
}

Limitations

In this version, configuring instances is not yet possible.

Development

I highly welcome new contributions to this module, especially those that include documentation, and rspec tests ;) but will happily guide you through the process, so, yes, please submit that pull request!