Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

tomcat

multi instance tomcat
Project URLRSS FeedReport issues

15,809 downloads

5,092 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

  • 0.6.24 (latest)
  • 0.6.22
  • 0.6.21 (deleted)
  • 0.5.10
released Dec 13th 2018
This version is compatible with:
  • Puppet Enterprise 2023.8.x, 2023.7.x, 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, 2021.2.x, 2021.1.x, 2021.0.x, 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, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 3.8.0
  • , , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'eyp-tomcat', '0.6.24'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add eyp-tomcat
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install eyp-tomcat --version 0.6.24

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

eyp/tomcat — version 0.6.24 Dec 13th 2018

tomcat status ready

NTTCom-MS/eyp-tomcat: Build Status

Table of Contents

  1. Overview
  2. Module Description
  3. Setup
  4. Usage
  5. Reference
  6. Limitations
  7. Development

Overview

Multi instance tomcat installation

Module Description

Multi instance tomcat installation and configuration of:

  • server.xml
    • context, connectors, reals, values...
  • JVM memory settings
  • context.xml
  • authenticators
  • jaas
  • jndi
  • custom library deployment (tar.gz)
  • web.xml
  • custom properties files
  • postgres jdbc driver

Setup

What tomcat affects

By default,

  • CATALINA_HOME: /opt/tomcat-home (configured on class tomcat)
  • CATALINA_BASE: "/opt/${name}" (configured on define instance)

Setup Requirements

This module requires pluginsync enabled and eyp/nsswitch module installed, optionally eyp-java

If eyp-logrotate is available, it can define catalina.out file rotation

Beginning with tomcat

simple example:

class { 'tomcat':
  tomcat_url => 'http://archive.apache.org/dist/tomcat/tomcat-7/v7.0.68/bin/apache-tomcat-7.0.68.tar.gz',
  nativelibrary => true,
}

tomcat::instance { 'tomcat-8080':
  tomcatpw => 'lol',
  shutdown_port=>'2022',
  ajp_port=>'8081',
  connector_port=>'8080',
  jmx_port => '2021',
  lockoutrealm => false,
}

tomcat::instance { 'tomcat-8888':
  tomcatpw => 'lol',
  shutdown_port=>'9000',
  ajp_port=>'8885',
  connector_port=>'8888',
  jmx_port => '9999',
  lockoutrealm => true,
}

Usage

typical configuration options

Multi instance installation example:

---
paquets_general:
  - gcc
classes:
  - tomcat
  - java
java::java_package: java-1.8.0-openjdk
java::java_devel_package: java-1.8.0-openjdk-devel
tomcat::tomcat_src: puppet:///tomcat/apache-tomcat-7.0.57.tar.gz
tomcat::nativelibrary: true
tomcatinstances:
  tomcat8080:
    tomcatpw: a12345
    shutdown_port: 8070
    jmx_port: 8060
    ajp_port: ""
    connector_port: 8080
    xmx: 1024m
    xms: 512m
    realms:
      - es.systemadmin.es.sso.tomcat.SSORealm
    values:
      - org.apache.catalina.authenticator.SingleSignOn
    errorReportValveClass: es.systemadmin.es.sso.tomcat.SSOErrorValve
    lockoutrealm: false
    userdatabase: false
    extra_vars:
      CONNECTOR_PORT:
        8080
    rmi_server_hostname: "%{::ipaddress_eth0}"
  tomcat8081:
    tomcatpw: a12345
    shutdown_port: 8071
    jmx_port: 8061
    ajp_port: ""
    connector_port: 8081
    xmx: 1024m
    xms: 512m
    realms:
      - es.systemadmin.es.sso.tomcat.SSORealm
    values:
      - org.apache.catalina.authenticator.SingleSignOn
    errorReportValveClass: es.systemadmin.es.sso.tomcat.SSOErrorValve
    lockoutrealm: false
    userdatabase: false
    extra_vars:
      CONNECTOR_PORT:
        8081
    rmi_server_hostname: "%{::ipaddress_eth0}"
  tomcat8082:
    tomcatpw: a12345
    shutdown_port: 8072
    jmx_port: 8062
    ajp_port: ""
    connector_port: 8082
    xmx: 1024m
    xms: 512m
    realms:
      - es.systemadmin.es.sso.tomcat.SSORealm
    values:
      - org.apache.catalina.authenticator.SingleSignOn
    errorReportValveClass: es.systemadmin.es.sso.tomcat.SSOErrorValve
    lockoutrealm: false
    userdatabase: false
    extra_vars:
      CONNECTOR_PORT:
        8082
    rmi_server_hostname: "%{::ipaddress_eth0}"
  tomcat8083:
    tomcatpw: a12345
    shutdown_port: 8073
    jmx_port: 8063
    ajp_port: ""
    connector_port: 8083
    xmx: 1024m
    xms: 512m
    realms:
      - es.systemadmin.es.sso.tomcat.SSORealm
    values:
      - org.apache.catalina.authenticator.SingleSignOn
    errorReportValveClass: es.systemadmin.es.sso.tomcat.SSOErrorValve
    lockoutrealm: false
    userdatabase: false
    rmi_server_hostname: "%{::ipaddress_eth0}"

