https://github.com/puppetlabs/puppetlabs-tomcat
PuppetLabs Tomcat module
https://github.com/puppetlabs/puppetlabs-tomcat
hacktoberfest module supported
Last synced: about 1 month ago
JSON representation
PuppetLabs Tomcat module
- Host: GitHub
- URL: https://github.com/puppetlabs/puppetlabs-tomcat
- Owner: puppetlabs
- License: apache-2.0
- Created: 2014-05-28T21:55:19.000Z (about 11 years ago)
- Default Branch: main
- Last Pushed: 2025-04-23T11:57:41.000Z (2 months ago)
- Last Synced: 2025-05-05T16:18:42.438Z (about 2 months ago)
- Topics: hacktoberfest, module, supported
- Language: Ruby
- Homepage: https://forge.puppetlabs.com/puppetlabs/tomcat
- Size: 1.4 MB
- Stars: 38
- Watchers: 165
- Forks: 171
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# tomcat
#### Table of Contents
1. [Overview](#overview)
2. [Module Description - What the module does and why it is useful](#module-description)
3. [Setup - The basics of getting started with tomcat](#setup)
* [Setup requirements](#requirements)
* [Beginning with tomcat](#beginning-with-tomcat)
4. [Usage - Configuration options and additional functionality](#usage)
* [I want to run multiple instances of multiple versions of Tomcat](#i-want-to-run-multiple-instances-of-multiple-versions-of-tomcat)
* [I want to configure SSL and specify which protocols and ciphers to use](#i-want-to-configure-ssl-and-specify-which-protocols-and-ciphers-to-use)
* [I want to deploy WAR files.](#i-want-to-deploy-war-files)
* [I want to remove some configuration](#i-want-to-remove-some-configuration)
* [I want to manage a Connector or Realm that already exists](#i-want-to-manage-a-connector-or-realm-that-already-exists)
5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
6. [Limitations - OS compatibility, etc.](#limitations)
7. [License](#license)
8. [Development - Guide for contributing to the module](#development)
## 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](https://forge.puppetlabs.com/puppetlabs/stdlib) version 4.0 or newer. On Puppet Enterprise you must meet this requirement before installing the module. To update stdlib, run:
```bash
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:
```puppet
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](http://tomcat.apache.org/whichversion.html).
## Usage
### I want to run multiple instances of multiple versions of Tomcat
```puppet
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](http://tomcat.apache.org/whichversion.html).
### 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:
```puppet
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
```puppet
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,
cert_key_file => '/path/to/key.pem',
cert_file => '/path/to/cert.pem',
cert_chain_file => '/path/to/chain.pem',
cert_type => 'RSA',
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](https://tomcat.apache.org/tomcat-8.5-doc/ssl-howto.html)
### I want to deploy WAR files
Add the following to any existing installation with your own war source:
```puppet
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:
```puppet
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`.
```puppet
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](https://github.com/puppetlabs/puppetlabs-tomcat/blob/main/REFERENCE.md)
## Limitations
For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-tomcat/blob/main/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](https://opensource.org/license/agpl-v3/), [BSD-2](https://opensource.org/license/bsd-2-clause/), [BSD-3](https://opensource.org/license/bsd-3-clause/), [GPL2.0](https://opensource.org/license/gpl-2-0/), [LGPL](https://opensource.org/license/lgpl-3-0/), [MIT](https://opensource.org/license/mit/) and [MPL](https://opensource.org/license/mpl-2-0/) 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.](https://puppet.com/docs/puppet/latest/contributing.html)
### Contributors
To see who's already involved, see the [list of contributors.](https://github.com/puppetlabs/puppetlabs-tomcat/graphs/contributors)
### Running tests
This project contains tests for both [rspec-puppet](http://rspec-puppet.com/) and [beaker-rspec](https://github.com/puppetlabs/beaker-rspec) to verify functionality. For in-depth information, please see their respective documentation.
Quickstart:
```bash
gem install bundler
bundle install
bundle exec rake spec
bundle exec rspec spec/acceptance
RS_DEBUG=yes bundle exec rspec spec/acceptance
```