Defined Type: tomcat::instance

Defined in:
manifests/instance.pp

Overview

Definition: tomcat::instance

This definition will create:

  • a CATALINA_BASE directory in /srv/tomcat/$name/, readable to tomcat, writeable to members of the admin group.

  • /srv/tomcat/$name/conf/server,web.xml which can be modified by members of the admin group.

  • a /srv/tomcat/$name/webapps/ directory where administrators can drop “*.war” files.

  • an init script /etc/init.d/tomcat-$name.

  • /srv/tomcat/$name/bin/setenv.sh, which is loaded by the init script.

  • /srv/tomcat/$name/bin/setenv-local.sh, which is loaded by the setenv.sh, and can be edited by members of the admin group.

  • rotation of /srv/tomcat/$name/logs/catalina.out.

Parameters:

  • name: the name of the instance.

  • ensure: defines if the state of the instance. Possible values:

    • present: tomcat instance will be running and enabled on boot. This is the default.

    • running: an alias to “ensure => present”.

    • stopped: tomcat instance will be forced to stop, and disabled from boot, but the files won’t be erased from the system.

    • installed: tomcat instance will be disabled from boot, and puppet won’t care if it’s running or not. Useful if tomcat is managed by heartbeat.

    • absent: tomcat instance will be stopped, disabled and completely removed from the system. Warning: /srv/tomcat/$name/ will be completely erased !

  • *owner“: the owner of $CATALINA_BASE/conf,webapps. Defaults to ”tomcat“. Note that permissions will be different, as tomcat needs to read these directories in any case.

  • group: the group which will be allowed to edit the instance’s configuration files and deploy webapps. Defaults to “adm”.

  • umask: controls the file mode creation mask, defaults to 0002

  • server_port: tomcat’s server port, defaults to 8005.

  • http_port: tomcat’s HTTP server port, defaults to 8080.

  • http_address: define the IP address tomcat’s HTTP server must listen on. Defaults to all addresses.

  • ajp_port: tomcat’s AJP port, defaults to 8009.

  • ajp_address: define the IP address tomcat’s AJP server must listen on. Defaults to all addresses.

  • conf_mode: can be used to change the permissions on /srv/tomcat/$name/conf/, because some webapps require the ability to write their own config files. Defaults to 2570 (writeable only by $group members).

  • logs_mode: can be used to change the permissions on /srv/tomcat/$name/logs/, because you may need to make the logs readable by other users / everyone. Defaults to 2770.

  • server_xml_file: can be used to set a specific server.xml file

  • web_xml_file: can be used to set a specific web.xml file

  • webapp_mode: can be used to change the permissions on /srv/tomcat/$name/webapps/. Defaults to 2770 (readable and writeable by $group members and tomcat himself, for auto-deploy).

  • java_home: can be used to define an alternate $JAVA_HOME, if you want the instance to use another JVM.

  • sample: set to “true” and a basic “hello world” webapp will be deployed on the instance. You can test it by loading this URL: localhost:8080/sample (where 8080 is the port defined by the “http_port” parameter).

  • setenv: optional array of environment variable definitions, which will be added to setenv.sh. It will still be possible to override these variables by editing setenv-local.sh.

  • connector: an array of tomcat::connector name (string) to include in server.xml

  • executor: an array of tomcat::executor name (string) to include in server.xml

  • catalina_logrotate: install an UNMANAGED logrotate configuration file, to handle the catalina.out file of the instance. Default to true.

  • systemd_nofile: number of open files limit configuration in systemd unit. This has no effect on systems where tomcat is not managed by systemd.

Requires:

  • one of the tomcat classes which installs tomcat binaries.

  • java to be previously installed.

  • logrotate to be installed.

Example usage:

include tomcat
include tomcat::administration

tomcat::instance { "foo":
  ensure => present,
  group  => "tomcat-admin",
}

tomcat::instance { "bar":
  ensure      => present,
  server_port => 8006,
  http_port   => 8081,
  ajp_port    => 8010,
  sample      => true,
  setenv      => [
    'JAVA_XMX="1200m"',
    'ADD_JAVA_OPTS="-Xms128m"'
  ],
}