jaas properties example

jaasproperties:
  tomcat8080:
    app: SystemAdminInternalConfig
    provider: ldap://1.2.3.4:389/ou=People,dc=systemadmin,dc=es
    filter: (&(uid={USERNAME})(objectClass=inetOrgPerson))
  tomcat8081:
    app: SystemAdminInternalConfig
    provider: ldap://1.2.3.4:389/ou=People,dc=systemadmin,dc=es
    filter: (&(uid={USERNAME})(objectClass=inetOrgPerson))
  tomcat8082:
    app: SystemAdminInternalConfig
    provider: ldap://1.2.3.4:389/ou=People,dc=systemadmin,dc=es
    filter: (&(uid={USERNAME})(objectClass=inetOrgPerson))
  tomcat8083:
    app: SystemAdminInternalConfig
    provider: ldap://1.2.3.4:389/ou=People,dc=systemadmin,dc=es
    filter: (&(uid={USERNAME})(objectClass=inetOrgPerson))

jndi properties example

jndiproperties:
  tomcat8080:
    ldapservers:
      - "ldap1.%{::ntteam_ptr_fqdn_tokenized_2}.systemadmin.es"
      - "ldap2.%{::ntteam_ptr_fqdn_tokenized_2}.systemadmin.es"
    ldapbase: "%{hiera('systemadmin::ldapbase')}"
    ldapadmin: "%{hiera('systemadmin::ldapadmin')}"
    ldapadminpassword: "%{hiera('openldap::server::adminpassword')}"
  tomcat8081:
    ldapservers:
      - "ldap1.%{::ntteam_ptr_fqdn_tokenized_2}.systemadmin.es"
      - "ldap2.%{::ntteam_ptr_fqdn_tokenized_2}.systemadmin.es"
    ldapbase: "%{hiera('systemadmin::ldapbase')}"
    ldapadmin: "%{hiera('systemadmin::ldapadmin')}"
    ldapadminpassword: "%{hiera('openldap::server::adminpassword')}"
  tomcat8082:
    ldapservers:
      - "ldap1.%{::ntteam_ptr_fqdn_tokenized_2}.systemadmin.es"
      - "ldap2.%{::ntteam_ptr_fqdn_tokenized_2}.systemadmin.es"
    ldapbase: "%{hiera('systemadmin::ldapbase')}"
    ldapadmin: "%{hiera('systemadmin::ldapadmin')}"
    ldapadminpassword: "%{hiera('openldap::server::adminpassword')}"
  tomcat8083:
    ldapservers:
      - "ldap1.%{::ntteam_ptr_fqdn_tokenized_2}.systemadmin.es"
      - "ldap2.%{::ntteam_ptr_fqdn_tokenized_2}.systemadmin.es"
    ldapbase: "%{hiera('systemadmin::ldapbase')}"
    ldapadmin: "%{hiera('systemadmin::ldapadmin')}"
    ldapadminpassword: "%{hiera('openldap::server::adminpassword')}"

authenticators example

