- Description
- Setup - The basics of getting started with irida
- Usage - Configuration options and additional functionality
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
The IRIDA module lets you use Puppet to install, deploy, and configure IRIDA web server (Alpha status)
The IRIDA module requires puppetlabs-stdlib version 4.0 or newer, puppetlabs-tomcat version 3.1 or newer , puppetlabs-mysql version 5.4 or newer and puppet-firewalld version 4.3.0 or newer.
The simplest way to get IRIDA up and running with the IRIDA module is to run without any argument for installation
include '::irida'
Puppet Bolt is required to use the upgrade task.
The upgrade
task included in this module can be used to upgrade the IRIDA
instance to a newer version. This task accepts no parameters and instead
relies on the file managed by the module located at /etc/irida/irida_upgrade.config
on the target host, allowing for the upgrade process to automatically retrieve
credentials and other information that it requires.
In order to perform a system upgrade using the upgrade
task and Puppet Bolt:
- Apply the IRIDA module with the
irida_version
parameter set to the version of IRIDA that you wish to upgrade to. See available version numbers on the IRIDA download page. - Run the upgrade task using Puppet Bolt:
bolt task run -i <inventory file> -t <target host> irida::upgrade
The upgrade task performs the following actions:
- Stop the
puppet
andtomcat
services - Dump the database to a backup file located at
/tmp/irida-<date>.dbbackup
by default - Delete the old
irida.war
file and replaces it with the version specified - Start the
puppet
services
In the Limitations section, list any incompatibilities, known issues, or other warnings.
In the Development section, tell other users the ground rules for contributing to your project and how they should submit their work.