saltstack-formulas/tomcat-formula

tomcat

Formula to set up and configure tomcat webserver

Table of Contents

• General notes
• Contributing to this repo
• Special notes
• Available states
  • tomcat
  • tomcat.config
  • tomcat.native
  • tomcat.manager
  • tomcat.vhosts
  • tomcat.expires
  • tomcat.cluster
  • tomcat.context
• Testing
  • Requirements
  • bin/kitchen converge
  • bin/kitchen verify
  • bin/kitchen destroy
  • bin/kitchen test
  • bin/kitchen login

General notes

See the full SaltStack Formulas installation and usage instructions.

If you are interested in writing or contributing to formulas, please pay attention to the Writing Formula Section.

If you want to use this formula, please pay attention to the FORMULA file and/or git tag, which contains the currently released version. This formula is versioned according to Semantic Versioning.

See Formula Versioning Section for more details.

If you need (non-default) configuration, please pay attention to the pillar.example file and/or Special notes section.

Contributing to this repo

Commit message formatting is significant!!

Please see How to contribute for more details.

Special notes

None

Available states

• tomcat
• tomcat.config
• tomcat.native
• tomcat.manager
• tomcat.vhosts
• tomcat.expires
• tomcat.cluster
• tomcat.context

tomcat

Installs Tomcat and starts the service. The main configuration files are not changed, and the distro's defaults are preserved as they come in the package.

tomcat.config

Configures the configuration file. Sane defaults are provided for the major Linux distros (Debian, RedHat, Arch) and their derivatives.

tomcat.native

Installs Apache Portable Runtime for Tomcat. Depends on tomcat.config to manage the configuration.

tomcat.manager

Installs the host-manager and manager web applications for Apache Tomcat.

tomcat.vhosts

Configures Tomcat name-based virtual hosts using data from Pillar.

tomcat.expires

Enables Tomcats' ExpiresFilter using data from Pillar.

tomcat.cluster

Configures Tomcat simple TCP cluster using data from Pillar.

tomcat.context

Configures context element in the $CATALINA_BASE/conf/context.xml file: the information in this file will be loaded by all web applications. (Check the context examples in the pillar.example file for more information.

Testing

Linux testing is done with kitchen-salt.

Requirements

• Ruby
• Docker

$ gem install bundler
$ bundle install
$ bin/kitchen test [platform]

Where [platform] is the platform name defined in kitchen.yml, e.g. debian-9-2019-2-py3.

bin/kitchen converge

Creates the docker instance and runs the TEMPLATE main state, ready for testing.

bin/kitchen verify

Runs the inspec tests on the actual instance.

bin/kitchen destroy

Removes the docker instance.

bin/kitchen test

Runs all of the stages above in one go: i.e. destroy + converge + verify + destroy.

bin/kitchen login

Gives you SSH access to the instance for manual testing.