Puppet Class: opengrok

Inherits:
::opengrok::params
Defined in:
manifests/init.pp

Overview

Class: opengrok

This is the basic class needed to install and configure an OpenGrok instance.

}

Examples:

Declaring the class

include opengrok

Defining the opengrok::projects Hash with two git projects

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

Parameters:

  • download_url (Pattern[/^https?[^\s]*(\.zip|tar\.gz)$/]) (defaults to: $::opengrok::params::download_url) —

    Specifies the url to download the OpenGrok binaries from. Valid options: A String (containing an url pointing to a .zip/tar.gz binary release from https://github.com/OpenGrok/OpenGrok/releases/). Example Value: 'https://github.com/OpenGrok/OpenGrok/files/467358/opengrok-0.12.1.6.tar.gz.zip'.

  • manage_git (Boolean) (defaults to: $::opengrok::params::manage_git) —

    Specifies wether or not to manage git, if true it will include ::git. Valid options: true, false. Example Value: true.

  • manage_tomcat (Boolean) (defaults to: $::opengrok::params::manage_tomcat) —

    Specifies wether or not to manage tomcat, if true it will include ::tomcat. Valid options: true, false. Example Value: true.

  • service_name (String) (defaults to: $::opengrok::params::service_name) —

    Specifies the service name for tomcat. Valid options: A string. Example Value: tomcat

  • install_ctags (Boolean) (defaults to: $::opengrok::params::install_ctags) —

    Specifies wether or not to install ctags, will install system ctags package if true. Valid options: true, false. Example Value: true.

  • ctags_package (String) (defaults to: $::opengrok::params::ctags_package) —

    Specifies the name of the system ctags package. Valid options: String of package name. Example Value: 'ctags'

  • opengrok_dir (Stdlib::Absolutepath) (defaults to: $::opengrok::params::opengrok_dir) —

    Specifies the directory to install the OpenGrok binaries to. Valid options: Absolute Path. Example Value: '/opt/opengrok'

  • projects (Optional[Hash]) (defaults to: $::opengrok::params::projects) —

    A hash of git projects to be served by OpenGrok. This can is an alternative to defining opengrok::project types Valid options: Hash

  • catalina_home (Stdlib::Absolutepath) (defaults to: $::opengrok::params::catalina_home) —

    Specifies the catalina_home directory of your tomcat install, ie: where the tomcat 'webapps' directory resides. Valid options: Absolute path. Example Value: '/var/lib/tomcat'

  • body_text (String) (defaults to: $::opengrok::params::body_text) —

    Replaces the default body text for opengrok on the main page. Valid options: String. Example Value: 'Check out our (defaults to: $::opengrok::params::config_hash) —

    Simple key => value hash for OpenGrok script environment variables Valid options: Hash. Example Value: { 'OPENGROK_SCAN_DEPTH' => '4' 'OPENGROK_VERBOSE' => 'yes' 'OPENGROK_PROGRESS' => 'yes' 'IGNORE_PATTERNS' => '-i bigfile.css'



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'manifests/init.pp', line 55

class opengrok (

  Pattern[/^https?[^\s]*(\.zip|tar\.gz)$/] $download_url = $::opengrok::params::download_url,
  Boolean $manage_git = $::opengrok::params::manage_git,
  Boolean $manage_tomcat = $::opengrok::params::manage_tomcat,
  String $service_name = $::opengrok::params::service_name,
  Boolean $install_ctags = $::opengrok::params::install_ctags,
  String $ctags_package = $::opengrok::params::ctags_package,
  Stdlib::Absolutepath $opengrok_dir = $::opengrok::params::opengrok_dir,
  Optional[Hash] $projects = $::opengrok::params::projects,
  Stdlib::Absolutepath $catalina_home = $::opengrok::params::catalina_home,
  String $body_text = $::opengrok::params::body_text,
  Optional[Hash] $config_hash = $::opengrok::params::config_hash,

) inherits ::opengrok::params {

  class { '::opengrok::install':
    manage_tomcat => $manage_tomcat,
    manage_git    => $manage_git,
    install_ctags => $install_ctags,
    ctags_package => $ctags_package,
  } ->
  class { '::opengrok::download':
    download_url => $download_url,
    opengrok_dir => $opengrok_dir,
  } ->
  class { '::opengrok::config':
    opengrok_dir  => $opengrok_dir,
    projects      => $projects,
    catalina_home => $catalina_home,
    body_text     => $body_text,
    config_hash   => $config_hash,
  } ->
  class { '::opengrok::service':
    service_name => $service_name,
  } ->
  Class['::opengrok']

}