Skip to content
Switch branches/tags

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time


A puppet module to manage Internet2 Grouper configuration and related Tomcat setup.

  1. Overview
  2. Class 'grouper'
  3. Resource 'grouper::instance'
  4. Usage Example
  5. Dependencies


This module will manage grouper configurations but does not do everything that the grouperInstaller does. You still will need to manually download and extract + patch the grouper archives. You can setup grouperInstaller to do this non-interactively:

This module does not initialize the grouper database. Sample schema are here:

You can run the grouperInstaller to take care of download, patching, database and then use this module to finish the configuration and manage the installation on an ongoing basis.

It may also be useful to copy your installation and manage different test configs with additional grouper::instance resources.

The module configures these items:

  • subject API adapter in sources.xml (only a single LDAP adapter is supported)
  • wheel group autocreate config
  • log4j config to choose logfile location
  • grouper database configuration (does not initialize database)
  • Adds config for mysql/mariadb in my.cnf.d to set database default encoding to UTF-8 (database restart required)
  • If system uses systemd, adds unit to start grouper loader daemon

Taken from steps at:

The module does not configure any kind of reverse proxy to the tomcat instance (default port 8080).

It also does not include any means to restrict the listen address of the tomcat instance. For example you might have apache reverse-proxy to localhost:8080 and thus there is no need for tomcat to listen on any public IP. If this is a requirement then consider setting manage_tomcat => false and/or tomcat_resource => absent in grouper::instance and configure tomcat with the puppet-tomcat module used internally by this module. There are tomcat configurations in both the grouper class and grouper::instance resource to reference.

The above features may be added at some point. Pull requests are welcome.

Class: grouper


Install groovy package. The distribution packages with RHEL7 don't work with groovy grouper shell TODO: Also setup groovysh4grouper:


'download' will grab binary archive from Requires example42-puppi module. 'package' will install with dist package from pre-existing repo


Which version to download if groovy_install is set to 'download'


Install and configure tomcat. Requires puppetlabs-tomcat module. RHEL7 only. You can set tomcat_context = ensure on grouper::instance resources and they will configure contexts referencing the grouper web ui and web services. You can also build .war files from the installation(s) managed in grouper::instance resources and place in /usr/share/tomcat/webapps.


If manage_tomcat is true configure grouper_system role and GrouperSystem user in tomcat-users.xml

Resource: grouper::instance

Resource to define instance of grouper. Must first be installed by some means such as grouperInstaller or by unpacking tarballs and initializing DB manually.



Top level directory where grouper.apiBinary-version, grouper.ui-version, etc live. GROUPER_HOME and various paths will be constructed from topdir and version


Version installed under grouper_topdir, used in constructing GROUPER_HOME. Default 2.3.0 (current release at this time)


http(s)://hostname:port for grouper web ui and web API (path specified separately). Default: 'fqdn:8080'


Path component of URL for grouper web ui without / prefix. Default 'grouper'.


Path component of URL for grouper web services API without / prefix. Default 'grouper-ws'.


Values: present, absent. Default present.

Create tomcat server context referencing ws/ui paths in grouper_topdir. Only relevant if grouper::manage_tomcat was set true. You may choose not to set this and instead build .war files for ws and ui to install in your tomcat webapps directory. See


Sets to distinguish instances. Defaults to name of resource.


What user tomcat runs as. Also sets permissions on logdir. Default 'tomcat'.


Group that tomcat runs as. Also sets permissions on logdir. Default 'tomcat'.


Where grouper components log. Sets appropriate setting in for each component.


Host to connect to for database access. Default 'localhost'.


Name of grouper database. Default 'grouper'.


Type of database. Determines driver settings. Currently 'mariadb' and 'mysql' supported. Default 'mariadb'.

If using mariadb driver you will need to install mariadb jarfile, steps 4-8 here (other config steps are in this module):

The Mysql driver that comes with grouper is likely adequate with either mysql or mariadb if you prefer to specify 'mysql' and take no further action. However, we are using most current mariadb driver and thus have no experience to verify.

TODO: Module should install correct jar if 'mariadb' is specified


Username to authenticate to database.


Password to authenticate to database.


Set configuration.detect.utf8.file.problems in Should generally be false.


Should be false if using mariadb driver. Default false.


A hash defining ldap subject id source adapter configuration. Only 'ldap' type is supported. More information on the meaning of these configuration items is available from the Grouper wiki:


   $adapter_config = {
       'adapter_type'     => 'ldap',
       'adapter_id'       => 'name',
       'adapter_name'     => 'name',
       'provider_url'     => 'ldaps://,dc=org',
       'subject_id_type'  => 'eduPersonPrincipalName',
       'subject_ou'       => 'People',
       'name_type'        => 'cn',
       'description_type' => 'gecos'

If this is true then a GROUPER_HOME environment variable will be set in /etc/profile.d/grouper-${name}.sh

Usage example

  1. You should setup the module and run puppet one time to configure database defaults.
  2. Restart MariaDB (or MySQL).
  3. Run grouperInstaller.jar. The most up-to-date details at PDF linked below.
  4. During installation be sure to put in your database info and initialize the database.
  5. Optional: Install latest mariadb JDBC driver (required if you specify 'mariadb' driver to grouper::instance). Instructions:
  6. Run puppet module again, it will detect that grouper is installed and complete configuration.

class { 'grouper':
    grouper_system_password => $grouper_system_password

$adapter_config = {
    'adapter_type'     => 'ldap',
    'adapter_id'       => 'name',
    'adapter_name'     => 'name',
    'provider_url'     => 'ldaps://,dc=org',
    'subject_id_type'  => 'eduPersonPrincipalName',
    'subject_ou'       => 'People',
    'name_type'        => 'cn',
    'description_type' => 'gecos'

grouper::instance { 'production':
    adapter_config          => $adapter_config,
    grouper_topdir          => '/opt/grouper-2.3',
    grouper_version         => '2.3.0',
    ui_host                 => '',
    ui_path                 => 'grouper',
    ws_path                 => 'grouper-ws',
    grouper_user            => 'tomcat',
    grouper_group           => 'tomcat',
    detect_utf8_problems    => false,
    log_driver_mismatch     => false,
    db_password             => $db_password


If default => true then grouper::instance will create GROUPER_HOME env var. Requires module

If manage_tomcat => true then grouper and grouper::instance will manage tomcat configs. Requires module


A puppet module to manage Internet2 Grouper configuration and related Tomcat setup.




No releases published


No packages published