tomcatauthenticators:
  tomcat8080:
    basic: es.systemadmin.sso.tomcat.BasicAuthenticator
    form: es.systemadmin.sso.tomcat.FormAuthenticator
  tomcat8081:
    basic: es.systemadmin.sso.tomcat.BasicAuthenticator
    form: es.systemadmin.sso.tomcat.FormAuthenticator
  tomcat8082:
    basic: es.systemadmin.sso.tomcat.BasicAuthenticator
    form: es.systemadmin.sso.tomcat.FormAuthenticator
  tomcat8083:
    basic: es.systemadmin.sso.tomcat.BasicAuthenticator
    form: es.systemadmin.sso.tomcat.FormAuthenticator

library tarball installation example

tomcatlibstarballs:
  tomcat8080:
    source: puppet:///customers/example/tomcatlibs.tgz
  tomcat8081:
    source: puppet:///customers/example/tomcatlibs.tgz
  tomcat8082:
    source: puppet:///customers/example/tomcatlibs.tgz
  tomcat8083:
    source: puppet:///customers/example/tomcatlibs.tgz

custom tomcat properties file deployment example

tomcatproperties:
  catalina8080:
    properties_file: catalina
    source: puppet:///customers/example/catalina.properties
    catalina_base: /opt/tomcat8080
    servicename: tomcat8080
  catalina8081:
    properties_file: catalina
    source: puppet:///customers/example/catalina.properties
    catalina_base: /opt/tomcat8081
    servicename: tomcat8081
  catalina8082:
    properties_file: catalina
    source: puppet:///customers/example/catalina.properties
    catalina_base: /opt/tomcat8082
    servicename: tomcat8082
  catalina8083:
    properties_file: catalina
    source: puppet:///customers/example/catalina.properties
    catalina_base: /opt/tomcat8083
    servicename: tomcat8083
  logging8080:
    properties_file: logging
    source: puppet:///customers/example/logging.properties
    catalina_base: /opt/tomcat8080
    servicename: tomcat8080
  logging8081:
    properties_file: logging
    source: puppet:///customers/example/logging.properties
    catalina_base: /opt/tomcat8081
    servicename: tomcat8081
  logging8082:
    properties_file: logging
    source: puppet:///customers/example/logging.properties
    catalina_base: /opt/tomcat8082
    servicename: tomcat8082
  logging8083:
    properties_file: logging
    source: puppet:///customers/example/logging.properties
    catalina_base: /opt/tomcat8083
    servicename: tomcat8083

web.xml example

tomcatwebxml:
  tomcat8080:
    source: puppet:///customers/example/web.xml
  tomcat8081:
    source: puppet:///customers/example/web.xml
  tomcat8082:
    source: puppet:///customers/example/web.xml
  tomcat8083:
    source: puppet:///customers/example/web.xml

context.xml example

tomcatcontext:
  tomcat8080:
    sessionCookiePath: /
    antiJARLocking: true
    antiResourceLocking: true
  tomcat8081:
    sessionCookiePath: /
    antiJARLocking: true
    antiResourceLocking: true
  tomcat8082:
    sessionCookiePath: /
    antiJARLocking: true
    antiResourceLocking: true
  tomcat8083:
    sessionCookiePath: /
    antiJARLocking: true
    antiResourceLocking: true

update library

tomcat::lib { 'tomcat-8080':
  jar_name => 'ecj-4.4.3',
  source => 'puppet:///solr/ecj-4.4.3.jar',
}

java agent

tomcat::agent { 'tomcat-8080':
  agent_name => 'agenttest',
  comment => 'example agent',
  jar_name => 'agenttest-1.0.29',
  source => 'puppet:///tomcat/agenttest-1.0.29.jar',
}

postgres JDBC driver

tomcatinstances:
  tomcat_retail01:
    tomcatpw: 123456
    xmx: 1024m
    xms: 1024m
    ajp_port: 9509
    maxpermsize: 384m
    heapdump_oom_dir: /opt/applogs/RETAIL01
  tomcat_retail50:
    tomcatpw: 123456
    xmx: 1024m
    xms: 1024m
    ajp_port: 9510
    maxpermsize: 384m
    heapdump_oom_dir: /opt/applogs/RETAIL50
