tomcat

Installs, deploys, and configures Apache Tomcat web services.

Project URL RSS Feed Report issues

Module Stats

2,897,381 downloads

1,550 latest version

4.3 quality score

Version information

released Dec 17th 2015

This version is compatible with:

Puppet Enterprise >= 3.3.0 < 2015.4.0
Puppet >= 3.0.0 < 5.0.0
, , , , ,

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'puppetlabs-tomcat', '1.4.1'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppetlabs-tomcat

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppetlabs-tomcat --version 1.4.1

Tags: tomcat

Documentation

puppetlabs/tomcat — version 1.4.1 Dec 17th 2015

#tomcat

####Table of Contents

Overview
Module Description - What the module does and why it is useful
Setup - The basics of getting started with tomcat
- Setup requirements
- Beginning with tomcat
Usage - Configuration options and additional functionality
Reference - An under-the-hood peek at what the module is doing and how
Limitations - OS compatibility, etc.
Development - Guide for contributing to the module

##Overview

The tomcat module lets you use Puppet to install, deploy, and configure Tomcat web services.

##Module Description

Tomcat is a Java web service provider. The tomcat module lets you use Puppet to install Tomcat, manage its configuration file, and deploy web apps to it. It supports multiple instances of Tomcat spanning multiple versions.

##Setup

###Setup requirements

The tomcat module requires puppetlabs-stdlib version 4.0 or newer. On Puppet Enterprise you must meet this requirement before installing the module. To update stdlib, run:

puppet module upgrade puppetlabs-stdlib

###Beginning with tomcat

The simplest way to get Tomcat up and running with the tomcat module is to install the Tomcat package from EPEL...

class { 'tomcat':
  install_from_source => false,
}
class { 'epel': }->
tomcat::instance{ 'default':
  package_name => 'tomcat',
}->

...and then start the service:

tomcat::service { 'default':
  use_jsvc     => false,
  use_init     => true,
  service_name => 'tomcat',
}

##Usage

###I want to install Tomcat from a specific source

To download Tomcat from a specific source and then start the service:

class { 'tomcat': }
class { 'java': }
tomcat::instance { 'test':
  source_url => 'http://mirror.nexcess.net/apache/tomcat/tomcat-8/v8.0.8/bin/apache-tomcat-8.0.8.tar.gz'
}->
tomcat::service { 'default': }

###I want to run multiple copies of Tomcat on a single node

class { 'tomcat': }
class { 'java': }

tomcat::instance { 'tomcat8':
  catalina_base => '/opt/apache-tomcat/tomcat8',
  source_url    => 'http://mirror.nexcess.net/apache/tomcat/tomcat-8/v8.0.8/bin/apache-tomcat-8.0.8.tar.gz'
}->
tomcat::service { 'default':
  catalina_base => '/opt/apache-tomcat/tomcat8',
}

