Forge Home

opengrok

Module to install and configure OpenGrok

8,121 downloads

6,612 latest version

4.6 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.

Version information

  • 0.2.0 (latest)
  • 0.1.5
  • 0.1.4
  • 0.1.3
  • 0.1.2
  • 0.1.1
  • 0.1.0
released Mar 28th 2017
This version is compatible with:

Start using this module

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

Add this module to your Puppetfile:

mod 'jconway-opengrok', '0.2.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add jconway-opengrok
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install jconway-opengrok --version 0.2.0

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

jconway/opengrok — version 0.2.0 Mar 28th 2017

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with opengrok
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module

Overview

This module installs and configures a basic OpenGrok instance. Currently it is only tested with Puppet > 4.2 and CentOS 7.x but with a little work it should be easily extendable to other systems. (Pull requests welcome!)

Module Description

The basic class ::opengrok will install and configure OpenGrok at http://${::fqdn}:8080/source it is reccomended to use a profile/role to put a reverse proxy infront of this.

You can add source repos to browse with OpenGrok by defining them with the opengrok::projects parameter hash or adding them with the opengrok::project defined type.

Setup

What opengrok affects

  • A list of files, packages, services, or operations that the module will alter, impact, or execute on the system it's installed on.
  • Created Files/Directories:
    • /var/opengrok
    • /opt/opengrok
  • Default installed packages:
    • ctags (CentOS)
  • Other modules included with default options:

Setup Requirements

You should have pluginsync enabled in your Puppet environment.

Beginning with opengrok

All you need to do to get a running OpenGrok instance is

include ::opengrok

and to define at least one source either with the ::opengrok::projects parameter hash or with the opengrok::project defined type

Parameter Hash Examples

Puppet DSL
opengrok::projects {
  puppet-opengrok => {
    source        => 'https://github.com/jordanconway/puppet-opengrok.git',
    ensure        => 'latest',
  },
  opengrok        => {
    source        => 'https://github.com/OpenGrok/OpenGrok.git',
    ensure        => 'latest',
  }
}

Hiera

opengrok::projects:
  puppet-opengrok:
    source: 'https://github.com/jordanconway/puppet-opengrok.git'
    ensure: 'latest'
  opengrok:
    source: 'https://github.com/OpenGrok/OpenGrok.git'
    ensure: 'latest'

Defined type Examples

  opengrok::project{ 'puppet-opengrok':
    source => 'https://github.com/jordanconway/puppet-opengrok.git',
    ensure => 'latest',
  }

Usage

Pretty straight forward and explained in the above section.

Reference

This module is documented with puppet-strings you can build the documentation yourself with puppet-strings or see it on my github pages

Limitations

Currently only tested and expected to work with Puppet > 4.2 and CentOS 7.x

Development

Pull request welcome at https://github.com/jordanconway/puppet-opengrok/ (DCO commits are appreciated)