Forge Home


Puppet module for tomcat


7,139 latest version

4.1 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

  • 2.1.10 (latest)
  • 2.1.9
  • 2.1.8
  • 2.1.7
  • 2.1.6
  • 2.1.5
  • 2.1.4
  • 2.1.3
  • 2.1.2
  • 2.1.1
  • 2.0.8
released Aug 12th 2016
This module has been deprecated by its author since Oct 28th 2019.

The reason given was: No longer maintained

The author has suggested puppetlabs-tomcat as its replacement.

Start using this module


example42/tomcat — version 2.1.10 Aug 12th 2016

Deprecation notice

This module was designed for Puppet versions 2 and 3. It should work also on Puppet 4 but doesn't use any of its features.

The current Puppet 3 compatible codebase is no longer actively maintained by example42.

Still, Pull Requests that fix bugs or introduce backwards compatible features will be accepted.

Puppet module: tomcat

This is a Puppet tomcat module from the second generation of Example42 Puppet Modules.

Made by Alessandro Franceschi / Lab42

Official site:

Official git repository:

Released under the terms of Apache 2 License.

This module requires functions provided by the Example42 Puppi module.

For detailed info about the logic and usage patterns of Example42 modules read README.usage on Example42 main modules set.

USAGE - Basic management

  • Install tomcat with default settings

      class { "tomcat": }
  • Disable tomcat service and create single tomcat instances (note for each for them you must specify (different) http_port and control_port

      class { "tomcat":
        disable => true
      tomcat::instance { 'my_app':
        http_port    => '8088',
        control_port => '6088',
      tomcat::instance { 'other_app':
        http_port    => '8089',
        control_port => '6089',
        ajp_port     => '9089',
  • Disable tomcat service at boot time, but don't stop if is running.

      class { "tomcat":
        disableboot => true
  • Remove tomcat package

      class { "tomcat":
        absent => true
  • Enable auditing without making changes on existing tomcat configuration files

      class { "tomcat":
        audit_only => true
  • Install a custom version of tomcat. The default is chose according to OS versions, but you can try to install a different one (given that a tomcat${version} packge is available)

      class { "tomcat": }
      On hiera set this key with the version value you want:
      tomcat::params::version: 7

Note: that some templates used by tomcat::instance may not be present for your version. You should provide them with the *_template parameters.

USAGE - Overrides and Customizations

  • Use custom sources for main config file

      class { "tomcat":
        source => [ "puppet:///modules/lab42/tomcat/tomcat.conf-${hostname}" , "puppet:///modules/lab42/tomcat/tomcat.conf" ], 
  • Use custom source directory for the whole configuration dir

      class { "tomcat":
        source_dir       => "puppet:///modules/lab42/tomcat/conf/",
        source_dir_purge => false, # Set to true to purge any existing file not present in $source_dir
  • Use custom template for main config file

      class { "tomcat":
        template => "example42/tomcat/tomcat.conf.erb",      
  • Define custom options that can be used in a custom template without the need to add parameters to the tomcat class

      class { "tomcat":
        template => "example42/tomcat/tomcat.conf.erb",    
        options  => {
          'LogLevel' => 'INFO',
          'UsePAM'   => 'yes',
  • Automaticallly include a custom subclass

      class { "tomcat:"
        my_class => 'tomcat::example42',

USAGE - Example42 extensions management

  • Activate puppi (recommended, but disabled by default) Note that this option requires the usage of Example42 puppi module

      class { "tomcat": 
        puppi    => true,
  • Activate puppi and use a custom puppi_helper template (to be provided separately with a puppi::helper define ) to customize the output of puppi commands

      class { "tomcat":
        puppi        => true,
        puppi_helper => "myhelper", 
  • Activate automatic monitoring (recommended, but disabled by default) This option requires the usage of Example42 monitor and relevant monitor tools modules

      class { "tomcat":
        monitor      => true,
        monitor_tool => [ "nagios" , "monit" , "munin" ],
  • Activate automatic firewalling This option requires the usage of Example42 firewall and relevant firewall tools modules

      class { "tomcat":       
        firewall      => true,
        firewall_tool => "iptables",
        firewall_src  => "",
        firewall_dst  => "$ipaddress_eth0",

Build Status