Parameters:

  • ensure (Any) (defaults to: present)
  • owner (Any) (defaults to: 'tomcat')
  • group (Any) (defaults to: 'adm')
  • umask (Any) (defaults to: '0002')
  • server_port (Any) (defaults to: '8005')
  • http_port (Any) (defaults to: '8080')
  • http_address (Any) (defaults to: false)
  • ajp_port (Any) (defaults to: '8009')
  • ajp_address (Any) (defaults to: false)
  • conf_mode (Any) (defaults to: undef)
  • logs_mode (Any) (defaults to: '2770')
  • catalina_base_mode (Any) (defaults to: '0555')
  • server_xml_file (Any) (defaults to: undef)
  • web_xml_file (Any) (defaults to: undef)
  • webapp_mode (Any) (defaults to: undef)
  • java_home (Any) (defaults to: undef)
  • sample (Any) (defaults to: undef)
  • setenv (Any) (defaults to: [])
  • connector (Any) (defaults to: [])
  • default_connectors (Any) (defaults to: true)
  • executor (Any) (defaults to: [])
  • manage (Any) (defaults to: false)
  • seluser (Any) (defaults to: 'system_u')
  • selrole (Any) (defaults to: 'object_r')
  • seltype (Any) (defaults to: 'initrc_exec_t')
  • selrole_connector (Any) (defaults to: undef)
  • seltype_connector (Any) (defaults to: undef)
  • seluser_connector (Any) (defaults to: undef)
  • instance_basedir (Any) (defaults to: $tomcat::instance_basedir)
  • tomcat_version (Any) (defaults to: $tomcat::version)
  • catalina_logrotate (Any) (defaults to: true)
  • java_opts (Any) (defaults to: undef)
  • systemd_nofile (Any) (defaults to: '4096') 


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'manifests/instance.pp', line 98

define tomcat::instance(
  $ensure             = present,
  $owner              = 'tomcat',
  $group              = 'adm',
  $umask              = '0002',
  $server_port        = '8005',
  $http_port          = '8080',
  $http_address       = false,
  $ajp_port           = '8009',
  $ajp_address        = false,
  $conf_mode          = undef,
  $logs_mode          = '2770',
  $catalina_base_mode = '0555',
  $server_xml_file    = undef,
  $web_xml_file       = undef,
  $webapp_mode        = undef,
  $java_home          = undef,
  $sample             = undef,
  $setenv             = [],
  $connector          = [],
  $default_connectors = true,
  $executor           = [],
  $manage             = false,
  $seluser            = 'system_u',
  $selrole            = 'object_r',
  $seltype            = 'initrc_exec_t',
  $selrole_connector  = undef,
  $seltype_connector  = undef,
  $seluser_connector  = undef,
  $instance_basedir   = $tomcat::instance_basedir,
  $tomcat_version     = $tomcat::version,
  $catalina_logrotate = true,
  $java_opts          = undef,
  $systemd_nofile     = '4096',
) {

  Class['tomcat::install'] -> Tomcat::Instance[$title]

  validate_re($ensure, [
    'present',
    'running',
    'stopped',
    'installed',
    'absent',
    ])
  validate_string($owner)
  validate_string($group)
  validate_bool($manage)
  validate_absolute_path($instance_basedir)

  $version = $tomcat_version
  validate_re($version, '^[5-9]([\.0-9]+)?$')

  $basedir = "${instance_basedir}/${name}"

  tomcat::instance::install { $title:
    ensure             => $ensure,
    name               => $name,
    catalina_base      => $basedir,
    catalina_logrotate => $catalina_logrotate,
    conf_mode          => $conf_mode,
    group              => $group,
    logs_mode          => $logs_mode,
    catalina_base_mode => $catalina_base_mode,
    owner              => $owner,
    sample             => $sample,
    webapp_mode        => $webapp_mode,
  }

  tomcat::instance::config { $title:
    ensure             => $ensure,
    name               => $name,
    catalina_base      => $basedir,
    ajp_address        => $ajp_address,
    ajp_port           => $ajp_port,
    connector          => $connector,
    default_connectors => $default_connectors,
    executor           => $executor,
    group              => $group,
    umask              => $umask,
    http_address       => $http_address,
    http_port          => $http_port,
    instance_basedir   => $instance_basedir,
    java_home          => $java_home,
    manage             => str2bool($manage),
    owner              => $owner,
    selrole            => $selrole,
    seltype            => $seltype,
    seluser            => $seluser,
    server_port        => $server_port,
    server_xml_file    => $server_xml_file,
    setenv             => $setenv,
    version            => $version,
    web_xml_file       => $web_xml_file,
    java_opts          => $java_opts,
    systemd_nofile     => $systemd_nofile,
    selrole_connector  => $selrole_connector,
    seltype_connector  => $seltype_connector,
    seluser_connector  => $seluser_connector,

  }

  tomcat::instance::service { $title:
    ensure => $ensure,
    name   => $name,
  }

  if $ensure == 'absent' {
    Tomcat::Instance::Service[$title]
    -> Tomcat::Instance::Install[$title]
  } else {
    Tomcat::Instance::Install[$title]
    -> Tomcat::Instance::Config[$title]
    -> Tomcat::Instance::Service[$title]

    if $manage {
      Tomcat::Instance::Config[$title] ~> Tomcat::Instance::Service[$title]
    }
  }
}