Skip to content

Latest commit

 

History

History
526 lines (273 loc) · 8.35 KB

REFERENCE.md

File metadata and controls

526 lines (273 loc) · 8.35 KB
Raw

Reference

Table of Contents

Classes

Public Classes

  • gerrit: Install and configure Gerrit

Private Classes

  • gerrit::params: It sets variables according to platform.

Defined types

Classes

gerrit

Install and configure Gerrit

Examples

Install gerrit
class { 'gerrit':
   source => '/vagrant/gerrit-2.8.1.war',
   target => '/opt/gerrit'
}

Parameters

The following parameters are available in the gerrit class.

source

Data type: Any

The path to the gerrit.war file

target

Data type: Any

The path to install gerrit to

auth_type

Data type: Any

Auth type (ldap, http, ...)

Default value: 'OPENID'

canonicalweburl

Data type: Any

Canonical web url used in several places by gerrit

Default value: 'http://127.0.0.1:8080/'

httpd_protocol

Data type: Any

The protocol used by gerrit. Options : http, https, proxy-http, proxy-https

Default value: 'http'

httpd_hostname

Data type: Any

The hostname on wich gerrit will be reachable. Default any.

Default value: '*'

httpd_port

Data type: Any

The port on wich gerrit will be reachable

Default value: 8080

configure_gitweb

Data type: Any

Should we adapt gerrit configuration to support gitweb. Boolean.

Default value: true

database_backend

Data type: Any

Database backend. currently mysql and h2 are supported

Default value: 'h2'

database_hostname

Data type: Any

Database hostname (mysql)

Default value: undef

database_name

Data type: Any

Database name (h2 and mysql)

Default value: 'db/ReviewDB'

database_password

Data type: Any

Database name (mysql)

Default value: undef

database_username

Data type: Any

Database username (mysql)

Default value: undef

download_scheme

Data type: Any

Download scheme (ssh, http, ...)

Default value: ['ssh', 'anon_http', 'http']

git_package

Data type: Any

The name of the git package

Default value: $gerrit::params::git_package

gitweb_cgi_path

Data type: Any

Path to the gitweb cgi executable

Default value: $gerrit::params::gitweb_cgi_path

gitweb_package

Data type: Any

The name of the gitweb package

Default value: $gerrit::params::gitweb_package

java_package

Data type: Any

The name of the java package

Default value: $gerrit::params::java_package

install_user

Data type: Any

Should this module create the user. Boolean

Default value: true

install_git

Data type: Any

Should this module install git. Boolean

Default value: true

install_gitweb

Data type: Any

Should this module install gitweb. Boolean

Default value: true

install_java

Data type: Any

Should this module install java. Boolean

Default value: true

install_java_mysql

Data type: Any

Should this module install java mysql connector. Boolean

Default value: true

ldap_accountbase

Data type: Any

The base dn for the accounts

Default value: undef

ldap_accountpattern

Data type: Any

The query pattern to use when searching for a user account. format like "(&(objectClass=inetOrgPerson)(cn=${username}))"

Default value: undef

ldap_accountemailaddress

Data type: Any

The name of an attribute on the user account object which contains the user's Internet email address format like "mail"

Default value: undef

ldap_accountfullname

Data type: Any

The name of an attribute on the user account object which contains the groups the user is part of format like "memberOf"

Default value: undef

ldap_accountmemberfield

Data type: Any

The name of an attribute on the user account object which contains the groups the user is part of. Typically used for Active Directory and FreeIPA servers.

Default value: undef

ldap_accountsshusername

Data type: Any

The name of an attribute on the user account object which contains the initial value for the user's SSH username field in Gerrit format like "cn"

Default value: undef

ldap_groupbase

Data type: Any

The base dn for the groups

Default value: undef

ldap_groupname

Data type: Any

Name of the attribute on the group object which contains the value to use as the group name in Gerrit

Default value: undef

ldap_grouppattern

Data type: Any

Query pattern used when searching for an LDAP group to connect to a Gerrit group.

Default value: undef

ldap_groupmemberpattern

Data type: Any

Query pattern to use when searching for the groups that a user account is currently a member of

Default value: undef

ldap_password

Data type: Any

The ldap password to bind to

Default value: undef

ldap_server

Data type: Any

The ldap server address

Default value: undef

ldap_sslverify

Data type: Any

If false and $ldap_server is an ldaps:// style URL, Gerrit will not verify the server certificate when it connects to perform a query.

Default value: undef

ldap_timeout

Data type: Any

The read timeout for an LDAP operation. The value is in the usual time-unit format like "1 s", "100 ms", etc..

Default value: undef

ldap_username

Data type: Any

The ldap user to bind to

Default value: undef

mysql_java_connector

Data type: Any

The name of the java connector file

Default value: $gerrit::params::mysql_java_connector

mysql_java_package

Data type: Any

The name of the java connector package

Default value: $gerrit::params::mysql_java_package

manage_service

Data type: Any

Should this module launch the service.

Default value: true

user

Data type: Any

The user used to install gerrit

Default value: 'gerrit'

extra_folders

Data type: Any

Extra folder to create on gerrit home directory

Default value: ['hooks', 'plugins']

Defined types

gerrit::config

Set git config attributes

Parameters

The following parameters are available in the gerrit::config defined type.

name

The attribute name

value

Data type: Any

The value of thie git config attribute.

ensure

Data type: Any

Manage the state of this git config attribute.

Default value: present

file

Data type: Any

The file in which the git config attribute should be set.

Default value: "${gerrit::target}/etc/gerrit.config"

gerrit::folder

Define to create directories inside gerrit target path

Parameters

The following parameters are available in the gerrit::folder defined type.

name

The folder name

ensure

Data type: Any

Manage the state of this directory inside gerrit target path

Default value: 'directory'

gerrit::hook

Define to create gerrit hook

Parameters

The following parameters are available in the gerrit::hook defined type.

name

The hook name

ensure

Data type: Any

Manage the state of this gerrit hook.

Default value: 'present'

source

Data type: Any

The source of this hook. Can be any value valid for the file source parameter.

Default value: undef

content

Data type: Any

The content of this hook. Can be any value valid for the file content parameter.

Default value: undef

gerrit::plugin

Define to install gerrit plugins

Parameters

The following parameters are available in the gerrit::plugin defined type.

name

The plugin name

source

Data type: Any

The source of this plugins. Can be any value valid for the file source parameter.

ensure

Data type: Any

Manage the state of this gerrit plugin.

Default value: 'present'

gerrit::repository

Define to create empty git bare repositories

Parameters

The following parameters are available in the gerrit::repository defined type.

name

The repository name