https://github.com/broadinstitute/puppet-qpage
Puppet module for controlling the qpage service
Science Score: 36.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 3 committers (33.3%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.5%) to scientific vocabulary
Keywords from Contributors
Repository
Puppet module for controlling the qpage service
Basic Info
- Host: GitHub
- Owner: broadinstitute
- License: bsd-3-clause
- Language: Ruby
- Default Branch: main
- Size: 94.7 KB
Statistics
- Stars: 1
- Watchers: 24
- Forks: 0
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
puppet-qpage
Table of Contents
- Overview
- Module Description - Puppet module to control all aspects of the QPage service
- Setup - The basics of getting started with qpage
- 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
Overview
This module is designed to take care of installing and configuring the QPage service. QPage is an SNPP client/server for sending messages to an alpha-numeric pager.
Module Description
This module should correctly setup QPage on a given host. This includes:
- Package installation
- Service management
- Configuration management
Setup
What qpage affects
- packages:
- qpage
- services:
- qpage
- files:
- /usr/local/etc/qpage.conf
Setup Requirements OPTIONAL
librarian-puppet install --verbose --path=/etc/puppetlabs/code/modules
Note: this module requires the zleslie/pkgng module for controlling packages on FreeBSD.
Usage
To get a default qpage installation, you can simply include the class with all the defaults:
puppet
include ::qpage
The module allows you to remove the service completely if desired as well:
puppet
class { 'qpage':
config_ensure => 'absent',
package_ensure => 'absent',
service_ensure => 'stopped',
}
All the configuration options in the file are also configurable via options in the main qpage class:
puppet
class { 'qpage':
administrator => 'admin@example.com',
forcehostname => false,
identtimeout => 0,
modems => {
modem0 => {
device => '/dev/modem',
initcmd => 'ATZXXXXX',
}
},
pagers => {
pager1 => {
text => 'UserName',
pagerid => '5555551234',
service => 'servicename',
}
},
pidfile => '/var/run/qpage',
queuedir => '/var/spool/qpage',
service_defs => {
servicename => {
text => 'ServiceName',
device => 'modem0',
phone => '9,15555559876',
identfrom => 'false',
maxmsgsize => '160',
baudrate => '9600',
parity => 'even',
}
},
sigfile => '/dev/null',
}
You can also do the same using Hiera:
```yaml
qpage::administrator: 'admin@example.com' qpage::forcehostname: false qpage::identtimeout: 0 qpage::modems: modem0: device: '/dev/modem' initcmd: 'ATZXXXXX' qpage::pagers: pager1: text: 'UserName' pagerid: '5555551234' service: 'servicename' qpage::pidfile: '/var/run/qpage' qpage::queuedir: '/var/spool/qpage' qpage::service_defs: servicename: text: 'ServiceName' device: 'modem0' phone: '9,15555559876' identfrom: 'false' maxmsgsize: '160' baudrate: '9600' parity: 'even' qpage::sigfile: '/dev/null' ```
Reference
All the work for this module typicallly happens through the qpage class. No calls to the subclasses should be necessary as they are all controlled via the main init.pp file.
Limitations
This module is currently only supported on FreeBSD systems, since that is the only place I could find this package when writing this module. If you have any enhancements for different operating systems, bug fixes, etc., pull requests are always welcome.
Development
Refer to CONTRIBUTING.md
Owner
- Name: Broad Institute
- Login: broadinstitute
- Kind: organization
- Location: Cambridge, MA
- Website: http://www.broadinstitute.org/
- Twitter: broadinstitute
- Repositories: 1,083
- Profile: https://github.com/broadinstitute
Broad Institute of MIT and Harvard
GitHub Events
Total
- Watch event: 1
- Delete event: 9
- Issue comment event: 5
- Push event: 15
- Pull request review event: 5
- Pull request event: 20
- Create event: 11
Last Year
- Watch event: 1
- Delete event: 9
- Issue comment event: 5
- Push event: 15
- Pull request review event: 5
- Pull request event: 20
- Create event: 11
Committers
Last synced: about 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| Andrew Teixeira | t****a@b****g | 24 |
| dependabot[bot] | 4****] | 18 |
| backstage-bits[bot] | 1****] | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 11 months ago
All Time
- Total issues: 0
- Total pull requests: 47
- Average time to close issues: N/A
- Average time to close pull requests: 9 days
- Total issue authors: 0
- Total pull request authors: 3
- Average comments per issue: 0
- Average comments per pull request: 0.57
- Merged pull requests: 28
- Bot issues: 0
- Bot pull requests: 38
Past Year
- Issues: 0
- Pull requests: 14
- Average time to close issues: N/A
- Average time to close pull requests: 10 days
- Issue authors: 0
- Pull request authors: 3
- Average comments per issue: 0
- Average comments per pull request: 0.5
- Merged pull requests: 12
- Bot issues: 0
- Bot pull requests: 12
Top Authors
Issue Authors
Pull Request Authors
- dependabot[bot] (45)
- coreone (8)
- backstage-bits[bot] (2)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- rb-readline = 0.5.5 development
- actions/cache v3 composite
- actions/checkout v3 composite
- ruby/setup-ruby v1.134.0 composite
- actions/cache v3 composite
- actions/checkout v3 composite
- ruby/setup-ruby v1.134.0 composite
- puppet/pdk latest build