Version information
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, 2021.2.x, 2021.1.x, 2021.0.x
- Puppet >= 7.0.0 < 9.0.0
- , , , , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'puppetlabs-tomcat', '7.2.0'Learn more about managing modules with a PuppetfileDocumentation
tomcat
Table of Contents
- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started 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.
- License
- 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
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 source and start the service:
tomcat::install { '/opt/tomcat':
source_url => 'https://www-us.apache.org/dist/tomcat/tomcat-8/v8.0.x/bin/apache-tomcat-8.0.x.tar.gz',
}
tomcat::instance { 'default':
catalina_home => '/opt/tomcat',
}
Note: look up the correct version you want to install on the version list.
Usage
I want to run multiple instances of multiple versions of Tomcat
class { 'java': }
tomcat::install { '/opt/tomcat9':
source_url => 'https://www.apache.org/dist/tomcat/tomcat-9/v9.0.x/bin/apache-tomcat-9.0.x.tar.gz'
}
tomcat::instance { 'tomcat9-first':
catalina_home => '/opt/tomcat9',
catalina_base => '/opt/tomcat9/first',
}
tomcat::instance { 'tomcat9-second':
catalina_home => '/opt/tomcat9',
catalina_base => '/opt/tomcat9/second',
}
# Change the default port of the second instance server and HTTP connector
tomcat::config::server { 'tomcat9-second':
catalina_base => '/opt/tomcat9/second',
port => '8006',
}
tomcat::config::server::connector { 'tomcat9-second-http':
catalina_base => '/opt/tomcat9/second',
port => '8081',
protocol => 'HTTP/1.1',
additional_attributes => {
'redirectPort' => '8443'
},
}
Note: look up the correct version you want to install on the version list.
I want to upgrade the version of Tomcat to use
See information about running multiple versions above. Instead of upgrading in-place, install a second version to a new directory and then point the catalina_home of your instance to it. This gives you the ability to validate and rollback if needed. After validation, you may remove the older instance if you'd like. The links can be updated in order to match programmer preferences:
class { 'java': }
tomcat::install { '/opt/tomcat/9.0.24':
source_url => 'https://archive.apache.org/dist/tomcat/tomcat-9/v9.0.24/bin/apache-tomcat-9.0.24.tar.gz'
}
tomcat::install { '/opt/tomcat/9.0.44':
source_url => 'https://www-us.apache.org/dist/tomcat/tomcat-9/v9.0.46/bin/apache-tomcat-9.0.46.tar.gz'
}
tomcat::instance { 'my_tomcat_app':
# catalina_home => '/opt/tomcat/9.0.24',
catalina_home => '/opt/tomcat/9.0.46',
catalina_base => '/opt/my_tomcat_app',
}
I want to configure SSL and specify which protocols and ciphers to use
file { $keystore_path:
ensure => present,
source => $keystore_source,
owner => $keystore_user,
mode => '0400',
checksum => 'md5',
checksum_value => $keystore_checksum,
} ->
tomcat::config::server::connector { "${tomcat_instance}-https":
catalina_base => $catalina_base,
port => $https_port,
protocol => $http_version,
purge_connectors => true,
additional_attributes => {
'SSLEnabled' => bool2str($https_enabled),
'maxThreads' => $https_connector_max_threads,
'scheme' => $https_connector_scheme,
'secure' => bool2str($https_connector_secure),
'clientAuth' => bool2str($https_connector_client_auth),
'sslProtocol' => $https_connector_ssl_protocol,
'sslEnabledProtocols' => join($https_connector_ssl_protocols_enabled, ","),
'ciphers' => join($ciphers_enabled, ","),
'keystorePass' => $keystore_pass.unwrap,
'keystoreFile' => $keystore_path,
},
}
See also: SSL/TLS Configuration HOW-TO
I want to deploy WAR files
Add the following to any existing installation with your own war source:
tomcat::war { 'sample.war':
catalina_base => '/opt/tomcat9/first',
war_source => '/opt/tomcat9/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 remove some configuration
Different configuration defined types will allow an ensure parameter to be passed, though the name may vary based on the defined type.
To remove a connector, for instance, the following configuration ensure that it is absent:
tomcat::config::server::connector { 'tomcat9-jsvc':
connector_ensure => 'absent',
catalina_base => '/opt/tomcat9/first',
port => '8080',
protocol => 'HTTP/1.1',
}
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
See REFERENCE.md
Limitations
For an extensive list of supported operating systems, see metadata.json
The tomcat::config::server* defined types 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.
License
This codebase is licensed under the Apache2.0 licensing, however due to the nature of the codebase the open source dependencies may also use a combination of AGPL, BSD-2, BSD-3, GPL2.0, LGPL, MIT and MPL Licensing.
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
Reference
Table of Contents
Classes
tomcat: Class to manage installation and configuration of Tomcat.
Defined types
Public Defined types
tomcat::config::context: Configure attributes for the Context element in $CATALINA_BASE/conf/context.xmltomcat::config::context::environment: Configure Environment elements in $CATALINA_BASE/conf/context.xmltomcat::config::context::manager: Configure Manager elements in $CATALINA_BASE/conf/context.xmltomcat::config::context::parameter: Configure Parameter elements in $CATALINA_BASE/conf/context.xml.tomcat::config::context::resource: Configure Resource elements in $CATALINA_BASE/conf/context.xmltomcat::config::context::resourcelink: Configure a ResourceLink element in the designated xml config.tomcat::config::context::resources: Configure Resources elements in $CATALINA_BASE/conf/context.xmltomcat::config::context::valve: Specifies Valve elements in${catalina_base}/conf/context.xmltomcat::config::properties::property: Manage additional entries for the properties file, typically catalina.propertiestomcat::config::server: Configure attributes for the Server element in $CATALINA_BASE/conf/server.xmltomcat::config::server::connector: Configure Connector elements in $CATALINA_BASE/conf/server.xmltomcat::config::server::context: Configure a Context element in $CATALINA_BASE/conf/server.xmltomcat::config::server::engine: Configure Engine elements in $CATALINA_BASE/conf/server.xmltomcat::config::server::globalnamingresource: Configure GlobalNamingResources Resource elements in $CATALINA_BASE/conf/server.xmltomcat::config::server::host: Configure Host elements in $CATALINA_BASE/conf/server.xmltomcat::config::server::listener: Configure Listener elements in $CATALINA_BASE/conf/server.xmltomcat::config::server::realm: Configure Realm elements in $CATALINA_BASE/conf/server.xmltomcat::config::server::resources: Configure Resources elements in $CATALINA_BASE/conf/server.xmltomcat::config::server::service: Configure a Service element nested in the Server element in $CATALINA_BASE/conf/server.xmltomcat::config::server::tomcat_users: Configures roles and users in $CATALINA_BASE/conf/tomcat-users.xml or any other specified filetomcat::config::server::valve: Configure a Valve element in $CATALINA_BASE/conf/server.xmltomcat::install: Configure and manage the tomcat installationtomcat::instance: This define installs an instance of Tomcat.tomcat::service: Service management for Tomcat.tomcat::setenv::entry: This define adds an entry to the setenv.sh script.tomcat::war: Manage deployment of WAR files.
Private Defined types
tomcat::config::properties: Manage the catalina.properties filetomcat::install::package: Private define to install Tomcat from a package.tomcat::install::source: Private define to install Tomcat from source.tomcat::instance::copy_from_home: Private define to copy a conf file from catalina_home to catalina_basetomcat::instance::dependencies
Functions
tomcat::change: This function exists for usage of a returning the input params that is a deferred function Will be used for deferring the values at agent lev
Classes
tomcat
Class to manage installation and configuration of Tomcat.
Parameters
The following parameters are available in the tomcat class:
catalina_homeusergrouppurge_connectorspurge_realmsmanage_usermanage_groupmanage_homemanage_basemanage_properties
catalina_home
Data type: String
Specifies the default root directory of the Tomcat installation. Valid options: a string containing an absolute path.
Default value: '/opt/apache-tomcat'
user
Data type: String[1]
Specifies a default user to run Tomcat as. Valid options: a string containing a valid username.
Default value: 'tomcat'
group
Data type: String[1]
Specifies a default group to run Tomcat as. Valid options: a string containing a valid group name.
Default value: 'tomcat'
purge_connectors
Data type: Boolean
Specifies whether to purge any unmanaged Connector elements that match defined protocol but have a different port from the configuration file by default.
Default value: false
purge_realms
Data type: Boolean
Specifies whether to purge any unmanaged realm elements from the configuration file by default. 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.
Default value: false
manage_user
Data type: Boolean
Determines whether defined types should default to creating the specified user, if it doesn't exist. Uses Puppet's native user with default parameters.
Default value: true
manage_group
Data type: Boolean
Determines whether defined types should default to creating the specified group, if it doesn't exist. Uses Puppet's native group with default parameters.
Default value: true
manage_home
Data type: Boolean
Specifies the default value of manage_home for all tomcat::instance instances.
Default value: true
manage_base
Data type: Boolean
Specifies the default value of manage_base for all tomcat::install instances.
Default value: true
manage_properties
Data type: Boolean
Specifies the default value of manage_properties for all tomcat::instance instances.
Default value: true
Defined types
tomcat::config::context
Configure attributes for the Context element in $CATALINA_BASE/conf/context.xml
Parameters
The following parameters are available in the tomcat::config::context defined type:
catalina_base
Data type: Optional[Stdlib::Absolutepath]
Specifies the root of the Tomcat installation.
Default value: undef
additional_attributes
Data type: Hash
Specifies any additional attributes to add to the Context. Should be a hash of the format 'attribute' => 'value'. Optional
Default value: {}
attributes_to_remove
Data type: Array
Specifies an array of attributes to remove from the element. Valid options: an array of strings. [].
Default value: []
show_diff
Data type: Boolean
Specifies display differences when augeas changes files, defaulting to true. Valid options: true or false.
Default value: true
tomcat::config::context::environment
Configure Environment elements in $CATALINA_BASE/conf/context.xml
Parameters
The following parameters are available in the tomcat::config::context::environment defined type:
ensurecatalina_baseenvironment_namenametypevaluedescriptionoverrideadditional_attributesattributes_to_removeshow_diff
ensure
Data type: Enum['present','absent']
Specifies whether you are trying to add or remove the Environment element Valid options: 'present', 'absent'.
Default value: 'present'
catalina_base
Data type: Stdlib::Absolutepath
Specifies the root of the Tomcat installation.
Default value: $tomcat::catalina_home
environment_name
Data type: String[1]
The name of the Environment Entry to be created, relative to the java:comp/env context. $name.
Default value: $name
name
$environment_name
type
Data type: Optional[String[1]]
The fully qualified Java class name expected by the web application for this environment entry. Required to create the environment entry.
Default value: undef
value
Data type: Optional[String[1]]
The value that will be presented to the application when requested from the JNDI context. Required to create the environment entry.
Default value: undef
description
Data type: Optional[String[1]]
The description is an an optional string for a human-readable description of this environment entry.
Default value: undef
override
Data type: Optional[Boolean]
An optional string or Boolean to specify if you do not want an <env-entry> for the same environment entry name to override the value specified here (set it to false). By default, overrides are allowed.
Default value: undef
additional_attributes
Data type: Hash
Specifies any additional attributes to add to the Environment. Should be a hash of the format 'attribute' => 'value'.
Default value: {}
attributes_to_remove
Data type: Array
Specifies an array of attributes to remove from the element. Valid options: an array of strings.
Default value: []
show_diff
Data type: Boolean
Specifies display differences when augeas changes files, defaulting to true. Valid options: true or false.
Default value: true
tomcat::config::context::manager
Configure Manager elements in $CATALINA_BASE/conf/context.xml
Parameters
The following parameters are available in the tomcat::config::context::manager defined type:
ensure
Data type: Enum['present','absent']
specifies whether you are trying to add or remove the Manager element.
Default value: 'present'
catalina_base
Data type: Stdlib::Absolutepath
Specifies the root of the Tomcat installation.
Default value: $tomcat::catalina_home
manager_classname
Data type: String[1]
The name of the Manager to be created. $name.
Default value: $name
name
$manager_classname
additional_attributes
Data type: Hash
Specifies any additional attributes to add to the Manager. Should be a hash of the format 'attribute' => 'value'. Optional
Default value: {}
attributes_to_remove
Data type: Array
Specifies an array of attributes to remove from the element. Valid options: an array of strings. [].
Default value: []
show_diff
Data type: Boolean
Specifies display differences when augeas changes files, defaulting to true. Valid options: true or false.
Default value: true
tomcat::config::context::parameter
Configure Parameter elements in $CATALINA_BASE/conf/context.xml.
Parameters
The following parameters are available in the tomcat::config::context::parameter defined type:
ensure
Data type: Enum['present', 'absent']
Specifies whether you are trying to add or remove the Parameter element Valid options: 'present', 'absent'.
Default value: 'present'
catalina_base
Data type: Stdlib::Absolutepath
Specifies the root of the Tomcat installation.
Default value: $tomcat::catalina_home
parameter_name
Data type: String[1]
The name of the Parameter entry to be created, relative to the java:comp/env context. $name.
Default value: $name
value
Data type: Optional[String[1]]
The value that will be presented to the application when requested from the JNDI context.
Default value: undef
description
Data type: Optional[String[1]]
The description is an an optional string for a human-readable description of this Parameter entry.
Default value: undef
override
Data type: Optional[Boolean]
An optional string or Boolean to specify whether you want an <env-entry> for the same Parameter entry name to override the value
specified here (set it to false). By default, overrides are allowed.
Default value: undef
tomcat::config::context::resource
Configure Resource elements in $CATALINA_BASE/conf/context.xml
Parameters
The following parameters are available in the tomcat::config::context::resource defined type:
ensureresource_namenameresource_typecatalina_baseadditional_attributesattributes_to_removeshow_diff
ensure
Data type: Enum['present','absent']
Specifies whether you are trying to add or remove the Resource element.
Default value: 'present'
resource_name
Data type: String[1]
The name of the Resource to be created, relative to the java:comp/env context. $name.
Default value: $name
name
$resource_name
resource_type
Data type: Optional[String[1]]
The fully qualified Java class name expected by the web application when it performs a lookup for this resource. Required to create the resource.
Default value: undef
catalina_base
Data type: Stdlib::Absolutepath
Specifies the root of the Tomcat installation.
Default value: $tomcat::catalina_home
additional_attributes
Data type: Hash
Specifies any additional attributes to add to the Valve. Should be a hash of the format 'attribute' => 'value'. Optional
Default value: {}
attributes_to_remove
Data type: Array
Specifies an array of attributes to remove from the element. Valid options: an array of strings. [].
Default value: []
show_diff
Data type: Boolean
Specifies display differences when augeas changes files, defaulting to true. Valid options: true or false.
Default value: true
tomcat::config::context::resourcelink
Configure a ResourceLink element in the designated xml config.
Parameters
The following parameters are available in the tomcat::config::context::resourcelink defined type:
ensurecatalina_baseresourcelink_namenameresourcelink_typeadditional_attributesattributes_to_removeshow_diff
ensure
Data type: Enum['present','absent']
specifies whether you are trying to add or remove the ResourceLink element.
Default value: 'present'
catalina_base
Data type: Stdlib::Absolutepath
Specifies the root of the Tomcat installation. $tomcat::catalina_home.
Default value: $tomcat::catalina_home
resourcelink_name
Data type: String[1]
The name of the ResourceLink to be created, relative to the java:comp/env context. $name.
Default value: $name
name
$resourcelink_name
resourcelink_type
Data type: Optional[String[1]]
The fully qualified Java class name expected by the web application when it performs a lookup for this resource link.
Default value: undef
additional_attributes
Data type: Hash
Specifies any additional attributes to add to the Valve. Should be a hash of the format 'attribute' => 'value'. Optional
Default value: {}
attributes_to_remove
Data type: Array
Specifies an array of attributes to remove from the element. Valid options: an array of strings. [].
Default value: []
show_diff
Data type: Boolean
Specifies display differences when augeas changes files, defaulting to true. Valid options: true or false.
Default value: true
tomcat::config::context::resources
Configure Resources elements in $CATALINA_BASE/conf/context.xml
Parameters
The following parameters are available in the tomcat::config::context::resources defined type:
ensure
Data type: Enum['present','absent']
Specifies whether you are trying to add or remove the Resources element.
Default value: 'present'
catalina_base
Data type: Stdlib::Absolutepath
Specifies the root of the Tomcat installation.
Default value: $tomcat::catalina_home
additional_attributes
Data type: Hash
Specifies any additional attributes to add to the Valve. Should be a hash of the format 'attribute' => 'value'. Optional
Default value: {}
attributes_to_remove
Data type: Array
Specifies an array of attributes to remove from the element. Valid options: an array of strings. [].
Default value: []
show_diff
Data type: Boolean
Specifies display differences when augeas changes files, defaulting to true. Valid options: true or false.
Default value: true
tomcat::config::context::valve
Specifies Valve elements in ${catalina_base}/conf/context.xml
Parameters
The following parameters are available in the tomcat::config::context::valve defined type:
ensureresource_nameresource_typeclass_namecatalina_baseadditional_attributesattributes_to_removeuniqueness_attributesshow_diff
ensure
Data type: Enum['present','absent']
Specifies whether you are trying to add or remove the Valve element.
Default value: 'present'
resource_name
Data type: Optional[String[1]]
Deprecated! Use uniqueness_attributes.
The name of the Resource to be created. Default: $name if resource_type is used.
Using this parameter will add an extra name attribute on the valve element.
As Tomcat allows multiple valves of the same className, this parameter has been used to create
unique representations of each element.
Adding a name attribute to a valve produces a warning in tomcat during load.
Default value: undef
resource_type
Data type: Optional[String[1]]
Deprecated! Use class_name
Java class name of the implementation to use.
Default value: undef
class_name
Data type: Optional[String[1]]
Java class name of the implementation to use. Default: $name if resource_type is not used.
Default value: undef
catalina_base
Data type: Stdlib::Absolutepath
Specifies the root of the Tomcat installation. Default: $tomcat::catalina_home
Default value: $tomcat::catalina_home
additional_attributes
Data type: Hash
Specifies any further attributes to add to the Valve. Valid options: a hash of '< attribute >' => '< value >' pairs. {}.
Default value: {}
attributes_to_remove
Data type: Array
Specifies an array of attributes to remove from the element. Valid options: an array of strings. [].
Default value: []
uniqueness_attributes
Data type: Array
Specifies an array of attribute names that Puppet use to uniquely idetify valves. Valid options: an array of strings. ['className'].
Default value: []
show_diff
Data type: Boolean
Specifies display differences when augeas changes files, defaulting to true. Valid options: true or false.
Default value: true
tomcat::config::properties::property
Manage additional entries for the properties file, typically catalina.properties
Parameters
The following parameters are available in the tomcat::config::properties::property defined type:
catalina_base
Data type: Stdlib::Absolutepath
The catalina base of the catalina.properties file. The resource will manage the values in ${catalina_base}/conf/catalina.properties . Required
value
Data type: String[1]
The value of the property. Required
property
Data type: String[1]
The name of the property. $name.
Default value: $name
tomcat::config::server
Configure attributes for the Server element in $CATALINA_BASE/conf/server.xml
Parameters
The following parameters are available in the tomcat::config::server defined type:
catalina_baseclass_nameclass_name_ensureaddressaddress_ensureportshutdownserver_configshow_diff
catalina_base
Data type: Optional[Stdlib::Absolutepath]
Specifies the base directory of the Tomcat installation to manage. Valid options: a string containing an absolute path.
Default value: undef
class_name
Data type: Optional[String[1]]
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 value: undef
class_name_ensure
Data type: Enum['present','absent']
Specifies whether the className XML attribute should exist in the configuration file.
Default value: 'present'
address
Data type: Optional[Variant[Pattern[/^localhost$/], Stdlib::IP::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 value: undef
address_ensure
Data type: Enum['present','absent']
Specifies whether the address XML attribute should exist in the configuration file.
Default value: 'present'
port
Data type: Optional[Variant[String[1], Stdlib::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 value: undef
shutdown
Data type: Optional[String[1]]
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 value: undef
server_config
Data type: Optional[Stdlib::Absolutepath]
Specifies a server.xml file to manage. Valid options: a string containing an absolute path.
Default value: undef
show_diff
Data type: Boolean
Specifies display differences when augeas changes files, defaulting to true. Valid options: true or false.
Default value: true
tomcat::config::server::connector
Configure Connector elements in $CATALINA_BASE/conf/server.xml
Parameters
The following parameters are available in the tomcat::config::server::connector defined type:
catalina_baseconnector_ensureportprotocolnameparent_serviceadditional_attributesattributes_to_removepurge_connectorsserver_configshow_diff
catalina_base
Data type: Optional[Stdlib::Absolutepath]
Specifies the base directory of the Tomcat installation to manage. Valid options: a string containing an absolute path.
Default value: undef
connector_ensure
Data type: Enum['present','absent']
Specifies whether the Connector XML element should exist in the configuration file.
Default value: 'present'
port
Data type: Optional[Variant[String[1], Stdlib::Port]]
Sets a TCP port on which to create a server socket. Maps to the port XML attribute. Valid options: a string.
Default value: undef
protocol
Data type: String[1]
Specifies a protocol to use for handling incoming traffic. Maps to the protocol XML attribute. Valid options: a string. $name.
Default value: $name
name
$protocol
parent_service
Data type: String[1]
Specifies which Service element the Connector should nest under. Valid options: a string containing the name attribute of the Service.
Default value: 'Catalina'
additional_attributes
Data type: Hash
Specifies any further attributes to add to the Connector. Valid options: a hash of '< attribute >' => '< value >' pairs.
Default value: {}
attributes_to_remove
Data type: Array
Specifies an array of attributes to remove from the element. Valid options: an array of strings.
Default value: []
purge_connectors
Data type: Optional[Boolean]
Specifies whether to purge any unmanaged Connector elements that match defined protocol but have a different port from the configuration file.
Default value: undef
server_config
Data type: Optional[Stdlib::Absolutepath]
Specifies a server.xml file to manage. Valid options: a string containing an absolute path.
Default value: undef
show_diff
Data type: Boolean
Specifies display differences when augeas changes files, defaulting to true. Valid options: true or false.
Default value: true
tomcat::config::server::context
Configure a Context element in $CATALINA_BASE/conf/server.xml
Parameters
The following parameters are available in the tomcat::config::server::context defined type:
catalina_basecontext_ensuredoc_baseparent_serviceparent_engineparent_hostadditional_attributesattributes_to_removeserver_configshow_diff
catalina_base
Data type: Optional[Stdlib::Absolutepath]
Specifies the base directory of the Tomcat installation to manage. Valid options: a string containing an absolute path.
Default value: undef
context_ensure
Data type: Enum['present','absent']
Specifies whether the Context XML element should exist in the configuration file.
Default value: 'present'
doc_base
Data type: Optional[String[1]]
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). $name.
Default value: undef
parent_service
Data type: Optional[String[1]]
Specifies which Service XML element the Context should nest under. Valid options: a string containing the name attribute of the Service.
Default value: undef
parent_engine
Data type: Optional[String[1]]
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 value: undef
parent_host
Data type: Optional[String[1]]
Specifies which Host element the Context should nest under. Valid options: a string containing the name attribute of the Host.
Default value: undef
additional_attributes
Data type: Hash
Specifies any further attributes to add to the Context. Valid options: a hash of '< attribute >' => '< value >' pairs.
Default value: {}
attributes_to_remove
Data type: Array
Specifies an array of attributes to remove from the element. Valid options: an array of strings.
Default value: []
server_config
Data type: Optional[Stdlib::Absolutepath]
Specifies a server.xml file to manage. Valid options: a string containing an absolute path.
Default value: undef
show_diff
Data type: Boolean
Specifies display differences when augeas changes files, defaulting to true. Valid options: true or false.
Default value: true
tomcat::config::server::engine
Configure Engine elements in $CATALINA_BASE/conf/server.xml
Parameters
The following parameters are available in the tomcat::config::server::engine defined type:
default_hostcatalina_basebackground_processor_delaybackground_processor_delay_ensureclass_nameclass_name_ensureengine_namejvm_routejvm_route_ensureparent_servicestart_stop_threadsstart_stop_threads_ensureserver_configshow_diff
default_host
Data type: String[1]
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.
catalina_base
Data type: Optional[Stdlib::Absolutepath]
Specifies the base directory of the Tomcat installation to manage. Valid options: a string containing an absolute path.
Default value: undef
background_processor_delay
Data type: Optional[Variant[Integer, String[1]]]
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. undef.
Default value: undef
background_processor_delay_ensure
Data type: Enum['present','absent']
Specifies whether the backgroundProcessorDelay XML attribute should exist in the configuration file.
Default value: 'present'
class_name
Data type: Optional[String[1]]
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 value: undef
class_name_ensure
Data type: Enum['present','absent']
Specifies whether the className XML attribute should exist in the configuration file.
Default value: 'present'
engine_name
Data type: Optional[String[1]]
Specifies the logical name of the Engine, used in log and error messages. Maps to the name XML attribute. Valid options: a string. name passed in your defined type.
Default value: undef
jvm_route
Data type: Optional[String[1]]
Specifies an identifier to enable session affinity in load balancing. Maps to the jvmRoute XML attribute. Valid options: string.
Default value: undef
jvm_route_ensure
Data type: Enum['present','absent']
Specifies whether the jvmRoute XML attribute should exist in the configuration file.
Default value: 'present'
parent_service
Data type: String[1]
Specifies which Service element the Engine should nest under. Valid options: a string containing the name attribute of the Service.
Default value: 'Catalina'
start_stop_threads
Data type: Optional[Variant[String[1], Integer]]
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 or an integer. Warning: Future versions of the module will deprecate Strings as a valid value and allow only Integers.
Default value: undef
start_stop_threads_ensure
Data type: Enum['present','absent']
Specifies whether the startStopThreads XML attribute should exist in the configuration file.
Default value: 'present'
server_config
Data type: Optional[Stdlib::Absolutepath]
Specifies a server.xml file to manage. Valid options: a string containing an absolute path.
Default value: undef
show_diff
Data type: Boolean
Specifies display differences when augeas changes files, defaulting to true. Valid options: true or false.
Default value: true
tomcat::config::server::globalnamingresource
Configure GlobalNamingResources Resource elements in $CATALINA_BASE/conf/server.xml
Parameters
The following parameters are available in the tomcat::config::server::globalnamingresource defined type:
catalina_baseresource_nametypeensureadditional_attributesattributes_to_removeserver_configshow_diff
catalina_base
Data type: Stdlib::Absolutepath
Specifies the base directory of the Tomcat instance. Valid options: a string containing an absolute path.
Default value: $tomcat::catalina_home
resource_name
Data type: Optional[String[1]]
Optionally override the globalnamingresource name that is normally taken from the Puppet resource's $name.
Default value: undef
type
Data type: String[1]
Specifies the type of element to create Valid options: Resource, Environment or any other valid node.
Default value: 'Resource'
ensure
Data type: Enum['present','absent']
Determines whether the specified XML element should exist in the configuration file.
Default value: 'present'
additional_attributes
Data type: Hash
Specifies any further attributes to add to the Host. Valid options: a hash of '< attribute >' => '< value >' pairs.
Default value: {}
attributes_to_remove
Data type: Array
Specifies an array of attributes to remove from the element. Valid options: an array of strings.
Default value: []
server_config
Data type: Optional[Stdlib::Absolutepath]
Specifies a server.xml file to manage. Valid options: a string containing an absolute path.
Default value: undef
show_diff
Data type: Boolean
Specifies display differences when augeas changes files, defaulting to true. Valid options: true or false.
Default value: true
tomcat::config::server::host
Configure Host elements in $CATALINA_BASE/conf/server.xml
Parameters
The following parameters are available in the tomcat::config::server::host defined type:
app_basecatalina_basehost_ensurehost_nameparent_serviceadditional_attributesattributes_to_removeserver_configaliasesshow_diff
app_base
Data type: Optional[String[1]]
Specifies the Application Base directory for the virtual host. Maps to the appBase XML attribute. Valid options: a string.
Default value: undef
catalina_base
Data type: Optional[Stdlib::Absolutepath]
Specifies the base directory of the Tomcat installation to manage. Valid options: a string containing an absolute path.
Default value: undef
host_ensure
Data type: Enum['present','absent']
Specifies whether the virtual host (the Host XML element) should exist in the configuration file.
Default value: 'present'
host_name
Data type: Optional[String[1]]
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 value: undef
parent_service
Data type: String
Specifies which Service element the Host should nest under. Valid options: a string containing the name attribute of the Service.
Default value: 'Catalina'
additional_attributes
Data type: Hash
Specifies any further attributes to add to the Host. Valid options: a hash of '< attribute >' => '< value >' pairs.
Default value: {}
attributes_to_remove
Data type: Array
Specifies an array of attributes to remove from the element. Valid options: an array of strings.
Default value: []
server_config
Data type: Optional[Stdlib::Absolutepath]
Specifies a server.xml file to manage. Valid options: a string containing an absolute path.
Default value: undef
aliases
Data type: Optional[Array]
Optional array that specifies the list of Host Name Aliases for this particular Host. If omitted, any currently-defined Aliases will not be altered. If present, the list Aliases will be set to exactly match the contents of this array. Thus, for example, an empty array can be used to explicitly force there to be no Aliases for the Host.
Default value: undef
show_diff
Data type: Boolean
Specifies display differences when augeas changes files, defaulting to true. Valid options: true or false.
Default value: true
tomcat::config::server::listener
Configure Listener elements in $CATALINA_BASE/conf/server.xml
Parameters
The following parameters are available in the tomcat::config::server::listener defined type:
catalina_baselistener_ensureclass_nameparent_serviceparent_engineparent_hostadditional_attributesattributes_to_removeserver_configshow_diff
catalina_base
Data type: Stdlib::Absolutepath
Specifies the base directory of the Tomcat installation. Valid options: a string containing an absolute path.
Default value: $tomcat::catalina_home
listener_ensure
Data type: Enum['present','absent']
Specifies whether the Listener XML element should exist in the configuration file.
Default value: 'present'
class_name
Data type: Optional[String[1]]
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. $name.
Default value: undef
parent_service
Data type: Optional[String[1]]
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 value: undef
parent_engine
Data type: Optional[String[1]]
Specifies which Engine element this Listener should nest under. Valid options: a string containing the name attribute of the Engine.
Default value: undef
parent_host
Data type: Optional[String[1]]
Specifies which Host element this Listener should nest under. Valid options: a string containing the name attribute of the Host.
Default value: undef
additional_attributes
Data type: Hash
Specifies any further attributes to add to the Listener. Valid options: a hash of '< attribute >' => '< value >' pairs.
Default value: {}
attributes_to_remove
Data type: Array
Specifies an array of attributes to remove from the element. Valid options: an array of strings.
Default value: []
server_config
Data type: Optional[Stdlib::Absolutepath]
Specifies a server.xml file to manage. Valid options: a string containing an absolute path.
Default value: undef
show_diff
Data type: Boolean
Specifies display differences when augeas changes files, defaulting to true. Valid options: true or false.
Default value: true
tomcat::config::server::realm
Configure Realm elements in $CATALINA_BASE/conf/server.xml
Parameters
The following parameters are available in the tomcat::config::server::realm defined type:
catalina_baseclass_namenamerealm_ensureparent_serviceparent_engineparent_hostparent_realmadditional_attributesattributes_to_removepurge_realmsserver_configshow_diff
catalina_base
Data type: Optional[String[1]]
Specifies the base directory of the Tomcat installation.
Default value: undef
class_name
Data type: String[1]
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. name passed in your defined type.
Default value: $name
name
$class_name
realm_ensure
Data type: Enum['present','absent']
Specifies whether the Realm element should exist in the configuration file.
Default value: 'present'
parent_service
Data type: String
Specifies which Service element this Realm element should nest under. Valid options: a string containing the name attribute of the Service.
Default value: 'Catalina'
parent_engine
Data type: String
Specifies which Engine element this Realm should nest under. Valid options: a string containing the name attribute of the Engine.
Default value: 'Catalina'
parent_host
Data type: Optional[String[1]]
Specifies which Host element this Realm should nest under. Valid options: a string containing the name attribute of the Host.
Default value: undef
parent_realm
Data type: Optional[String[1]]
Specifies which Realm element this Realm should nest under. Valid options: a string containing the className attribute of the Realm element.
Default value: undef
additional_attributes
Data type: Hash
Specifies any further attributes to add to the Realm element. Valid options: a hash of '< attribute >' => '< value >' pairs.
Default value: {}
attributes_to_remove
Data type: Array
Specifies an array of attributes to remove from the element. Valid options: an array of strings.
Default value: []
purge_realms
Data type: Optional[Boolean]
Specifies whether to purge any unmanaged Realm elements from the configuration file.
Default value: undef
server_config
Data type: Optional[Stdlib::Absolutepath]
Specifies a server.xml file to manage. Valid options: a string containing an absolute path.
Default value: undef
show_diff
Data type: Boolean
Specifies display differences when augeas changes files, defaulting to true. Valid options: true or false.
Default value: true
tomcat::config::server::resources
Configure Resources elements in $CATALINA_BASE/conf/server.xml
Parameters
The following parameters are available in the tomcat::config::server::resources defined type:
catalina_baseresources_ensureparent_serviceparent_engineparent_hostparent_contextadditional_attributesattributes_to_removeserver_configshow_diff
catalina_base
Data type: Optional[Stdlib::Absolutepath]
Specifies the base directory of the Tomcat installation to manage. Valid options: a string containing an absolute path.
Default value: undef
resources_ensure
Data type: Enum['present','absent']
Specifies whether the resources (The Resources Component) should exist in the configuration file.
Default value: 'present'
parent_service
Data type: Optional[String[1]]
Specifies which Service element the Host should nest under. Valid options: a string containing the name attribute of the Service.
Default value: undef
parent_engine
Data type: Optional[String[1]]
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 value: undef
parent_host
Data type: Optional[String[1]]
Specifies which Host element the Context should nest under. Valid options: a string containing the name attribute of the Host.
Default value: undef
parent_context
Data type: Optional[String[1]]
Specifies which Context element the Context should nest under. Valid options: a string containing the name attribute of the Context.
Default value: undef
additional_attributes
Data type: Hash
Specifies any further attributes to add to the Host. Valid options: a hash of '< attribute >' => '< value >' pairs.
Default value: {}
attributes_to_remove
Data type: Array[String[1]]
Specifies an array of attributes to remove from the element. Valid options: an array of strings.
Default value: []
server_config
Data type: Optional[Stdlib::Absolutepath]
Specifies a server.xml file to manage. Valid options: a string containing an absolute path.
Default value: undef
show_diff
Data type: Boolean
Specifies display differences when augeas changes files, defaulting to true. Valid options: true or false.
Default value: true
tomcat::config::server::service
Configure a Service element nested in the Server element in $CATALINA_BASE/conf/server.xml
Parameters
The following parameters are available in the tomcat::config::server::service defined type:
catalina_base
Data type: Optional[Stdlib::Absolutepath]
Specifies the base directory of the Tomcat installation. Valid options: a string containing an absolute path.
Default value: undef
class_name
Data type: Optional[String[1]]
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 value: undef
class_name_ensure
Data type: Enum['present','absent']
Specifies whether the className XML attribute should exist in the configuration file.
Default value: 'present'
service_ensure
Data type: Enum['present','absent']
Specifies whether the Service element should exist in the configuration file.
Default value: 'present'
server_config
Data type: Optional[Stdlib::Absolutepath]
Specifies a server.xml file to manage. Valid options: a string containing an absolute path.
Default value: undef
show_diff
Data type: Boolean
Specifies display differences when augeas changes files, defaulting to true. Valid options: true or false.
Default value: true
tomcat::config::server::tomcat_users
Configures roles and users in $CATALINA_BASE/conf/tomcat-users.xml or any other specified file
Parameters
The following parameters are available in the tomcat::config::server::tomcat_users defined type:
catalina_base
Data type: Stdlib::Absolutepath
Specifies the base directory of the Tomcat installation. Valid options: a string containing an absolute path.
Default value: $tomcat::catalina_home
element
Data type: Enum['user','role']
Specifies the type of element to manage.
Default value: 'user'
element_name
Data type: Optional[String[1]]
Sets the element's username (or rolename, if element is set to 'role'). Valid options: a string. $name.
Default value: undef
ensure
Data type: Enum['present','absent']
Determines whether the specified XML element should exist in the configuration file.
Default value: present
file
Data type: Optional[String[1]]
Specifies the configuration file to manage. Valid options: a string containing a fully-qualified path.
Default value: undef
manage_file
Data type: Boolean
Specifies whether to create the specified configuration file if it doesn't exist. Uses Puppet's native file with default parameters.
Default value: true
owner
Data type: Optional[String[1]]
Specifies the owner of the configuration file. $::tomcat::user.
Default value: undef
group
Data type: Optional[String[1]]
Specifies the group of the configuration file. $::tomcat::group.
Default value: undef
password
Data type: Optional[Variant[String, Sensitive[String]]]
Specifies a password for user elements. Valid options: a string.
Default value: undef
roles
Data type: Array
Specifies one or more roles. Only valid if element is set to 'role' or 'user'. Valid options: an array of strings.
Default value: []
show_diff
Data type: Boolean
Specifies display differences when augeas changes files, defaulting to true. Valid options: true or false.
Default value: true
tomcat::config::server::valve
Configure a Valve element in $CATALINA_BASE/conf/server.xml
Parameters
The following parameters are available in the tomcat::config::server::valve defined type:
catalina_baseclass_nameparent_hostparent_serviceparent_contextvalve_ensureadditional_attributesattributes_to_removeuniqueness_attributesserver_configshow_diff
catalina_base
Data type: Optional[Stdlib::Absolutepath]
Specifies the base directory of the Tomcat installation. Valid options: a string containing an absolute path. $::tomcat::catalina_home.
Default value: undef
class_name
Data type: Optional[String[1]]
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 value: undef
parent_host
Data type: Optional[String[1]]
Specifies which virtual host the Valve should nest under. Valid options: a string containing the name of a Host element.
Default value: undef
parent_service
Data type: String
Specifies which Service element the Valve should nest under. Valid options: a string containing the name of a Service element.
Default value: 'Catalina'
parent_context
Data type: Optional[String[1]]
Specifies which Context element the Valve should nest under. Valid options: a string containing the name of a Context element (matching the docbase attribute).
Default value: undef
valve_ensure
Data type: Enum['present','absent']
Specifies whether the Valve should exist in the configuration file. Maps to the Valve XML element.
Default value: 'present'
additional_attributes
Data type: Hash
Specifies any further attributes to add to the Valve. Valid options: a hash of '< attribute >' => '< value >' pairs.
Default value: {}
attributes_to_remove
Data type: Array
Specifies an array of attributes to remove from the element. Valid options: an array of strings.
Default value: []
uniqueness_attributes
Data type: Array
Specifies an array of attribute names that Pupet use to uniquely idetify valves. Valid options: an array of strings. ['className'].
Default value: []
server_config
Data type: Optional[Stdlib::Absolutepath]
Specifies a server.xml file to manage. Valid options: a string containing an absolute path.
Default value: undef
show_diff
Data type: Boolean
Specifies display differences when augeas changes files, defaulting to true. Valid options: true or false.
Default value: true
tomcat::install
Configure and manage the tomcat installation
Parameters
The following parameters are available in the tomcat::install defined type:
catalina_homenameinstall_from_sourcesource_urlsource_strip_first_dirproxy_typeproxy_serverallow_insecureusergroupmanage_usermanage_groupmanage_homepackage_ensurepackage_namepackage_optionsremove_default_webapps
catalina_home
Data type: Stdlib::Absolutepath
specifies the directory of the Tomcat installation from which the instance should be created. Valid options: a string containing an absolute path.
Default value: $name
name
$catalina_home
install_from_source
Data type: Boolean
Specifies whether to install from source or from a package. If set to true installation uses the source_url, source_strip_first_dir, user, group, manage_user, and manage_group parameters. If set to false installation uses the package_ensure, package_name, and package_options parameters. Valid options: Boolean. true.
Default value: true
source_url
Data type: Optional[String[1]]
In single-instance mode: Specifies the source URL to install from. Valid options: a string containing a puppet://, http(s)://, or ftp:// URL.
Default value: undef
source_strip_first_dir
Data type: Boolean
Specifies whether to strip the topmost directory of the tarball when unpacking it. Only valid if install_from_source is set to true.
Default value: true
proxy_type
Data type:
Optional[
Enum[
'none',
'http',
'https',
'ftp'
]
]
Specifies the proxy server type used by proxy_server. Normally this defaults to the protocol specified in the proxy_server URI. proxy_server. Valid options: 'none', 'http', 'https', 'ftp'.
Default value: undef
proxy_server
Data type: Optional[String[1]]
Specifies a proxy server to use when downloading Tomcat binaries. For example, 'https://example.com:8080'.
Default value: undef
allow_insecure
Data type: Boolean
Specifies if HTTPS errors should be ignored when downloading the source tarball. Valid options: Boolean.
Default value: false
user
Data type: Optional[String[1]]
Specifies the owner of the source installation directory. $::tomcat::user.
Default value: undef
group
Data type: Optional[String[1]]
Specifies the group of the source installation directory. $::tomcat::group.
Default value: undef
manage_user
Data type: Optional[Boolean]
Specifies whether the user should be managed by this module or not. $::tomcat::manage_user.
Default value: undef
manage_group
Data type: Optional[Boolean]
Specifies whether the group should be managed by this module or not. $::tomcat::manage_group.
Default value: undef
manage_home
Data type: Optional[Boolean]
Specifies whether the directory of catalina_home should be managed by puppet. This may not be preferable in network filesystem environments.
Default value: undef
package_ensure
Data type: Optional[String[1]]
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.
Default value: undef
package_name
Data type: Optional[String[1]]
Specifies the package to install. Valid options: a string containing a valid package name.
Default value: undef
package_options
Data type: Optional[Array[String[1]]]
Specify additional options to use on the generated package resource. See the documentation of the package for possible values.
Default value: undef
remove_default_webapps
Data type: Optional[Array[String[1]]]
Specifies the default webapps to be removed.
Default value: undef
tomcat::instance
This define installs an instance of Tomcat.
Parameters
The following parameters are available in the tomcat::instance defined type:
catalina_homecatalina_baseusergroupmanage_usermanage_groupmanage_servicemanage_basemanage_propertiesjava_homeuse_jsvcuse_initmanage_dirsdir_listdir_modemanage_copy_from_homecopy_from_home_listcopy_from_home_modeservice_nameinstall_from_sourcesource_urlsource_strip_first_dirpackage_ensurepackage_namepackage_options
catalina_home
Data type: Optional[String[1]]
Specifies the directory where the Apache Tomcat software is installed by a tomcat::install resource. Valid options: a string containing an absolute path.
Default value: undef
catalina_base
Data type: Optional[Stdlib::Absolutepath]
Specifies the $CATALINA_BASE of the Tomcat instance where logs, configuration files, and the 'webapps' directory are managed. For single-instance installs, this is the same as the catalina_home parameter Valid options: a string containing an absolute path. $catalina_home.
Default value: undef
user
Data type: Optional[String[1]]
Specifies the owner of the instance directories and files. $::tomcat::user.
Default value: undef
group
Data type: Optional[String[1]]
Specifies the group of the instance directories and files. $::tomcat::group.
Default value: undef
manage_user
Data type: Optional[Boolean]
Specifies whether the user should be managed by this module or not. $::tomcat::manage_user.
Default value: undef
manage_group
Data type: Optional[Boolean]
Specifies whether the group should be managed by this module or not. $::tomcat::manage_group.
Default value: undef
manage_service
Data type: Optional[Boolean]
Specifies whether a tomcat::service corresponding to this instance should be declared. Valid options: Boolean true (multi-instance installs), false ()single-instance installs).
Default value: undef
manage_base
Data type: Optional[Boolean]
Specifies whether the directory of catalina_base should be managed by Puppet. This might not be preferable in network filesystem environments. true.
Default value: undef
manage_properties
Data type: Optional[Boolean]
Specifies whether the catalina.properties file is created and managed. If true, custom modifications to this file will be overwritten during runs Valid options: Boolean true.
Default value: undef
java_home
Data type: Optional[String[1]]
Specifies the java home to be used when declaring a tomcat::service instance. See [tomcat::service](# tomcatservice)
Default value: undef
use_jsvc
Data type: Optional[Boolean]
Specifies whether jsvc should be used when declaring a tomcat::service instance.
Default value: undef
use_init
Data type: Optional[Boolean]
Specifies whether an init script should be managed when declaring a tomcat::service instance. See [tomcat::service](# tomcatservice)
Default value: undef
manage_dirs
Data type: Boolean
Determines whether subdirectories for catalina_base should be managed as part of tomcat::instance. The default directories are listed in dir_list. Valid options: Boolean.
Default value: true
dir_list
Data type: Array[String[1]]
Specifies the subdirectories under catalina_base to be managed for an instance (disabled via manage_dirs Boolean). Valid options: an array of strings, each being a relative subdirectory to catalina_base. ['bin','conf','lib','logs','temp','webapps','work'].
Default value: ['bin','conf','lib','logs','temp','webapps','work']
dir_mode
Data type: String[1]
Specifies a mode for the managed subdirectories under catalina_base for an instance (as specified in dir_list and disabled via manage_dirs Boolean). Valid option: a string containing a standard Linux mode.
Default value: '2770'
manage_copy_from_home
Data type: Boolean
Specifies whether to copy the initial config files from catalina_home to catalina_base. Valid options: Boolean. true.
Default value: true
copy_from_home_list
Data type: Optional[Variant[Array[String[1]], String[1]]]
Specifies the full path of config files to copy from catalina_home to catalina_base for an instance (disabled via manage_copy_from_home Boolean). Valid options: array of strings containing path + filename.
[ '${_catalina_base}/conf/catalina.policy',
'${_catalina_base}/conf/context.xml',
'${_catalina_base}/conf/logging.properties',
'${_catalina_base}/conf/server.xml',
'${_catalina_base}/conf/web.xml']
Default value: undef
copy_from_home_mode
Data type: String[1]
Specifies the file mode when copying the initial config files from catalina_home to catalina_base. Valid options: a string containing a standard Linux mode.
Default value: '0660'
service_name
Data type: Optional[String[1]]
Name of the service when managing the service
Default value: undef
install_from_source
Data type: Optional[Boolean]
Specifies whether or not the instance should be installed from source.
Default value: undef
source_url
Data type: Optional[String[1]]
URL to install from.
Default value: undef
source_strip_first_dir
Data type: Optional[Boolean]
Whether or not to strip the first directory when unpacking the source tarball. Defaults to true when installing from source. Requires puppet/archive.
Default value: undef
package_ensure
Data type: Optional[String[1]]
Ensure for the package resource when installing from package.
Default value: undef
package_name
Data type: Optional[String[1]]
Name of package when installing from package.
Default value: undef
package_options
Data type: Optional[Array[String[1]]]
Extra options to pass to the package resource.
Default value: undef
tomcat::service
Service management for Tomcat.
Parameters
The following parameters are available in the tomcat::service defined type:
catalina_homecatalina_baseuse_jsvcuse_initjava_homeservice_ensureservice_enableservice_namestart_commandstop_commandstatus_commanduserwait_timeout
catalina_home
Data type: Optional[String[1]]
Specifies the root directory of the Tomcat installation. Valid options: a string containing an absolute path.
Default value: undef
catalina_base
Data type: Optional[Stdlib::Absolutepath]
Specifies the base directory of the Tomcat installation. Valid options: a string containing an absolute path.
Default value: undef
use_jsvc
Data type: Boolean
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_HOME/bin/catalina.sh start
$CATALINA_HOME/bin/catalina.sh stop
Default value: false
use_init
Data type: Boolean
Specifies whether to use a package-provided init script for service management.
Default value: false
java_home
Data type: Optional[String[1]]
Specifies where Java is installed. Only applies if use_jsvc is set to true. Valid options: a string containing an absolute path.
Default value: undef
service_ensure
Data type: Enum['running', 'stopped', 'true', 'false']
Specifies whether the Tomcat service should be running. Maps to the ensure parameter of Puppet's native service. Valid options: 'running', 'stopped', true, false.
Default value: running
service_enable
Data type: Optional[Boolean]
Specifies whether to enable the Tomcat service at boot. Only valid if use_init is set to true. true, if use_init is set to true and service_ensure is set to 'running' or true.
Default value: undef
service_name
Data type: Optional[String[1]]
Specifies the name of the Tomcat service. Valid options: a string.
Default value: undef
start_command
Data type: Optional[String[1]]
Designates a command to start the service. Valid options: a string. use_init and use_jsvc.
Default value: undef
stop_command
Data type: Optional[String[1]]
Designates a command to stop the service. Valid options: a string. use_init and use_jsvc.
Default value: undef
status_command
Data type: Optional[String[1]]
Designates a command to get the status of the service. Valid options: a string. use_init and use_jsvc.
Default value: undef
user
Data type: Optional[String[1]]
The user of the jsvc process when use_init => true
Default value: undef
wait_timeout
Data type: Integer
The wait timeout set in the jsvc init script when use_init => true and use_jsvc => true
Default value: 10
tomcat::setenv::entry
This define adds an entry to the setenv.sh script.
Parameters
The following parameters are available in the tomcat::setenv::entry defined type:
value
Data type: Variant[String[1], Array[String[1]]]
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.
ensure
Data type: Enum['present', 'absent']
Determines whether the fragment should exist in the configuration file. Valid options: 'present', 'absent'.
Default value: 'present'
catalina_home
Data type: Optional[String[1]]
Root of the Tomcat installation.
Default value: undef
config_file
Data type: Optional[String[1]]
Specifies the configuration file to edit. Valid options: a string containing an absolute path.
Default value: undef
param
Data type: String[1]
Specifies a parameter to manage. Valid options: a string. name passed in your defined type.
Default value: $name
name
$param
quote_char
Data type: Optional[String[1]]
Specifies a character to include before and after the specified value. Valid options: a string (usually a single or double quote).
Default value: undef
order
Data type: Variant[String[1], Integer]
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. 10.
Default value: '10'
addto
Data type: Optional[String[1]]
Default value: undef
doexport
Data type: Boolean
Specifies if you want to append export to the entry. Valid options: Boolean
Default value: true
user
Data type: Optional[String[1]]
Specifies the owner of the config file. $::tomcat::user.
Default value: undef
group
Data type: Optional[String[1]]
Specifies the group of the config file. $::tomcat::group.
Default value: undef
tomcat::war
Manage deployment of WAR files.
Parameters
The following parameters are available in the tomcat::war defined type:
catalina_baseapp_basedeployment_pathwar_ensurewar_namewar_purgewar_sourceallow_insecureusergroup
catalina_base
Data type: Optional[Stdlib::Absolutepath]
Specifies the base directory of the Tomcat installation. Valid options: a string containing an absolute path. $::tomcat::catalina_home.
Default value: undef
app_base
Data type: Optional[String[1]]
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. 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.
Default value: undef
deployment_path
Data type: Optional[String[1]]
Specifies where to deploy the WAR. Cannot be used in combination with app_base. Valid options: a string containing an absolute path. 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.
Default value: undef
war_ensure
Data type: Enum['present','absent']
Specifies whether the WAR should exist.
Default value: 'present'
war_name
Data type: Optional[String[1]]
Specifies the name of the WAR. Valid options: a string containing a filename that ends in '.war'. name passed in your defined type.
Default value: undef
war_purge
Data type: Boolean
Specifies whether to purge the exploded WAR directory. Only applicable when war_ensure is set to 'absent' or false.
Default value: true
war_source
Data type: Optional[String[1]]
Specifies the source to deploy the WAR from. Valid options: a string containing a puppet://, http(s)://, or ftp:// URL.
Default value: undef
allow_insecure
Data type: Boolean
Specifies if HTTPS errors should be ignored when downloading the war tarball.
Default value: false
user
Data type: String[1]
The 'owner' of the tomcat war file.
Default value: 'tomcat'
group
Data type: String[1]
The 'group' owner of the tomcat war file.
Default value: 'tomcat'
Functions
tomcat::change
Type: Ruby 4.x API
This function exists for usage of a returning the input params that is a deferred function Will be used for deferring the values at agent level
tomcat::change(Any $arg)
This function exists for usage of a returning the input params that is a deferred function Will be used for deferring the values at agent level
Returns: Any
arg
Data type: Any
Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
v7.2.0 - 2023-12-08
Added
Fixed
v7.1.0 - 2023-05-31
Added
- (CONT-588) - allow deferred function for change #533 (Ramesh7)
- pdksync - (MAINT) - Allow Stdlib 9.x #532 (LukasAud)
Fixed
- (CONT-802) - Revert RSpec/NoExpectationExample #526 (jordanbreen28)
- Optimize var types #519 (Joris29)
v7.0.0 - 2023-04-17
Changed
- (CONT-802) - add puppet 8/drop puppet 6 #523 (jordanbreen28)
v6.4.1 - 2023-03-23
Fixed
v6.4.0 - 2023-03-23
Added
Fixed
- Update commons-daemon-native version to match Tomcat bundled version #510 (uoe-pjackson)
- Allow adding and removing attributes in Context (#502) #503 (uoe-pjackson)
- Exclude name in resources #501 (kobybr)
- pdksync - (CONT-189) Remove support for RedHat6 / OracleLinux6 / Scientific6 #500 (david22swan)
v6.3.0 - 2022-09-12
Added
- pdksync - (GH-cat-11) Certify Support for Ubuntu 22.04 #493 (david22swan)
- pdksync - (GH-cat-12) Add Support for Redhat 9 #492 (david22swan)
- Allow usage of Context/Resources #491 (tuxmea)
v6.2.0 - 2022-05-16
Added
- Update puppet-archive dependency #477 (h4l)
- pdksync - (IAC-1753) - Add Support for AlmaLinux 8 #476 (david22swan)
- pdksync - (IAC-1751) - Add Support for Rocky 8 #475 (david22swan)
Fixed
- pdksync - (GH-iac-334) Remove Support for Ubuntu 14.04/16.04 #480 (david22swan)
- pdksync - (IAC-1787) Remove Support for CentOS 6 #478 (david22swan)
- pdksync - (IAC-1598) - Remove Support for Debian 8 #474 (david22swan)
v6.1.0 - 2021-08-31
Added
- pdksync - (IAC-1709) - Add Support for Debian 11 #468 (david22swan)
Fixed
- (IAC-1741) Allow stdlib v8.0.0 #469 (david22swan)
v6.0.0 - 2021-07-26
Changed
- [IAC-1690] - Remove tomcat7 as is EOL #459 (daianamezdrea)
Added
- (MODULES-9520) Allow removal of webapps #456 (daianamezdrea)
- Accept Datatype Sensitive for Secrets #454 (cocker-cc)
Fixed
- [MODULES-9781] - Add examples for catalina attributes and properties #453 (daianamezdrea)
v5.1.0 - 2021-05-24
Added
Fixed
v5.0.0 - 2021-03-01
Changed
- pdksync - Remove Puppet 5 from testing and bump minimal version to 6.0.0 #431 (carabasdaniel)
v4.3.0 - 2020-12-14
Added
- pdksync - (feat) - Add support for Puppet 7 #422 (daianamezdrea)
- Refactor valve types #415 (h-haaks)
Fixed
- (IAC-1236) Adding SLES OSs for release_checks #417 (pmcmaw)
- (IAC-1214) - Move SKIP_GCC to test file #416 (pmcmaw)
v4.2.0 - 2020-08-24
Added
- pdksync - (IAC-973) - Update travis/appveyor to run on new default branch
main#405 (david22swan)
Fixed
v4.1.0 - 2020-07-08
Added
- (IAC-746) - Add ubuntu 20.04 support #399 (david22swan)
Fixed
- Allow override status_command in case of use_init #400 (leroyguillaume)
v4.0.0 - 2019-12-11
Changed
Added
- (FM-8699) - Addition of Support for CentOS 8 #374 (david22swan)
- Add Resources support #368 (smortex)
Fixed
v3.1.0 - 2019-09-13
Added
- FM-8413 add support on Debian10 #361 (lionce)
- (FM-8232) Convert to litmus #360 (tphoney)
- FM-8050 - add redhat8 support #354 (lionce)
Fixed
v3.0.0 - 2019-05-17
Changed
- pdksync - (MODULES-8444) - Raise lower Puppet bound #347 (david22swan)
Fixed
- (MODULES-8817) - Update to account for loss of SVN Tomcat archive #344 (david22swan)
2.5.0 - 2019-01-31
Added
- (MODULES-8147) - Add SLES 15 support #328 (eimlav)
- Add context parameter type (re-submit #205) #317 (joshbeard)
Fixed
- (maint) - Ubuntu 18.04 issues fix #333 (david22swan)
- pdksync - (FM-7655) Fix rubygems-update for ruby < 2.3 #330 (tphoney)
- [MODULES-7547] Update globalnamingresource class, and add tests #305 (jplindquist)
2.4.0 - 2018-10-03
Added
- pdksync - (FM-7392) - Puppet 6 Testing Changes #321 (pmcmaw)
- pdksync - (MODULES-7658) use beaker4 in puppet-module-gems #315 (tphoney)
- (FM-7239) - Addition of support for Ubuntu 18.04 #306 (david22swan)
- adding wait_timeout var for init #303 (ackiejoe)
- [FM-7050] Addition of support for Debian 9 on Tomcat #300 (david22swan)
Fixed
- pdksync - (MODULES-6805) metadata.json shows support for puppet 6 #319 (tphoney)
- pdksync - (MODULES-7705) - Bumping stdlib dependency from < 5.0.0 to < 6.0.0 #314 (pmcmaw)
- (MODULES-7633) - Update README Limitations section #307 (eimlav)
- (maint) Double retry count to workaround slow startups #301 (hunner)
- [FM-6967] Removal of unsupported OS from tomcat #299 (david22swan)
- Add rspec retry gem to sync file #295 (HelenCampbell)
- #puppethack work if resource title contains spaces #287 (rheijkoop)
2.3.0 - 2018-02-27
Fixed
2.2.0 - 2018-02-06
Added
- Addition of protocol flag -1 to curl command #281 (HelenCampbell)
- Add ability to set status_command #262 (esalberg)
- Add flexibility to directory management in tomcat::instance #217 (esalberg)
Fixed
- Merging Fix Into Release #283 (david22swan)
- Fix failing curl command #282 (HelenCampbell)
- Fixes Gemfile and avoid break in future module syncs. #274 (pmcmaw)
- Fix Tomcat tests for Tomcat8 #268 (willmeek)
- Syntax error when $addto parameter set in tomcat::setenv::entry #266 (adsully)
- [#puppethack] tomcat::war copy the war as root user and not as tomcat #265 (ralfbosz)
- MODULES-5805: Fix for spaces in context elements #261 (BarnacleBob)
2.1.0 - 2017-10-06
Fixed
- (MODULES-5589) - add user/group to war file #254 (pmcmaw)
- fix lint warnings #252 (PascalBourdier)
- (MODULES-5396) move tomcat::config::properties declaration out of else block #238 (jimethn)
2.0.0 - 2017-08-24
Changed
Added
- add support for allow_insecure parameter #231 (hunner)
- add support for valves in context.xml #213 (simonrondelez)
- Implement beaker-module_install_helper #196 (wilson208)
Fixed
- (maint) Retry harder #248 (hunner)
- (maint) Add allow_insecure to tomcat::war #246 (hunner)
- (maint) Allow mismatched ssl certs #245 (hunner)
- (maint) Moar retry! (still failed on one node) #243 (hunner)
- (maint) Retry failures instead of blind sleeps #242 (hunner)
- (MODULES-1545) Switch back to curl #235 (hunner)
- [MODULES-5360] Adding fix to allow the proxy settings to be passed to archive resource #234 (pckls)
- (MODULES-1545) Allow context paths in war_name #233 (hunner)
- (MODULES-2232) Verify connector ports don't conflict #230 (hunner)
- (maint) Don't duplicate resources for different dependencies #228 (hunner)
- fix retval checks in init script template #221 (fraenki)
- (MODULES-4658) Allow duplicate realms #216 (hunner)
1.7.0 - 2017-05-08
Added
- [MODULES-4654] Add SLES to metadata.json #204 (wilson208)
- [msync] 786266 Implement puppet-module-gems, a45803 Remove metadata.json from locales config #201 (wilson208)
- Ability to not manage catalina.properties. #194 (ikogan)
- (FM-5972) gettext and spec.opts #189 (eputnam)
- Add proxy / environment support for tomcat::install #173 (edestecd)
- Add ability to add
Environmentelements. #169 (ikogan)
Fixed
- (FM-6166) - Updating tests error match #207 (pmcmaw)
- Fix faulty header and link in ToC #198 (sgnl05)
- (maint) Fix duplicate resources in host/realm/valve #197 (hunner)
- MODULES-4238 fix #184 create $catalina_home #190 (tphoney)
- [#puppethack] Fix fixtures.yml #187 (ralfbosz)
1.6.1 - 2016-12-13
Fixed
- #[puppethack] Fix MODULES-3224 #186 (dhollinger)
- #[puppethack] Fix MODULES-1986 #185 (dhollinger)
- #[puppethack] MODULES-4003 Fix ordering issue when using a package for installation #184 (dhollinger)
- (MODULES-4153) Fix duplicate resources; unfix umask #182 (hunner)
1.6.0 - 2016-10-11
Added
- (MODULES-3713) Allow catalina_home and catalina_base to be unmanaged #166 (hunner)
- Feature: MODULES-3458 - Support nesting valve under parent context #150 (fherbert)
- Feature: Add the ability to configure manager elements in context.xml #142 (aaron-miller)
- add tomcat::config::context::environment #137 (juame)
Fixed
- Fix ubuntu 16.04 tests #165 (hunner)
- MODULES-3742 Bugfix/strict vars service #161 (hggh)
- Add owner/group to tomcat_users.pp #158 (ananace)
- MODULES-3436 export prefix in sysconfig/tomcat does not work #149 (k2patel)
- changed user and group for the extract resource #147 (sacchettom)
- fix MODULES-3353 by making sure the Resource name is defined first #143 (jimethn)
1.5.0 - 2016-04-21
Added
- MODULES-2984 - Add support for host aliases #118 (kdhquickitt)
Fixed
- fixes for jsvc-init script template #135 (DavidS)
- (maint) fix t::c::s::tomcat_users under strict variables #134 (DavidS)
- Update documentation and fix bugs #131 (hunner)
- Remove function call from collector #129 (hunner)
- Finish the install before creating instances #128 (hunner)
- Fix for older concats #127 (hunner)
- Fix home/base installation #125 (hunner)
1.4.1 - 2015-12-17
1.4.0 - 2015-12-16
Fixed
1.3.3 - 2015-12-04
Added
Fixed
- delete realm nodes in depth-first order to workaround augeas segfault #111 (GeoffWilliams)
- Document 'purge_connectors' #107 (joshbeard)
1.3.2 - 2015-08-05
Fixed
- [#puppethack] Validate that catalina_base does not to end with / #102 (igalic)
- Wrap username attribute in quotes. #100 (bcornies)
1.3.1 - 2015-07-21
1.3.0 - 2015-06-09
Added
- (MODULES-1886) - Allow configuration of location of server.xml #82 (underscorgan)
- Adds parameter for enabling Tomcat service on boot #77 (bmjen)
- Being able to ordering setenv entries. #74 (icalvete)
- Added manifest for managing Realm elements in server.xml #73 (surry)
- Manage User and Roles in Realms #70 (juame)
- Context Container below Host element in server.xml #66 (juame)
Fixed
- tomcat 7 mirror ran away #85 (underscorgan)
- (FM-2010) Tomcat download mirrors are flaky (tests) #67 (justinstoller)
- Update additional_attributes to support values with spaces #64 (underscorgan)
1.2.0 - 2014-11-10
Added
- MODULES-1478: Add a $purge_connectors parameter. #56 (philipwigg)
Fixed
- Fix for strict variables #61 (underscorgan)
- Use
curl -kto fix cert issue with rhel5 #60 (underscorgan) - Directory in opt should only be created if is true #52 (krionux)
1.1.0 - 2014-10-28
Added
- Use curl -k #53 (underscorgan)
Fixed
- (FM-1912) Illegal version range in puppetlabs-tomcat requirements #50 (thallgren)
- More strict var unit test fixes #48 (underscorgan)
- Tomcat strict variables #46 (underscorgan)
- MODULES-1295: Multiple connectors with same protocol #44 (underscorgan)
- Fix version key for dependencies in metadata.json. #43 (scotje)
1.0.1 - 2014-09-04
Fixed
- Cherrypick test fixes #38 (underscorgan)
- Setenv fix #35 (underscorgan)
- fixed to allow value arrays. #17 (zshahan)
1.0.0 - 2014-09-02
Added
- Add the ability to purge exploded WAR directories. #23 (underscorgan)
- Allow one to set configuration when using tomcat package. #21 (Spredzy)
0.1.2 - 2014-08-20
0.1.1 - 2014-08-13
Added
- Tomcat 7.0.55 was released. #11 (underscorgan)
Fixed
- Call install_ methods only once in spec_helper_acceptance #10 (colinPL)
- Fix warning function name #6 (joshbeard)
0.1.0 - 2014-08-06
Dependencies
- puppetlabs/stdlib (>= 4.6.0 < 10.0.0)
- puppetlabs/concat (>= 4.0.0 < 10.0.0)
- puppet/archive (>= 1.0.0 < 8.0.0)
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
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.
Quality checks
We run a couple of automated scans to help you assess a module’s quality. Each module is given a score based on how well the author has formatted their code and documentation and select 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.
Malware scan results
The malware detection service on Puppet Forge is an automated process that identifies known malware in module releases before they’re published. It is not intended to replace your own virus scanning solution.
Learn more about malware scans- Module name:
- puppetlabs-tomcat
- Module version:
- 7.2.0
- Scan initiated:
- January 23rd 2024, 22:30:20
- Detections:
- 0 / 59
- Scan stats:
- 59 undetected
- 0 harmless
- 0 failures
- 0 timeouts
- 0 malicious
- 0 suspicious
- 15 unsupported
- Scan report:
- View the detailed scan report