tomcatdriverpostgres:
  tomcat_retail01: {}
  tomcat_retail50: {}

add a new tomcatuser

tomcat::tomcatuser { 'tomcat-8080':
  tomcatuser => 'test',
  tomcatpw => 'lol',
}

init script usage

options

[root@ldapm ~]# /etc/init.d/tomcat-8080
Usage: /etc/init.d/tomcat-8080 start | stop | status | threadump | heapdump <file>

threadump

Will create a thread dump on catalina.out

# /etc/init.d/tomcat-8080 threadump
thread dump - OK

For example:

Full thread dump OpenJDK 64-Bit Server VM (25.101-b13 mixed mode):

"ajp-bio-8888-AsyncTimeout" #20 daemon prio=5 os_prio=0 tid=0x00007f71343c7000 nid=0x226f waiting on condition [0x00007f7120fab000]
   java.lang.Thread.State: TIMED_WAITING (sleeping)
    at java.lang.Thread.sleep(Native Method)
    at org.apache.tomcat.util.net.JIoEndpoint$AsyncTimeout.run(JIoEndpoint.java:152)
    at java.lang.Thread.run(Thread.java:745)

"http-bio-8080-AsyncTimeout" #18 daemon prio=5 os_prio=0 tid=0x00007f71343c3800 nid=0x226d waiting on condition [0x00007f71211ad000]
   java.lang.Thread.State: TIMED_WAITING (sleeping)
    at java.lang.Thread.sleep(Native Method)
    at org.apache.tomcat.util.net.JIoEndpoint$AsyncTimeout.run(JIoEndpoint.java:152)
    at java.lang.Thread.run(Thread.java:745)

"ContainerBackgroundProcessor[StandardEngine[Catalina]]" #16 daemon prio=5 os_prio=0 tid=0x00007f71343b2800 nid=0x226b waiting on condition [0x00007f71213af000]
   java.lang.Thread.State: TIMED_WAITING (sleeping)
    at java.lang.Thread.sleep(Native Method)
    at org.apache.catalina.core.ContainerBase$ContainerBackgroundProcessor.run(ContainerBase.java:1513)
    at java.lang.Thread.run(Thread.java:745)

"GC Daemon" #13 daemon prio=2 os_prio=0 tid=0x00007f7134307800 nid=0x225c in Object.wait() [0x00007f7122d01000]
   java.lang.Thread.State: TIMED_WAITING (on object monitor)
    at java.lang.Object.wait(Native Method)
    - waiting on <0x00000000e16a8560> (a sun.misc.GC$LatencyLock)
    at sun.misc.GC$Daemon.run(GC.java:117)
    - locked <0x00000000e16a8560> (a sun.misc.GC$LatencyLock)

(...)

"Finalizer" #3 daemon prio=8 os_prio=0 tid=0x00007f7134089800 nid=0x220a in Object.wait() [0x00007f7123eaa000]
   java.lang.Thread.State: WAITING (on object monitor)
    at java.lang.Object.wait(Native Method)
    - waiting on <0x00000000e0008ee0> (a java.lang.ref.ReferenceQueue$Lock)
    at java.lang.ref.ReferenceQueue.remove(ReferenceQueue.java:143)
    - locked <0x00000000e0008ee0> (a java.lang.ref.ReferenceQueue$Lock)
    at java.lang.ref.ReferenceQueue.remove(ReferenceQueue.java:164)
    at java.lang.ref.Finalizer$FinalizerThread.run(Finalizer.java:209)

"Reference Handler" #2 daemon prio=10 os_prio=0 tid=0x00007f7134085000 nid=0x2209 in Object.wait() [0x00007f7123fab000]
   java.lang.Thread.State: WAITING (on object monitor)
    at java.lang.Object.wait(Native Method)
    - waiting on <0x00000000e0006b50> (a java.lang.ref.Reference$Lock)
    at java.lang.Object.wait(Object.java:502)
    at java.lang.ref.Reference.tryHandlePending(Reference.java:191)
    - locked <0x00000000e0006b50> (a java.lang.ref.Reference$Lock)
    at java.lang.ref.Reference$ReferenceHandler.run(Reference.java:153)

