Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/robertdebock/ansible-role-tomcat

Install and configure tomcat on your system.
https://github.com/robertdebock/ansible-role-tomcat
ansible molecule playbook system tomcat tox
Last synced: 26 days ago
JSON representation
Install and configure tomcat on your system.
Host: GitHub
URL: https://github.com/robertdebock/ansible-role-tomcat
Owner: robertdebock
License: apache-2.0
Created: 2017-12-22T11:08:08.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2024-09-12T15:59:20.000Z (about 2 months ago)
Last Synced: 2024-09-27T08:41:22.027Z (about 1 month ago)
Topics: ansible, molecule, playbook, system, tomcat, tox
Language: Jinja
Homepage: https://robertdebock.nl/
Size: 26.4 MB
Stars: 46
Watchers: 4
Forks: 57
Open Issues: 13
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project

README

        # [Ansible role tomcat](#tomcat)

Install and configure tomcat on your system.

|GitHub|GitLab|Downloads|Version|

|------|------|---------|-------|

|[![github](https://github.com/robertdebock/ansible-role-tomcat/workflows/Ansible%20Molecule/badge.svg)](https://github.com/robertdebock/ansible-role-tomcat/actions)|[![gitlab](https://gitlab.com/robertdebock-iac/ansible-role-tomcat/badges/master/pipeline.svg)](https://gitlab.com/robertdebock-iac/ansible-role-tomcat)|[![downloads](https://img.shields.io/ansible/role/d/robertdebock/tomcat)](https://galaxy.ansible.com/robertdebock/tomcat)|[![Version](https://img.shields.io/github/release/robertdebock/ansible-role-tomcat.svg)](https://github.com/robertdebock/ansible-role-tomcat/releases/)|

## [Example Playbook](#example-playbook)

This example is taken from [`molecule/default/converge.yml`](https://github.com/robertdebock/ansible-role-tomcat/blob/master/molecule/default/converge.yml) and is tested on each push, pull request and release.

```yaml

---

- name: Converge

  hosts: all

  become: true

  gather_facts: true

  vars:

    # tomcat_address: "127.0.0.1"

    tomcat_instances:

      - name: "tomcat"

      # - name: "tomcat-version-7"

      #   version: 7

      #   shutdown_port: 8007

      #   non_ssl_connector_port: 8082

      #   ssl_connector_port: 8445

      #   ajp_port: 8011

      # - name: "tomcat-version-8"

      #   version: 8

      #   shutdown_port: 8008

      #   non_ssl_connector_port: 8083

      #   ssl_connector_port: 8446

      #   ajp_port: 8012

      # - name: "tomcat-version-9"

      #   version: 9

      #   shutdown_port: 8019

      #   non_ssl_connector_port: 8084

      #   ssl_connector_port: 8447

      #   ajp_port: 8013

      # - name: "tomcat-specific"

      #   user: "specificuser"

      #   group: "specificgroup"

      #   shutdown_port: 8020

      #   shutdown_pass: shutme

      #   non_ssl_connector_port: 8085

      #   ssl_connector_port: 8448

      #   ajp_port: 8014

      #   xms: 256M

      #   xmx: 512M

      # - name: "tomcat-with-wars"

      #   shutdown_port: 8021

      #   non_ssl_connector_port: 8086

      #   ssl_connector_port: 8449

      #   ajp_port: 8015

      #   wars:

      #     - url: https://tomcat.apache.org/tomcat-7.0-doc/appdev/sample/sample.war

      #     - url: "https://github.com/aeimer/java-example-helloworld-war/raw/master/dist/helloworld.war"

      # - name: "tomcat-java_opts"

      #   shutdown_port: 8022

      #   non_ssl_connector_port: 8087

      #   ssl_connector_port: 8449

      #   ajp_port: 8016

      #   java_opts:

      #     - name: UMASK

      #       value: "0007"

      # - name: "tomcat-with_lib"

      #   shutdown_port: 8023

      #   non_ssl_connector_port: 8088

      #   ssl_connector_port: 8450

      #   ajp_port: 8017

      #   libs:

      #     - url: "https://search.maven.org/remotecontent?filepath=io/prometheus/simpleclient/0.6.0/simpleclient-0.6.0.jar"

      # - name: "tomcat-access-logs"

      #   shutdown_port: 8024

      #   non_ssl_connector_port: 8089

      #   ssl_connector_port: 8451

      #   ajp_port: 8018

      #   access_log_enabled: true

      #   access_log_directory: "my-logs"

      #   access_log_prefix: my-access-logs

      #   access_log_suffix: ".log"

      #   access_log_pattern: "%h %l %u %t "%r" %s %b"

      # - name: "tomcat-config-files"

      #   shutdown_port: 8025

      #   non_ssl_connector_port: 8090

      #   ssl_connector_port: 8452

      #   ajp_port: 8019

      #   ajp_secret: "SoMe-SeCrEt"

      #   config_files:

      #     - src: "{{ role_path }}/files/dummy.properties"

      #       dest: "./"

      #       mode: "0644"

  roles:

    - role: robertdebock.tomcat

```

The machine needs to be prepared. In CI this is done using [`molecule/default/prepare.yml`](https://github.com/robertdebock/ansible-role-tomcat/blob/master/molecule/default/prepare.yml):

```yaml

---

- name: Prepare

  hosts: all

  become: true

  gather_facts: false

  roles:

    - role: robertdebock.bootstrap

    - role: robertdebock.core_dependencies

    - role: robertdebock.java

      # __java_version:

      #   default: 8

      #   Debian: 11

      #   Debian-bookworm: 17

      # java_version: "{{ _desired_java_version[ansible_distribution ~ '-' ~ ansible_distribution_release] | default(_desired_java_version[ansible_distribution] | default(_desired_java_version['default'])) }}"

```

Also see a [full explanation and example](https://robertdebock.nl/how-to-use-these-roles.html) on how to use these roles.

## [Role Variables](#role-variables)

The default values for the variables are set in [`defaults/main.yml`](https://github.com/robertdebock/ansible-role-tomcat/blob/master/defaults/main.yml):

```yaml

---

# defaults file for tomcat

# Some "sane" defaults.

tomcat_name: tomcat

tomcat_directory: /opt

tomcat_version: 9

tomcat_user: tomcat

tomcat_group: tomcat

tomcat_xms: 512M

tomcat_xmx: 1024M

tomcat_non_ssl_connector_port: 8080

tomcat_ssl_connector_port: 8443

tomcat_shutdown_port: 8005

tomcat_shutdown_pass: SHUTDOWN

tomcat_ajp_enabled: true

tomcat_ajp_port: 8009

tomcat_ajp_secret: "SoMe-SeCrEt"

tomcat_jre_home: /usr

tomcat_service_state: started

tomcat_service_enabled: true

# You can bind Tomcat to a specified address globally using this variable, or

# in the `tomcat_instances`. The `tomcat_instances.address` is more specific

# so it takes priority over `tomcat_address`.

tomcat_address: "0.0.0.0"

# Configure tomcat access logs

tomcat_access_log_enabled: true

tomcat_access_log_directory: logs

tomcat_access_log_prefix: localhost_access_log

tomcat_access_log_suffix: ".txt"

tomcat_access_log_pattern: "%h %l %u %t "%r" %s %b"

# This role allows multiple installations of Apache Tomcat, each in their own

# location, potentially of different version.

# This is done by defining a "tomcat_instances" where "name:" is a unique

# identifier of an instance.

# The default tomcat_instances is one instance using the defaults described

# in defaults/main.yml.

tomcat_instances:

  - name: "{{ tomcat_name }}"

    version: "{{ tomcat_version }}"

    user: "{{ tomcat_user }}"

    group: "{{ tomcat_group }}"

    xms: "{{ tomcat_xms }}"

    xmx: "{{ tomcat_xmx }}"

    non_ssl_connector_port: "{{ tomcat_non_ssl_connector_port }}"

    ssl_connector_port: "{{ tomcat_ssl_connector_port }}"

    shutdown_port: "{{ tomcat_shutdown_port }}"

    ajp_enabled: "{{ tomcat_ajp_enabled }}"

    ajp_port: "{{ tomcat_ajp_port }}"

    ajp_secret: "{{ tomcat_ajp_secret }}"

    # You can pick an address per instance:

    # address: "127.0.0.1"

    packet_size: 8192

    java_opts:

      - name: JRE_HOME

        value: "{{ tomcat_jre_home }}"

    access_log_enabled: "{{ tomcat_access_log_enabled }}"

    access_log_directory: "{{ tomcat_access_log_directory }}"

    access_log_prefix: "{{ tomcat_access_log_prefix }}"

    access_log_suffix: "{{ tomcat_access_log_suffix }}"

    access_log_pattern: "{{ tomcat_access_log_pattern }}"

    service_state: "{{ tomcat_service_state }}"

    service_enabled: "{{ tomcat_service_enabled }}"

# The explicit version to use when referring to the short name.

tomcat_version7: "7.0.109"

tomcat_version8: "8.5.73"

tomcat_version9: "9.0.55"

tomcat_version10: "10.1.12"

# The location where to download Apache Tomcat from.

tomcat_mirror: "https://archive.apache.org"

```

## [Requirements](#requirements)

- pip packages listed in [requirements.txt](https://github.com/robertdebock/ansible-role-tomcat/blob/master/requirements.txt).

## [State of used roles](#state-of-used-roles)

The following roles are used to prepare a system. You can prepare your system in another way.

| Requirement | GitHub | GitLab |

|-------------|--------|--------|

|[robertdebock.bootstrap](https://galaxy.ansible.com/robertdebock/bootstrap)|[![Build Status GitHub](https://github.com/robertdebock/ansible-role-bootstrap/workflows/Ansible%20Molecule/badge.svg)](https://github.com/robertdebock/ansible-role-bootstrap/actions)|[![Build Status GitLab](https://gitlab.com/robertdebock-iac/ansible-role-bootstrap/badges/master/pipeline.svg)](https://gitlab.com/robertdebock-iac/ansible-role-bootstrap)|

|[robertdebock.core_dependencies](https://galaxy.ansible.com/robertdebock/core_dependencies)|[![Build Status GitHub](https://github.com/robertdebock/ansible-role-core_dependencies/workflows/Ansible%20Molecule/badge.svg)](https://github.com/robertdebock/ansible-role-core_dependencies/actions)|[![Build Status GitLab](https://gitlab.com/robertdebock-iac/ansible-role-core_dependencies/badges/master/pipeline.svg)](https://gitlab.com/robertdebock-iac/ansible-role-core_dependencies)|

|[robertdebock.java](https://galaxy.ansible.com/robertdebock/java)|[![Build Status GitHub](https://github.com/robertdebock/ansible-role-java/workflows/Ansible%20Molecule/badge.svg)](https://github.com/robertdebock/ansible-role-java/actions)|[![Build Status GitLab](https://gitlab.com/robertdebock-iac/ansible-role-java/badges/master/pipeline.svg)](https://gitlab.com/robertdebock-iac/ansible-role-java)|

|[robertdebock.service](https://galaxy.ansible.com/robertdebock/service)|[![Build Status GitHub](https://github.com/robertdebock/ansible-role-service/workflows/Ansible%20Molecule/badge.svg)](https://github.com/robertdebock/ansible-role-service/actions)|[![Build Status GitLab](https://gitlab.com/robertdebock-iac/ansible-role-service/badges/master/pipeline.svg)](https://gitlab.com/robertdebock-iac/ansible-role-service)|

## [Context](#context)

This role is a part of many compatible roles. Have a look at [the documentation of these roles](https://robertdebock.nl/) for further information.

Here is an overview of related roles:

![dependencies](https://raw.githubusercontent.com/robertdebock/ansible-role-tomcat/png/requirements.png "Dependencies")

## [Compatibility](#compatibility)

This role has been tested on these [container images](https://hub.docker.com/u/robertdebock):

|container|tags|

|---------|----|

|[EL](https://hub.docker.com/r/robertdebock/enterpriselinux)|9|

|[Debian](https://hub.docker.com/r/robertdebock/debian)|all|

|[Fedora](https://hub.docker.com/r/robertdebock/fedora)|all|

|[Ubuntu](https://hub.docker.com/r/robertdebock/ubuntu)|all|

The minimum version of Ansible required is 2.12, tests have been done to:

- The previous version.

- The current version.

- The development version.

If you find issues, please register them in [GitHub](https://github.com/robertdebock/ansible-role-tomcat/issues).

## [License](#license)

[Apache-2.0](https://github.com/robertdebock/ansible-role-tomcat/blob/master/LICENSE).

## [Author Information](#author-information)

[robertdebock](https://robertdebock.nl/)

Please consider [sponsoring me](https://github.com/sponsors/robertdebock).