README.md

tomcat Cookbook

Provides resources for installing Tomcat and managing the Tomcat service for use in wrapper cookbooks. Installs Tomcat from tarballs on the Apache.org website and installs the appropriate configuration for your platform's init system.

Requirements

Platforms

• Debian / Ubuntu derivatives
• RHEL and derivatives
• Fedora
• openSUSE / SUSE Linux Enterprises

Chef

• Chef 13+

Cookbooks

• none

Usage

Due to the complexity of Tomcat cookbooks it's not possible to create an attribute driven cookbook that solves everyone's problems. Instead this cookbook provides resources for installing Tomcat and managing the Tomcat service, which are best used in your own wrapper cookbook. The best way to understand how this could be used is to look at the helloworld test recipe located at https://github.com/chef-cookbooks/tomcat/blob/master/test/cookbooks/test/recipes/helloworld_example.rb

Resources

tomcat_install

tomcat_install installs an instance of the tomcat binary direct from Apache's mirror site. As distro packages are not used we can easily deploy per-instance installations and any version available on the Apache archive site can be installed.

properties

• version: The version to install. Default: 8.5.54
• version_archive: The filename of the versioned archive to install. Default: apache-tomcat-VERSION.tar.gz
• install_path: Full path to the install directory. Default: /opt/tomcat_INSTANCENAME_VERSION
• tarball_base_uri: The base uri to the apache mirror containing the tarballs. Default: `http://archive.apache.org/dist/tomcat/'
• checksum_base_uri: The base uri to the apache mirror containing the md5 or sha512 file. Default: 'http://archive.apache.org/dist/tomcat/'
• verify_checksum: Whether the checksum should be verified against checksum_base_uri. Default: true.
• dir_mode: Directory permissions of the install_path. Default: '0750'.
• tarball_uri: The complete uri to the tarball. Default: TARBALL_BASE_URI/tomcat-#{major_version(version)}/v#{version}/bin/#{version_archive}.#{version_checksum_algorithm(version)}
• checksum_uri: The complete uri to the tarball checksum. Default: CHECKSUM_BASE_URI/tomcat-#{major_version(version)}/v#{version}/bin/#{version_archive}.#{version_checksum_algorithm(version)}
• tarball_path: Local path on disk to the tarball. If the file does not exist, or the checksum does not match, it will be downloaded from tarball_uri.
• tarball_validate_ssl: Validate the SSL certificate, if tarball_uri is using HTTPS. Default true.
• exclude_docs: Exclude ./webapps/docs from installation. Default true.
• exclude_examples: Exclude ./webapps/examples from installation. Default true.
• exclude_manager: Exclude ./webapps/manager from installation. Default: false.
• exclude_hostmanager: Exclude ./webapps/host-manager from installation. Default: false.
• tomcat_user: User to run tomcat as. Default: tomcat_INSTANCENAME
• tomcat_group: Group of the tomcat user. Default: tomcat_INSTANCENAME
• tomcat_user_shell: Shell of the tomcat user. Default: /bin/false
• create_user: Creates the specified tomcat_user within the OS. Default true.
• create_group: Creates the specified tomcat_group within the OS. Default true.
• service_template_source: Source template file for the upstart/systemd service definition. Default: init_#{node['init_package']}.erb
• service_template_cookbook: Cookbook from which to source the upstart/systemd service definition template. Default: tomcat
• create_symlink: Creates symlink at SYMLINK_PATH to INSTALL_PATH. Default: true
• symlink_path: Full path to where the symlink will be created targetting INSTALL_PATH. Default: /opt/tomcat_INSTANCE_NAME

example

Install an Tomcat 8.0.36 instance named 'helloworld' to /opt/tomcat_helloworld_8_0_36/ with a symlink at /opt/tomcat_helloworld/

tomcat_install 'helloworld' do
  version '8.0.36'
end

Install an Tomcat instance named 'helloworld' from a local tarball to /opt/tomcat_helloworld_8_0_36/ with a symlink at /opt/tomcat_helloworld/

tomcat_install 'helloworld' do
  version '8.0.36'
  verify_checksum false
  tarball_path '/tmp/apache-tomcat-8.0.36.tar.gz'
end

tomcat_service

tomcat_service sets up the installed tomcat instance to run using the appropriate init system (upstart or systemd)

properties

• install_path: Full path to the install directory. Default: /opt/tomcat_INSTANCENAME
• env_vars: An array of hashes containing the environmental variables for Tomcat's setenv.sh script. Note: If CATALINA_BASE is not passed it will automatically be added as the first item in the array. Default: [ {'CATALINA_BASE' => '/opt/INSTANCE_NAME/'}, {'CATALINA_PID' => '$CATALINA_BASE/bin/tomcat.pid'} ]
• service_vars: An array of hashes containing additional systemd directives when setting up a service under systemd.
• sensitive: Excludes diffs that may expose ENV values from the chef-client logs. Default: false
• service_name: The service name to configure. Default: tomcat_INSTANCE_NAME
• tomcat_user: The user the service runs under
• tomcat_group: The group the service runs under
• service_template_source: The service template source for the appropriate init system.
• service_template_cookbook: The cookbook that contains the service template source template. Default: tomcat
• service_template_local: Specifies if service_template_source is a local path rather than sourced from a cookbook. Default: false

actions

• start
• create
• stop
• enable
• disable
• restart

example

tomcat_service 'helloworld' do
  action :start
  env_vars [{ 'CATALINA_PID' => '/my/special/path/tomcat.pid' }]
end

Contributors

This project exists thanks to all the people who contribute.

Backers

Thank you to all our backers!

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website.