tomcat::instance { 'tomcat6':
  source_url    => 'http://apache.mirror.quintex.com/tomcat/tomcat-6/v6.0.41/bin/apache-tomcat-6.0.41.tar.gz',
  catalina_base => '/opt/apache-tomcat/tomcat6',
}->
tomcat::config::server { 'tomcat6':
  catalina_base => '/opt/apache-tomcat/tomcat6',
  port          => '8105',
}->
tomcat::config::server::connector { 'tomcat6-http':
  catalina_base         => '/opt/apache-tomcat/tomcat6',
  port                  => '8180',
  protocol              => 'HTTP/1.1',
  additional_attributes => {
    'redirectPort' => '8543'
  },
}->
tomcat::config::server::connector { 'tomcat6-ajp':
  catalina_base         => '/opt/apache-tomcat/tomcat6',
  port                  => '8109',
  protocol              => 'AJP/1.3',
  additional_attributes => {
    'redirectPort' => '8543'
  },
}->
tomcat::service { 'tomcat6':
  catalina_base => '/opt/apache-tomcat/tomcat6'

###I want to deploy WAR files

tomcat::war { 'sample.war':
  catalina_base => '/opt/apache-tomcat/tomcat8',
  war_source => '/opt/apache-tomcat/tomcat8/webapps/docs/appdev/sample/sample.war',
}

The name of the WAR file must end with '.war'.

The war_source can be a local path or a puppet:///, http://, or ftp:// URL.

###I want to change my configuration

Tomcat does not restart after you update its configuration, unless you supply a notify metaparameter.

To remove a connector, for instance, start with a manifest like this:

tomcat::config::server::connector { 'tomcat8-jsvc':
  catalina_base         => '/opt/apache-tomcat/tomcat8-jsvc',
  port                  => '80',
  protocol              => 'HTTP/1.1',
  additional_attributes => {
    'redirectPort' => '443'
  },
  connector_ensure => 'present'
}

Then set connector_ensure to 'absent' and set notify to the service resource:

tomcat::config::server::connector { 'tomcat8-jsvc':
  catalina_base         => '/opt/apache-tomcat/tomcat8-jsvc',
  port                  => '80',
  protocol              => 'HTTP/1.1',
  additional_attributes => {
    'redirectPort' => '443'
  },
  connector_ensure => 'present'
  notify => Tomcat::Service['jsvc-default'],
}

###I want to manage a Connector or Realm that already exists

Describe the Realm or HTTP Connector element using tomcat::config::server::realm or tomcat::config::server::connector, and set purge_realms or purge_connectors to 'true'.

tomcat::config::server::realm { 'org.apache.catalina.realm.LockOutRealm':
  realm_ensure => 'present',
  purge_realms => true,
}

Puppet removes any existing Connectors or Realms and leaves only the ones you've specified.

##Reference

###Classes

####Public Classes

tomcat: Main class. Manages the installation and configuration of Tomcat.

####Private Classes

tomcat::params: Manages Tomcat parameters.

###Defines

####Public Defines

tomcat::config::server: Configures attributes for the Server element in $CATALINA_BASE/conf/server.xml.
tomcat::config::server::connector: Configures Connector elements in $CATALINA_BASE/conf/server.xml.
tomcat::config::server::context: Configures Context elements in $CATALINA_BASE/conf/server.xml.
tomcat::config::server::engine: Configures Engine elements in $CATALINA_BASE/conf/server.xml.
tomcat::config::server::host: Configures Host elements in $CATALINA_BASE/conf/server.xml.
tomcat::config::server::listener: Configures Listener elements in $CATALINA_BASE/conf/server.xml.
tomcat::config::server::realm: Configures Realm elements in $CATALINA_BASE/conf/server.xml.
tomcat::config::server::service: Configures a Service element element nested in the Server element in $CATALINA_BASE/conf/server.xml.
tomcat::config::server::tomcat_users: Configures user and role elements for [UserDatabaseRealm] (http://tomcat.apache.org/tomcat-8.0-doc/realm-howto.html#UserDatabaseRealm) or [MemoryRealm] (http://tomcat.apache.org/tomcat-8.0-doc/realm-howto.html#MemoryRealm) in $CATALINA_BASE/conf/tomcat-users.xml or any other specified file.
tomcat::config::server::valve: Configures a Valve element in $CATALINA_BASE/conf/server.xml.
tomcat::instance: Installs a Tomcat instance.
tomcat::service: Provides Tomcat service management.
tomcat::setenv::entry: Adds an entry to a Tomcat configuration file (e.g., setenv.sh or /etc/sysconfig/tomcat).
tomcat::war: Manages the deployment of WAR files.

####Private Defines

tomcat::instance::package: Installs Tomcat from a package.
tomcat::instance::source: Installs Tomcat from source.

###Parameters

All parameters are optional except where otherwise noted.

####tomcat

#####catalina_home

Specifies the root directory of the Tomcat installation. Valid options: a string containing an absolute path. Default: '/opt/apache-tomcat'.

#####group

Specifies a group to run Tomcat as. Valid options: a string containing a valid group name. Default: 'tomcat'.

#####install_from_source

Specifies whether to install Tomcat from source. Valid options: 'true' and 'false'. Default: 'true'.

#####manage_group

Determines whether to create the specified group, if it doesn't exist. Uses Puppet's native group resource type with default parameters. Valid options: 'true' and 'false'. Default: 'true'.

#####manage_user

Determines whether to create the specified user, if it doesn't exist. Uses Puppet's native user resource type with default parameters. Valid options: 'true' and 'false'. Default: 'true'.

#####purge_connectors

Specifies whether to purge any unmanaged Connector elements that match defined protocol but have a different port from the configuration file. Valid options: 'true' and 'false'. Default: 'false'.

#####purge_realms

Specifies whether to purge any unmanaged realm elements from the configuration file. Valid options: 'true' and 'false'. Default: 'false'. If two realms are defined for a specific server config only use purge_realms for the first realm and ensure the realms enforce a strict order between each other.

#####user

Specifies a user to run Tomcat as. Valid options: a string containing a valid username. Default: 'tomcat'.

####tomcat::config::server

#####address

Specifies a TCP/IP address on which to listen for the shutdown command. Maps to the address XML attribute. Valid options: a string. Default: undef.

#####address_ensure

Specifies whether the address XML attribute should exist in the configuration file. Valid options: 'true', 'false', 'present', and 'absent'. Default: 'present'.

#####catalina_base

Specifies the base directory of the Tomcat installation to manage. Valid options: a string containing an absolute path. Default: $tomcat::catalina_home.

#####class_name

Specifies the Java class name of a server implementation to use. Maps to the className XML attribute in the configuration file. Valid options: a string containing a Java class name. Default: undef.

#####class_name_ensure

Specifies whether the className XML attribute should exist in the configuration file. Valid options: 'true', 'false', 'present', and 'absent'. Default: 'present'.

#####port

Specifies a port on which to listen for the designated shutdown command. Maps to the port XML attribute. Valid options: a string containing a port number. Default: undef.

#####server_config

Specifies a server.xml file to manage. Valid options: a string containing an absolute path. Default: '${catalina_base}/config/server.xml'.

#####shutdown

Designates a command that shuts down Tomcat when the command is received through the specified address and port. Maps to the shutdown XML attribute Valid options: a string. Default: undef.

####tomcat::config::server::connector

#####additional_attributes

Specifies any further attributes to add to the Connector. Valid options: a hash of '< attribute >' => '< value >' pairs. Default: {}.

#####attributes_to_remove

Specifies any attributes to remove from the Connector. Valid options: a hash of '< attribute >' => '< value >' pairs. Default: [].

#####catalina_base

Specifies the base directory of the Tomcat installation to manage. Valid options: a string containing an absolute path. Default: $::tomcat/catalina_home.

#####connector_ensure

Specifies whether the Connector XML element should exist in the configuration file. Valid options: 'true', 'false', 'present', and 'absent'. Default: 'present'.

#####parent_service

Specifies which Service element the Connector should nest under. Valid options: a string containing the name attribute of the Service. Default: 'Catalina'.

#####port

Required if connector_ensure is set to 'true' or 'present'. Sets a TCP port on which to create a server socket. Maps to the port XML attribute. Valid options: a string.

#####protocol

Specifies a protocol to use for handling incoming traffic. Maps to the protocol XML attribute. Valid options: a string. Default: $name.

#####purge_connectors

Specifies whether to purge any unmanaged Connector elements that match defined protocol but have a different port from the configuration file. Valid options: 'true' and 'false'. Default: 'false'.

#####server_config

Specifies a server.xml file to manage. Valid options: a string containing an absolute path. Default: '${catalina_base}/config/server.xml'.

####tomcat::config::server::context

#####additional_attributes

Specifies any further attributes to add to the Context. Valid options: a hash of '< attribute >' => '< value >' pairs. Default: {}.

#####attributes_to_remove

Specifies any attributes to remove from the Context. Valid options: a hash of '< attribute >' => '< value >' pairs. Default: [].

#####catalina_base

Specifies the base directory of the Tomcat installation to manage. Valid options: a string containing an absolute path. Default: $::tomcat/catalina_home.

#####context_ensure

Specifies whether the Context XML element should exist in the configuration file. Valid options: 'true', 'false', 'present', and 'absent'. Default: 'present'.

#####doc_base

Specifies a Document Base (or Context Root) directory or archive file. Maps to the docBase XML attribute. Valid options: a string containing a path (either an absolute path or a path relative to the appBase directory of the owning Host). Default: $name.

#####parent_engine

Specifies which Engine element the Context should nest under. Only valid if parent_host is specified. Valid options: a string containing the name attribute of the Engine. Default: undef.

#####parent_host

Specifies which Host element the Context should nest under. Valid options: a string containing the name attribute of the Host. Default: undef.

#####parent_service

Specifies which Service XML element the Context should nest under. Valid options: a string containing the name attribute of the Service. Default: 'Catalina'.

#####server_config

Specifies a server.xml file to manage. Valid options: a string containing an absolute path. Default: '${catalina_base}/config/server.xml'.

####tomcat::config::server::engine

#####background_processor_delay

Determines the delay between invoking the backgroundProcess method on this engine and its child containers. Maps to the backgroundProcessorDelay XML attribute. Valid options: an integer, in seconds. Default: undef.

#####background_processor_delay_ensure

Specifies whether the backgroundProcessorDelay XML attribute should exist in the configuration file. Valid options: 'true', 'false', 'present', and 'absent'. Default: 'present'.

#####catalina_base

Specifies the base directory of the Tomcat installation to manage. Valid options: a string containing an absolute path. Default: $::tomcat::catalina_home.

#####class_name

Specifies the Java class name of a server implementation to use. Maps to the className XML attribute. Valid options: a string containing a Java class name. Default: undef.

#####class_name_ensure

Specifies whether the className XML attribute should exist in the configuration file. Valid options: 'true', 'false', 'present', and 'absent'. Default: 'present'.

#####default_host

Required. Specifies a host to handle any requests directed to hostnames that exist on the server but are not defined in this configuration file. Maps to the defaultHost XML attribute of the Engine. Valid options: a string containing a hostname.

#####engine_name

Specifies the logical name of the Engine, used in log and error messages. Maps to the name XML attribute. Valid options: a string. Default: the '[name]' passed in your define.

#####jvm_route

Specifies an identifier to enable session affinity in load balancing. Maps to the jvmRoute XML attribute. Valid options: string. Default: undef.

#####jvm_route_ensure

Specifies whether the jvmRoute XML attribute should exist in the configuration file. Valid options: 'true', 'false', 'present', and 'absent'. Default: 'present'.

#####parent_service

Specifies which Service element the Engine should nest under. Valid options: a string containing the name attribute of the Service. Default: 'Catalina'.

#####server_config

Specifies a server.xml file to manage. Valid options: a string containing an absolute path. Default: '${catalina_base}/config/server.xml'.

#####start_stop_threads

Sets how many threads the Engine should use to start child Host elements in parallel. Maps to the startStopThreads XML attribute. Valid options: a string. Default: undef.

#####start_stop_threads_ensure

Specifies whether the startStopThreads XML attribute should exist in the configuration file. Valid options: 'true', 'false', 'present', and 'absent'. Default: 'present'.

####tomcat::config::server::host

#####additional_attributes

Specifies any further attributes to add to the Host. Valid options: a hash of '< attribute >' => '< value >' pairs. Default: {}.

#####app_base

Required unless host_ensure is set to 'false' or 'absent'. Specifies the Application Base directory for the virtual host. Maps to the appBase XML attribute. Valid options: a string.

#####attributes_to_remove

Specifies any attributes to remove from the Host. Valid options: an array of '< attribute >' => '< value >' pairs. Default: [].

#####catalina_base

Specifies the base directory of the Tomcat installation to manage. Valid options: a string containing an absolute path. Default: $::tomcat::catalina_home.

#####host_ensure

Specifies whether the virtual host (the Host XML element) should exist in the configuration file. Valid options: 'true', 'false', 'present', and 'absent'. Default: 'present'.

#####host_name

Specifies the network name of the virtual host, as registered on your DNS server. Maps to the name XML attribute. Valid options: a string. Default: the '[name]' passed in your define.

#####parent_service

Specifies which Service element the Host should nest under. Valid options: a string containing the name attribute of the Service. Default: 'Catalina'.

#####server_config

Specifies a server.xml file to manage. Valid options: a string containing an absolute path. Default: '${catalina_base}/config/server.xml'.

####tomcat::config::server::listener

#####additional_attributes

Specifies any further attributes to add to the Listener. Valid options: a hash of '< attribute >' => '< value >' pairs. Default: {}.

#####attributes_to_remove

Specifies any attributes to remove from the Listener. Valid options: a hash of '< attribute >' => '< value >' pairs. Default: [].

#####catalina_base

Specifies the base directory of the Tomcat installation. Valid options: a string containing an absolute path. Default: $::tomcat::catalina_home.

#####class_name

Specifies the Java class name of a server implementation to use. Maps to the className XML attribute of a Listener Element. Valid options: a string containing a Java class name. Default: $name.

#####listener_ensure

Specifies whether the Listener XML element should exist in the configuration file. Valid options: 'true', 'false', 'present', and 'absent'. Default: 'present'.

#####parent_engine

Specifies which Engine element this Listener should nest under. Valid options: a string containing the name attribute of the Engine. Default: undef.

#####parent_host

Specifies which Host element this Listener should nest under. Valid options: a string containing the name attribute of the Host. Default: undef.

#####parent_service

Specifies which Service element the Listener should nest under. Only valid if parent_engine or parent_host is specified. Valid options: a string containing the name attribute of the Service. Default: 'Catalina'.

#####server_config

Specifies a server.xml file to manage. Valid options: a string containing an absolute path. Default: '${catalina_base}/config/server.xml'.

####tomcat::config::server::realm

#####additional_attributes

Specifies any further attributes to add to the Realm element. Valid options: a hash of '< attribute >' => '< value >' pairs. Default: {}.

#####attributes_to_remove

Specifies any attributes to remove from the Realm element. Valid options: an array of '< attribute >' => '< value >' pairs. Default: [].

#####catalina_base

Specifies the base directory of the Tomcat installation. Default: $::tomcat::catalina_home.

#####class_name

Specifies the Java class name of a Realm implementation to use. Maps to the className XML attribute. Valid options: a string containing a Java class name. Default: the '[name]' passed in your define.

#####parent_engine

Specifies which Engine element this Realm should nest under. Valid options: a string containing the name attribute of the Engine. Default: 'Catalina'.

#####parent_host

Specifies which Host element this Realm should nest under. Valid options: a string containing the name attribute of the Host. Default: undef.

#####parent_realm

Specifies which Realm element this Realm should nest under. Valid options: a string containing the className attribute of the Realm element. Default: undef.

#####parent_service

Specifies which Service element this Realm element should nest under. Valid options: a string containing the name attribute of the Service. Default: 'Catalina'.

#####purge_realms

Specifies whether to purge any unmanaged Realm elements from the configuration file. Valid options: 'true' and 'false'. Default: 'false'.

#####realm_ensure

Specifies whether the Realm element should exist in the configuration file. Valid options: 'true', 'false', 'present', and 'absent'. Default: 'present'.

#####server_config

Specifies a server.xml file to manage. Valid options: a string containing an absolute path. Default: '${catalina_base}/config/server.xml'.

####tomcat::config::server::service

#####catalina_base

Specifies the base directory of the Tomcat installation. Valid options: a string containing an absolute path. Default: $::tomcat::catalina_home.

#####class_name

Specifies the Java class name of a server implementation to use. Maps to the className XML attribute. Valid options: a string containing a Java class name. Default: undef.

#####class_name_ensure

Specifies whether the className XML attribute should exist in the configuration file. Valid options: 'true', 'false', 'present', and 'absent'. Default: 'present'.

#####server_config

Specifies a server.xml file to manage. Valid options: a string containing an absolute path. Default: '${catalina_base}/config/server.xml'.

#####service_ensure

Specifies whether the Service element should exist in the configuration file. Valid options: 'true', 'false', 'present', and 'absent'. Default: 'present'.

####tomcat::config::server::tomcat_users

#####catalina_base

Specifies the base directory of the Tomcat installation. Valid options: a string containing an absolute path. Default: $::tomcat::catalina_home.

#####element

Specifies the type of element to manage. Valid options: 'user' or 'role'. Default: 'user'.

#####element_name

Sets the element's username (or rolename, if element is set to 'role'). Valid options: a string. Default: $name.

#####ensure

Determines whether the specified XML element should exist in the configuration file. Valid options: 'true', 'false', 'present', and 'absent'. Default: 'present'.

#####file

Specifies the configuration file to manage. Valid options: a string containing a fully-qualified path. Default: '$CATALINA_BASE/conf/tomcat-users.xml'.

#####manage_file

Specifies whether to create the specified configuration file if it doesn't exist. Uses Puppet's native file resource type with default parameters. Valid options: 'true' and 'false'. Default: 'true'.

#####password

Specifies a password for user elements. Valid options: a string. Default: undef.

#####roles

Specifies one or more roles. Only valid if element is set to 'role'. Valid options: an array of strings. Default: [].

####tomcat::config::server::valve

#####additional_attributes

Specifies any further attributes to add to the Valve. Valid options: a hash of '< attribute >' => '< value >' pairs. Default: {}.

#####attributes_to_remove

Specifies any attributes to remove from the Valve. Valid options: a hash of '< attribute >' => '< value >' pairs. Default: [].

#####catalina_base

Specifies the base directory of the Tomcat installation. Valid options: a string containing an absolute path. Default: $::tomcat::catalina_home.

#####class_name

Specifies the Java class name of a server implementation to use. Maps to the className XML attribute. Valid options: a string containing a Java class name. Default: the '[name]' passed in your define.

#####parent_host

Specifies which virtual host the Valve should nest under. Valid options: a string containing the name of a Host element. Default: If you don't specify a host, the Valve element nests under the Engine of your specified parent Service.

#####parent_service

Specifies which Service element the Valve should nest under. Valid options: a string containing the name of a Service element. Default: 'Catalina'.

#####server_config

Specifies a server.xml file to manage. Valid options: a string containing an absolute path. Default: '${catalina_base}/config/server.xml'.

#####valve_ensure

Specifies whether the Valve should exist in the configuration file. Maps to the Valve XML element. Valid options: 'true', 'false', 'present', and 'absent'. Default: 'present'.

####tomcat::instance

#####catalina_base

Specifies the base directory of the Tomcat installation. Only affects the instance installation if install_from_source is set to 'true'. Valid options: a string containing an absolute path. Default: $::tomcat::catalina_home.

#####catalina_home

Specifies the root directory of the Tomcat installation. Only affects the instance installation if install_from_source is set to 'true'. Valid options: a string containing an absolute path. Default: $::tomcat::catalina_home.

#####install_from_source

Specifies whether to install from source. If set to 'false', installation is driven by the package_ensure and package_name parameters. Valid options: 'true' and 'false'. Default: 'true'.

#####package_ensure

Determines whether the specified package should be installed. Only valid if install_from_source is set to 'false'. Maps to the ensure parameter of Puppet's native package resource type. Valid options: 'true', 'false', 'present', and 'absent'. Default: 'present'.

#####package_name

Required if install_from_source is set to 'false'. Specifies the package to install. Valid options: a string containing a valid package name.

#####package_options

Unused if install_from_source is set to 'true'. Specify additional options to use on the generated package resource. See the documentation of the package resource type for possible values.

#####source_strip_first_dir

Specifies whether to strip the topmost directory of the tarball when unpacking it. Only valid if install_from_source is set to 'true'. Valid options: 'true' and 'false'. Default: 'true'.

#####source_url

Required if install_from_source is set to 'true'. Specifies the source URL to install from. Valid options: a string containing a puppet://, http(s)://, or ftp:// URL.

####tomcat::service

#####catalina_base

Specifies the base directory of the Tomcat installation. Valid options: a string containing an absolute path. Default: $::tomcat::catalina_home.

#####catalina_home

Specifies the root directory of the Tomcat installation. Valid options: a string containing an absolute path. Default: $::tomcat::catalina_home.

#####java_home

Specifies where Java is installed. Only applies if use_jsvc is set to 'true'. Valid options: a string containing an absolute path. Default: undef. Note: if you don't specify a home path in this parameter, Puppet does not pass the -home switch to Tomcat. That can cause problems on some systems, so we recommend including this parameter.

#####service_enable

Specifies whether to enable the Tomcat service at boot. Only valid if use_init is set to 'true'. Valid options: 'true' and 'false'. Default: 'true', if use_init is set to 'true' and service_ensure is set to 'running' or 'true'.

#####service_ensure

Specifies whether the Tomcat service should be running. Maps to the ensure parameter of Puppet's native service resource type. Valid options: 'running', 'stopped', 'true', and 'false'. Default: 'present'.

#####service_name

Required if use_init is set to 'true'. Specifies the name of the Tomcat service. Valid options: a string.

#####start_command

Designates a command to start the service. Valid options: a string. Default: determined by the values of use_init and use_jsvc.

#####stop_command

Designates a command to stop the service. Valid options: a string. Default: determined by the values of use_init and use_jsvc.

#####use_init

Specifies whether to use a package-provided init script for service management. Note that the tomcat module does not supply an init script. If both use_jsvc and use_init are set to 'false', tomcat uses the following commands for service management:

$CATALINA_BASE/bin/catalina.sh start
$CATALINA_BASE/bin/catalina.sh stop

Valid options: 'true' and 'false'. Default: 'false'.

#####use_jsvc

Specifies whether to use Jsvc for service management. If both use_jsvc and use_init are set to 'false', tomcat uses the following commands for service management:

$CATALINA_BASE/bin/catalina.sh start
$CATALINA_BASE/bin/catalina.sh stop

Valid options: 'true' and 'false'. Default: 'false'.

####tomcat::setenv::entry

#####base_path

Deprecated. Please use config_file instead.

#####config_file

Specifies the configuration file to edit. Valid options: a string containing an absolute path. Default: $'::tomcat::catalina_home/bin/setenv.sh'.

#####ensure

Determines whether the fragment should exist in the configuration file. Valid options: 'present', 'absent'. Default: 'present'.

#####order

Determines the ordering of your parameters in the configuration file (parameters with lower order values appear first.) Valid options: an integer or a string containing an integer. Default: '10'.

#####param

Specifies a parameter to manage. Valid options: a string. Default: the '[name]' passed in your define.

#####quote_char

Specifies a character to include before and after the specified value. Valid options: a string (usually a single or double quote). Default: (blank).

#####value

Required. Provides the value(s) of the managed parameter. Valid options: a string or an array. If passing an array, separate values with a single space.

####tomcat::war

#####app_base

Specifies where to deploy the WAR. Cannot be used in combination with deployment_path. Valid options: a string containing a path relative to $CATALINA_BASE. Default: If you don't specify an app_base, Puppet deploys the WAR to your specified deployment_path. If you don't specify that either, the WAR deploys to '${catalina_base}/webapps'.

#####catalina_base

Specifies the base directory of the Tomcat installation. Valid options: a string containing an absolute path. Default: $::tomcat::catalina_home.

#####deployment_path

Specifies where to deploy the WAR. Cannot be used in combination with app_base. Valid options: a string containing an absolute path. Default: If you don't specify a deployment_path, Puppet deploys the WAR to your specified app_base. If you don't specify that either, the WAR deploys to '${catalina_base}/webapps'.

#####war_ensure

Specifies whether the WAR should exist. Valid options: 'true', 'false', 'present', and 'absent'. Default: 'present'.

#####war_name

Specifies the name of the WAR. Valid options: a string containing a filename that ends in '.war'. Default: the '[name]' passed in your define.

#####war_purge

Specifies whether to purge the exploded WAR directory. Only applicable when war_ensure is set to 'absent' or 'false'.

Note: Setting this parameter to 'false' does not prevent Tomcat from removing the exploded WAR directory if Tomcat is running and autoDeploy is set to 'true'. Valid options: 'true' and 'false'. Default: 'true'.

#####war_source

Required unless war_ensure is set to 'false' or 'absent'. Specifies the source to deploy the WAR from. Valid options: a string containing a puppet://, http(s)://, or ftp:// URL.

##Limitations

This module only supports Tomcat installations on *nix systems. The tomcat::config::server* defines require Augeas version 1.0.0 or newer.

###Multiple Instances

Some Tomcat packages do not let you install more than one instance. You can avoid this limitation by installing Tomcat from source.

##Development

Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can't access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.

We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

For more information, see our module contribution guide.

###Contributors

To see who's already involved, see the list of contributors.

###Running tests

This project contains tests for both rspec-puppet and beaker-rspec to verify functionality. For in-depth information, please see their respective documentation.

Quickstart:

gem install bundler
bundle install
bundle exec rake spec
bundle exec rspec spec/acceptance
RS_DEBUG=yes bundle exec rspec spec/acceptance

Supported Release 1.4.1

###Summary

Small release for bug with multiple Realms in the same parent path.

Features

Improved documentation for purging connectors.
Improved documentation for purging realms.
Added package_options to tomcat::instance

Bugfixes

Fixed bug where multiple Realms in the same parent would corrupt data.
Added work-around for Augeas bug when purging Realms.

Supported Release 1.3.3

###Summary

Small release for support of newer PE versions. This increments the version of PE in the metadata.json file.

2015-08-11 - Supported Release 1.3.2

Summary

This release fixes username quoting and metadata.

Bugfixes

Allow username values that contain non-string characters like whitespace
Validate $catalina_base
Correct pe/puppet compatibility metadata

2015-07-16 - Supported Release 1.3.1

Summary

This release fixes metadata because it supports puppet 4.

2015-06-09 - Supported Release 1.3.0

Summary

This is a feature release, with a couple of bugfixes and readme changes.

Features

Update additional_attributes to support values with spaces
Documentation changes
Add a manifest for Context Containers in Tomcat configuration
Manage User and Roles in Realms
New manifests for context.xml configuration
Added manifest for managing Realm elements in server.xml
Ordering of setenv entries
Adds parameter for enabling Tomcat service on boot
Add ability to specify server_config location
Allow configuration of location of server.xml

Bugfixes

Make sure setenv entries have export
Test improvements
version pinning for acceptance tests

2014-11-11 - Supported Release 1.2.0

Summary

This is primarily a feature release, with a couple of bugfixes for tests and metadata.

Features

Add install_from_source parameter to class tomcat
Add purge_connectors parameter to class tomcat and define tomcat::server::connector

Bugfixes

Fix dependencies to remove missing dependency warnings with the PMT
Use curl -k in the tests

2014-10-28 - Supported Release 1.1.0

Summary

This release includes documentation and test updates, strict variable support, metadata bugs, and added support for multiple connectors with the same protocol.

Features

Strict variable support
Support multiple connectors with the same protocol
Update tests to not break when tomcat releases happen
Update README based on QA feedback

Bugfixes

Update stdlib requirement to 4.2.0
Fix illegal version range in metadata.json
Fix typo in README

2014-09-04 - Supported Release 1.0.1

Summary

This is a bugfix release.

Bugfixes

Fix typo in tomcat::instance
Update acceptance tests for new tomcat releases

2014-08-27 - Supported Release 1.0.0

Summary

This release has added support for installation from packages, improved WAR management, and updates to testing and documentation.

Features

Updated tomcat::setenv::entry to better support installations from package
Added the ability to purge auto-exploded WAR directories when removing WARs. Defaults to purging these directories
Added warnings for unused variables when installing from package
Updated acceptance tests and nodesets
Updated README

Deprecations

$tomcat::setenv::entry::base_path is being deprecated in favor of $tomcat::setenv::entry::config_file

2014-08-20 - Release 0.1.2

Summary

This release adds compatibility information and updates the README with information on the requirement of augeas >= 1.0.0.

2014-08-14 - Release 0.1.1

Summary

This is a bugfix release.

Bugfixes

Update 'warn' to correct 'warning' function.
Update README for use_init.
Test updates and fixes.

2014-08-06 - Release 0.1.0

Summary

Initial release of the tomcat module.

Copyright (C) 2012 Puppet Labs Inc

Puppet Labs can be contacted at: info@puppetlabs.com

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Modules

Discover

Contribute

Puppet

Premium features

Downloads

Resources

About Forge

Getting Started

tomcat

Version information

This version is compatible with:

Start using this module

Documentation

Supported Release 1.4.1

Features

Bugfixes

Supported Release 1.3.3

2015-08-11 - Supported Release 1.3.2

Summary

Bugfixes

2015-07-16 - Supported Release 1.3.1

Summary

2015-06-09 - Supported Release 1.3.0

Summary

Features

Bugfixes

2014-11-11 - Supported Release 1.2.0

Summary

Features

Bugfixes

2014-10-28 - Supported Release 1.1.0

Summary

Features

Bugfixes

2014-09-04 - Supported Release 1.0.1

Summary

Bugfixes

2014-08-27 - Supported Release 1.0.0

Summary

Features

Deprecations

2014-08-20 - Release 0.1.2

Summary

2014-08-14 - Release 0.1.1

Summary

Bugfixes

2014-08-06 - Release 0.1.0

Summary

Dependencies