Forge Home

reviewboard

Install and control reviewboard

11,255 downloads

11,026 latest version

3.4 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 1.0.1 (latest)
  • 1.0.0
released Mar 13th 2014

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'saw-reviewboard', '1.0.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add saw-reviewboard
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install saw-reviewboard --version 1.0.1

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

saw/reviewboard — version 1.0.1 Mar 13th 2014

Puppet Reviewboard

Manage an install of Reviewboard

To install include the package 'reviewboard' in your manifest

Optionally you can install the RBtool package for submitting reviews by including 'reviewboard::rbtool'

Pre-Requisites

Puppet module pre-requisites are managed using librarian-puppet

Additionally the following optional prerequisites may be installed:

  • memcached & python-memcached for website caching
  • python bindings for your database (if not installed by the dbprovider)

Usage

Create a reviewboard site based at '/var/www/reviewboard', available at ${::fqdn}/reviewboard:

reviewboard::site {'/var/www/reviewboard':
    vhost    => "${::fqdn}",
    location => '/reviewboard'
}

You can change how the sites are configured with the 'provider' arguments to the reviewboard class.

webprovider:

  • puppetlabs/apache: Use puppetlabs/apache to create an Apache vhost
  • simple: Copy the apache config file generated by reviewboard & set up a basic Apache server
  • none: No web provisioning is done

dbprovider:

  • puppetlabs/postgresql: Use the puppetlabs/postgresql module to create database tables & install bindings
  • none: No DB provisioning is done (note a database is required for the install to work)

The default settings are

class reviewboard {
    webprovider => 'puppetlabs/apache',
    dbprovider  => 'puppetlabs/postgresql'
}

To use a custom web provider set the 'webuser' parameter & subscribe the web service to reviewboard::provider::web<||>:

class reviewboard {
    webprovider => 'none',
    webuser     => 'apache',
}
Reviewboard::Provider::Web<||> ~> Service['apache']

You will then need to manually configure your web server, Reviewboard generates an example Apache config file in ${site}/conf/apache-wsgi.conf.

Other Features

  • RBTool: Reviewboard command-line interface. To install:

     include reviewboard::rbtool
    
  • Trac integration: The traclink Reviewboard plugin posts a notice on a Trac ticket whenever the 'Bug' field is set in a review. To install:

     package {trac: } # Make sure Trac is installed via Puppet
     include reviewboard::traclink
    

    There is also some setup required in your site's trac.ini:

     [ticket-custom]
     reviews = text
     reviews.format = wiki
     [interwiki]
     review = //reviewboard/r/
    

Testing

Integration tests make use of serverspec to check the module is applied properly on a Vagrant VM.

To setup tests

$ gem install bundler
$ bundle install --path vendor/bundle

then to run the tests

$ bundle exec rake

Use vagrant destroy to stop the test VM.