- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with galaxy
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
This module installs and configures a galaxy instance.
Galaxy is "an open, web-based platform for accessible, reproducible, and transparent computational biomedical research". (https://galaxyproject.org/) This module helps to simplify the installation, configuration, and service management of a locally installed instance of Galaxy.
- A list of files, packages, services, or operations that the module will alter, impact, or execute on the system it's installed on.
- This is a great place to stick any warnings.
- Can be in list or paragraph form.
If your module requires anything extra before setting up (pluginsync enabled, etc.), mention it here.
include '::galaxy' is enough to get you up and running. To pass in parameters:
class { '::galaxy':
foo => 'bar',
}
All parameters for the galaxy module should be included as part of the ::galaxy class. If not, then that is a bug and not intended.
- galaxy: Main class which includes all other classes.
- galaxy::install: Handles installation of Galaxy
- galaxy::config: Handles configuraitoin files
- galaxy::service: Handles service definitions
The following parameters are available in the ::galaxy class:
This module is tested for RHEL/CentOS 7 and the 17.05 version of galaxy. The module is setup with hiera 5 data usage so Puppet 4.9 or higher is neeed.
New contributions are welcome! Those that include documentation and rspec tests are even more welcome! The module was originally generated using Gareth Rushgrove's puppet-module-skeleton repository (https://github.com/garethr/puppet-module-skeleton). However, the Gemfile is from the VoxPupuli project (https://voxpupuli.org/). The version of ruby for development work with the Gemfile was 2.3.1. Other versions may work with modifications to the Gemfile.