"main" #1 prio=5 os_prio=0 tid=0x00007f7134009800 nid=0x2203 runnable [0x00007f713af9b000]
   java.lang.Thread.State: RUNNABLE
    at java.net.PlainSocketImpl.socketAccept(Native Method)
    at java.net.AbstractPlainSocketImpl.accept(AbstractPlainSocketImpl.java:409)
    at java.net.ServerSocket.implAccept(ServerSocket.java:545)
    at java.net.ServerSocket.accept(ServerSocket.java:513)
    at org.apache.catalina.core.StandardServer.await(StandardServer.java:453)
    at org.apache.catalina.startup.Catalina.await(Catalina.java:777)
    at org.apache.catalina.startup.Catalina.start(Catalina.java:723)
    at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
    at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
    at java.lang.reflect.Method.invoke(Method.java:498)
    at org.apache.catalina.startup.Bootstrap.start(Bootstrap.java:321)
    at org.apache.catalina.startup.Bootstrap.main(Bootstrap.java:455)

"VM Thread" os_prio=0 tid=0x00007f713407b800 nid=0x2208 runnable

"VM Periodic Task Thread" os_prio=0 tid=0x00007f71341a5800 nid=0x2253 waiting on condition

JNI global references: 51

Heap
 def new generation   total 157248K, used 100655K [0x00000000e0000000, 0x00000000eaaa0000, 0x00000000eaaa0000)
  eden space 139776K,  72% used [0x00000000e0000000, 0x00000000e624bfd8, 0x00000000e8880000)
  from space 17472K,   0% used [0x00000000e8880000, 0x00000000e8880000, 0x00000000e9990000)
  to   space 17472K,   0% used [0x00000000e9990000, 0x00000000e9990000, 0x00000000eaaa0000)
 tenured generation   total 349568K, used 0K [0x00000000eaaa0000, 0x0000000100000000, 0x0000000100000000)
   the space 349568K,   0% used [0x00000000eaaa0000, 0x00000000eaaa0000, 0x00000000eaaa0200, 0x0000000100000000)
 Metaspace       used 15177K, capacity 15452K, committed 15744K, reserved 1062912K
  class space    used 1547K, capacity 1609K, committed 1664K, reserved 1048576K

heapdump

Requires jmap installed

# /etc/init.d/tomcat-8080 heapdump heap.bin
Dumping heap to /tmp/hsperfdata_tomcat/heap.bin ...
Heap dump file created

known errors

error installing tomcat native library

The following error means that you need to install the devel package for java, for example java-1.7.0-openjdk-devel:

Notice: /Stage[main]/Tomcat/Exec[configure native library /usr/local/src]/returns: dirname: missing operand
Notice: /Stage[main]/Tomcat/Exec[configure native library /usr/local/src]/returns: Try 'dirname --help' for more information.
Notice: /Stage[main]/Tomcat/Exec[configure native library /usr/local/src]/returns: dirname: missing operand
Notice: /Stage[main]/Tomcat/Exec[configure native library /usr/local/src]/returns: Try 'dirname --help' for more information.
Notice: /Stage[main]/Tomcat/Exec[configure native library /usr/local/src]/returns: dirname: missing operand
Notice: /Stage[main]/Tomcat/Exec[configure native library /usr/local/src]/returns: Try 'dirname --help' for more information.
Notice: /Stage[main]/Tomcat/Exec[configure native library /usr/local/src]/returns: checking build system type... x86_64-unknown-linux-gnu
Notice: /Stage[main]/Tomcat/Exec[configure native library /usr/local/src]/returns: checking host system type... x86_64-unknown-linux-gnu
Notice: /Stage[main]/Tomcat/Exec[configure native library /usr/local/src]/returns: checking target system type... x86_64-unknown-linux-gnu
Notice: /Stage[main]/Tomcat/Exec[configure native library /usr/local/src]/returns: checking for a BSD-compatible install... /usr/bin/install -c
Notice: /Stage[main]/Tomcat/Exec[configure native library /usr/local/src]/returns: checking for working mkdir -p... yes
Notice: /Stage[main]/Tomcat/Exec[configure native library /usr/local/src]/returns: Tomcat Native Version: 1.1.33
Notice: /Stage[main]/Tomcat/Exec[configure native library /usr/local/src]/returns: checking for chosen layout... tcnative
Notice: /Stage[main]/Tomcat/Exec[configure native library /usr/local/src]/returns: checking for APR... yes
Notice: /Stage[main]/Tomcat/Exec[configure native library /usr/local/src]/returns:   setting CC to "gcc"
Notice: /Stage[main]/Tomcat/Exec[configure native library /usr/local/src]/returns:   setting CPP to "gcc -E"
Notice: /Stage[main]/Tomcat/Exec[configure native library /usr/local/src]/returns: checking for JDK location (please wait)... configure: error: Not a directory:
Error: bash -c "./configure --with-apr=/usr/bin/apr-1-config --with-java-home=$(dirname $(dirname $(dirname $(find / -xdev -iname jni_md.h | head -n1))))" returned 1 instead of one of [0]
Error: /Stage[main]/Tomcat/Exec[configure native library /usr/local/src]/returns: change from notrun to 0 failed: bash -c "./configure --with-apr=/usr/bin/apr-1-config --with-java-home=$(dirname $(dirname $(dirname $(find / -xdev -iname jni_md.h | head -n1))))" returned 1 instead of one of [0]

