Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

jolokia

Install jolokia agents, and configure
Project URLRSS FeedReport issues

21,531 downloads

11,257 latest version

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

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 2.0.0 (latest)
  • 1.1.1
  • 1.1.0
  • 1.0.1
released May 2nd 2019
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x
  • Puppet >= 5.5.8 < 7.0.0

Start using this module

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

Add this module to your Puppetfile:

mod 'puppet-jolokia', '2.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppet-jolokia
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppet-jolokia --version 2.0.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

puppet/jolokia — version 2.0.0 May 2nd 2019

Table of Contents

  1. Overview
  2. Setup Requirements
  3. Usage - Configuration options and additional functionality
  4. Reference - An under-the-hood peek at what the module is doing and how
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module

Overview

This Puppet 5.+ module installs and helps configure jolokia (jvm) agents.

Setup Requirements

Currently, this module expects you to provide a package for your platform which it then installs. We generally highly recommend this approach, because it makes life easier.

Usage

include ::jolokia

After this statement you should be able to extend your JVMs' JAVA_OPTS with

-javaagent:/usr/lib/java/jolokia-jvm-agent.jar=host=0.0.0.0

More more complex configurations can be put into a properties file. We provide a wrapper for that:

$props = {
  'host' => '*',
  'policyLocation' => 'file:///etc/jolokia/lolsecurity.xml',
}

jolokia::config { 'puppetserver':
  properties => $props + { 'port' => '7887' }
}
jolokia::config { 'puppetdb':
  properties => $props + { 'port' => '7889' }
}

We also provide a wrapper for creating policy files. However, currently it's restricted host-based authorization only:

jolokia::policy { 'lolsecurity':
  allowed_hosts => [ '1.1.1.1', '::1' ]
}

Reference

jolokia

This class is the main driver for the installation.

  String $jvm_agent_ensure = 'present',
  String $jvm_agent_name   = 'jolokia-jvm-agent',
  String $config_dir       = '/etc/jolokia',

jolokia::config

This define allows creating arbitrary properties files for each application.

  String                 $app        = $title,
  Enum['file', 'absent'] $ensure     = 'file',
  Hash                   $properties = {},

jolokia::policy

This define allows policy files for host-based authorization Usually one per host should suffice, unless you require distinct authentication.

  String                 $app           = $title,
  Enum['file', 'absent'] $ensure        = 'file',
  Array[String]          $allowed_hosts = ['127.0.0.1', '::1'],

Limitations

  • currently we expect you to provide your own package(s)
  • policy configuration only creates host-based authorization
  • our documentation is sad

##Development

Running tests

This project contains tests for rspec-puppet.

Quickstart:

gem install bundler
bundle install --path .vendor/
bundle exec rake test