tomcat agent

tomcat::agent { 'tomcat-8080':
  agent_name => 'demo',
  jar_name => 'demo',
  tar_source => 'puppet:///solr/apache-tomcat-7.0.62.tar.gz',
}

Reference

Global variables

  • eyptomcat::shutdowncommand: Defines a string to be used to shutdown tomcat (default: SHUTDOWN)

classes

tomcat

  • installation options (at least one is required):
    • tomcat_src: resource with the tomcat package (default: undef)
    • tomcat_url: URL to download the tomcat package (default: undef)
  • other options:
    • manage_tomcat_user: Manage or not the tomcat_user user (default: true)
    • tomcat_user: User to run tomcat (default: tomcat)
    • tomcat_user_home: tomcat user home dir (default: /home/tomcat)
    • tomcat_user_shell: tomcat user shell (default: /bin/bash)
    • catalina_home: where to install tomcat (default: /opt/tomcat-home)
    • srcdir: Place to store .tar.gz and other temporal files (default: /usr/local/src)
    • nativelibrary: Install tomcat native library (default: true)

defines

tomcat::instance

references:

  • [http://www.fasterj.com/articles/oraclecollectors1.shtml](Oracle JVM Garbage Collectors)
  • [https://blog.codecentric.de/en/2013/10/useful-jvm-flags-part-7-cms-collector/](Useful JVM Flags – Part 7 (CMS Collector))
  • [http://blog.sokolenko.me/2014/11/javavm-options-production.html](JVM options for production)

NOTE: please be aware some options might not be available for your specific tomcat version

instance options:

  • service options:
    • ensure = 'running',
    • manage_service = true,
    • manage_docker_service = true,
    • enable = true,
  • other options:
    • tomcatpw: Password for tomcat GUI user (default: password, must be changed)
    • catalina_base = "/opt/${name}",
    • instancename = $name,
    • pwdigest: Hashing algorithm for tomcat-users.xml file, valid values: sha, plaintext (default: sha)
    • tomcat_user = $tomcat::params::default_tomcat_user,
    • server_info: server identification for this version of Tomcat (default: .)
    • server_number: server's version number (default: .)
    • server_built: server built time for this version of Tomcat (default: .)
    • xmx: JVM max memory: (default: 512m)
    • xms: JVM start memory: (default: 512m)
    • maxpermsize: JVM -XX:MaxPermSize (if available): (default: 512m)
    • permsize: JVM -XX:PermSize (default: undef)
    • shutdown_port: shutdown port (default: 8005)
    • shutdown_address: shutdown listen address (default: 127.0.0.1)
    • ajp_port: AJP listen port (default: undef)
    • connector_port: HTTP connector port (default: 8080)
    • connector_http_server: HTTP server Header (default: undef which adds the default name: Server: Apache-Coyote/1.1)
    • jmx_port: JMX listen port (default: 8999)
    • redirectPort = '8443',
    • realms = undef,
    • values = undef,
    • errorReportValveClass = undef,
    • maxThreads: tomcat max threads (default: 150)
    • minSpareThreads = '4',
    • connectionTimeout = '20000',
    • lockoutrealm = true,
    • userdatabase = true,
    • extra_vars = undef,
    • system_properties = undef,
    • rmi_server_hostname = undef,
    • catalina_rotate: if eyp-logrotate is available defines a daily catalina.out rotation with this value retention (default: 15)
    • catalina_size: if eyp-logrotate is available defines a max size to rotate catalina.out (default: 100M)
    • heapdump_oom_dir: heapdump dir, if defined enables heapdumping (default: undef)
    • install_tomcat_manager = true,
    • shutdown_command: shutdown command for the shutdown port (default: eyptomcat::shutdowncommand which, by default, is SHUTDOWN)
    • java_library_path: -Djava.library.path (default: undef)
    • java_home = undef,
    • webapps_owner: webapps folder owner
    • webapps_group: webapps folder group
    • webapps_mode: webapps folder mode
    • custom_webxml: copies web.xml from catalina_home to catalina_base. If you need to use a custom web.xml you are going to need to set it to true. (default: false)
    • catalina_stop_options: Options to stop tomcat (default: stop) - It must be a string
    • use_par_new_gc: Uses a parallel version of the young generation copying collector alongside the default collector. This minimizes pauses by using all available CPUs in parallel. The collector is compatible with both the default collector and the Concurrent Mark and Sweep (CMS) collector.
    • max_tenuring_threshold: reduce the amount of time spent in data copying in the young generation collection while avoiding promoting too many objects, by noting tenuring ages in the GC logs (default: undef)
    • survivor_ratio: Ratio of eden/survivor space size (default: undef)
    • unlock_diagnostic_vm_options = false,
    • par_gc_cards_per_stride_chunk: controls the granularity of tasks given to GC worker threads and helps get the best performance (default: undef)
    • bind_gc_task_threads_to_cpus : binds GC threads to individual CPU cores (default: false)
    • use_gc_task_affinity: allocates tasks to GC worker threads using an affinity parameter if implemented (default: false)
    • always_pre_touch: It pretouchs and set zero all the pages you have allocated during the initialization of your application (default: false)
    • scavenge_before_full_gc: Do young generation GC prior to a full GC (default: false)
    • agressive_opts: Turn on point performance compiler optimizations that are expected to be default in upcoming releases (default: false)
    • use_biased_locking: Enable biased locking (default: false)
    • print_gc_cause = false,
    • target_survivor_ratio: Desired percentage of survivor space used after scavenge (default: undef)
    • parallel_gc_threads: Sets the number of garbage collection threads in the young and old parallel garbage collectors (default: undef)
    • jvm_prefer_ip4_stack = false,
    • http_max_connections = undef,
    • rmi_port = undef,
    • connector_ajp_accept_count = undef,
    • connector_ajp_acceptor_threadcount = undef,

tomcat::agent

  • jar_name: jar to deploy (required)
  • agent_name: agent name, agent will be deployed on catalina_base/agent_name (required)
  • install_type: installation type: source/tar/link (default: tar)
  • source: file source, must be a puppet resource (for installation type source)
  • file_ln: jar already in place, just add a softlink to it (for installation type link)
  • tar_source: tar source, must be a puppet resource (for installation type tar)
  • catalina_base: (default: /opt/${name})
  • servicename: (default: $name)
  • purge_old: purge old agent versions (default: false)
  • ensure: (default: present)
  • description: commet to add in the setenv file to identify this agent (default: undef)
  • srcdir: where to keep temporal files for tar based installation type (default: /usr/local/src)

tomcat::driver::postgres

Install postgres driver for a given tomcat instance:

  • catalina_base: catalina_base for the tomcat instance (default: /opt/${resource's name})
  • servicename: tomcat's servicename (default: resource's name)
  • jdbc_version = '4',
  • postgres_version = '9.2',
  • srcdir = '/usr/local/src',
  • ensure = 'present',

tomcat::authenticators

  • basic = 'org.apache.catalina.authenticator.BasicAuthenticator',
  • form = 'org.apache.catalina.authenticator.FormAuthenticator',
  • clientcert = 'org.apache.catalina.authenticator.SSLAuthenticator',
  • digest = 'org.apache.catalina.authenticator.DigestAuthenticator',
  • none = 'org.apache.catalina.authenticator.NonLoginAuthenticator',
  • catalina_base: catalina_base for the tomcat instance (default: /opt/${resource's name})
  • servicename: tomcat's servicename (default: resource's name)

tomcat::context

  • sessionCookiePath = undef,
  • watchedResource = 'WEB-INF/web.xml',
  • manager = '',
  • antiJARLocking = false,
  • antiResourceLocking = false,
  • catalina_base: catalina_base for the tomcat instance (default: /opt/${resource's name})
  • servicename: tomcat's servicename (default: resource's name)
  • path: (default: undef)
  • session_cookie_name: change default session cookie name (default: undef, JSESSIONID)

tomcat::jaas

  • app,
  • provider,
  • filter,
  • username = 'tomcat',
  • password = 'tomcat',
  • catalina_base: catalina_base for the tomcat instance (default: /opt/${resource's name})
  • servicename: tomcat's servicename (default: resource's name)

tomcat::jndi

  • ldapservers,
  • ldapbase,
  • ldapadmin,
  • ldapadminpassword,
  • catalina_base: catalina_base for the tomcat instance (default: /opt/${resource's name})
  • servicename: tomcat's servicename (default: resource's name)

tomcat::lib

  • jar_name,
  • source = undef,
  • file_ln = undef,
  • purge_old: purge other versions of this library (default: true)
  • ensure = 'present',
  • catalina_base: catalina_base for the tomcat instance (default: /opt/${resource's name})
  • servicename: tomcat's servicename (default: resource's name)

tomcat::libstarball

  • catalina_base: catalina_base for the tomcat instance (default: /opt/${resource's name})
  • servicename: tomcat's servicename (default: resource's name)
  • source,
  • libstarballname = $name,
  • purge_old = false,

tomcat::properties

  • source,
  • properties_file,
  • catalina_base: catalina_base for the tomcat instance (default: /opt/${resource's name})
  • servicename: tomcat's servicename (default: resource's name)
  • dir: properties directory (default: conf)

tomcat::resource

  • catalina_base: catalina_base for the tomcat instance (default: /opt/${resource's name})
  • servicename: tomcat's servicename (default: resource's name)
  • resource_type
  • resource_name,
  • factory = undef,
  • driver_class_name = undef,
  • resource_url = undef,
  • username = undef,
  • password = undef,
  • initial_size = undef,
  • max_active = undef,
  • max_idle = undef,
  • min_idle = undef,
  • validation_query = undef,
  • min_evictable_idletimemillis = undef,
  • time_between_evictionrunsmillis = undef,
  • numtests_per_evictionrun = undef,
  • init_sql = undef,
  • auth = undef,
  • location = undef,

tomcat::webxml

  • source,
  • catalina_base: catalina_base for the tomcat instance (default: /opt/${resource's name})
  • servicename: tomcat's servicename (default: resource's name)

tomcat:tomcatuser

  • tomcatuser: username (mandatory)
  • password: password (mandatory)
  • catalina_base: catalina base (default: /opt/<resource's name>)
  • servicename: instance name (default: resource's name)
  • pwdigest: password format, must match instance configuration (default: sha)
  • roles: list of roles (default: [ 'tomcat', 'manager', 'admin', 'manager-gui' ])

Limitations

Tested on:

  • CentOS 5
  • CentOS 6
  • CentOS 7
  • Ubuntu 14.04
  • Ubuntu 16.04

But should work anywhere

Development

We are pushing to have acceptance testing in place, so any new feature must have tests to check both presence and absence of any feature

TODO

  • acceptance testing for tomcat::agent
  • acceptance testing manage_service=false
  • review documentation for version 0.4 and 0.5
  • include files for server.xml
  • delete duplicated code for default vhost

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request