Puppet Class: svn

Inherits:
svn::params
Inherited by:
svn::spec
Defined in:
manifests/init.pp

Overview

Class: svn

This is the main svn class

Parameters

Standard class parameters Define the general class behaviour and customizations

my_class

Name of a custom class to autoload to manage module’s customizations If defined, svn class will automatically “include $my_class” Can be defined also by the (top scope) variable $svn_myclass

source

Sets the content of source parameter for main configuration file If defined, svn main config file will have the param: source => $source Can be defined also by the (top scope) variable $svn_source

source_dir

If defined, the whole svn configuration directory content is retrieved recursively from the specified source (source => $source_dir , recurse => true) Can be defined also by the (top scope) variable $svn_source_dir

source_dir_purge

If set to true (default false) the existing configuration directory is mirrored with the content retrieved from source_dir (source => $source_dir , recurse => true , purge => true) Can be defined also by the (top scope) variable $svn_source_dir_purge

template

Sets the path to the template to use as content for main configuration file If defined, svn main config file has: content => content(“$template”) Note source and template parameters are mutually exclusive: don’t use both Can be defined also by the (top scope) variable $svn_template

options

An hash of custom options to be used in templates for arbitrary settings. Can be defined also by the (top scope) variable $svn_options

version

The package version, used in the ensure parameter of package type. Default: present. Can be ‘latest’ or a specific version number. Note that if the argument absent (see below) is set to true, the package is removed, whatever the value of version parameter.

absent

Set to ‘true’ to remove package(s) installed by module Can be defined also by the (top scope) variable $svn_absent

audit_only

Set to ‘true’ if you don’t intend to override existing configuration files and want to audit the difference between existing files and the ones managed by Puppet. Can be defined also by the (top scope) variables $svn_audit_only and $audit_only

noops

Set noop metaparameter to true for all the resources managed by the module. Basically you can run a dryrun for this specific module if you set this to true. Default: false

Default class params - As defined in svn::params. Note that these variables are mostly defined and used in the module itself, overriding the default values might not affected all the involved components. Set and override them only if you know what you’re doing. Note also that you can’t override/set them via top scope variables.

package

The name of svn package

config_dir

Main configuration directory. Used by puppi

config_file

Main configuration file path

Examples

You can use this class in 2 ways:

  • Set variables (at top scope level on in a ENC) and “include svn”

  • Call svn as a parametrized class

See README for details.

Parameters:

  • my_class (Any) (defaults to: params_lookup( 'my_class' ))
  • source (Any) (defaults to: params_lookup( 'source' ))
  • source_dir (Any) (defaults to: params_lookup( 'source_dir' ))
  • source_dir_purge (Any) (defaults to: params_lookup( 'source_dir_purge' ))
  • template (Any) (defaults to: params_lookup( 'template' ))
  • options (Any) (defaults to: params_lookup( 'options' ))
  • version (Any) (defaults to: params_lookup( 'version' ))
  • absent (Any) (defaults to: params_lookup( 'absent' ))
  • audit_only (Any) (defaults to: params_lookup( 'audit_only' , 'global' ))
  • noops (Any) (defaults to: params_lookup( 'noops' ))
  • package (Any) (defaults to: params_lookup( 'package' ))
  • config_dir (Any) (defaults to: params_lookup( 'config_dir' ))
  • config_file (Any) (defaults to: params_lookup( 'config_file' )) 


89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'manifests/init.pp', line 89

class svn (
  $my_class            = params_lookup( 'my_class' ),
  $source              = params_lookup( 'source' ),
  $source_dir          = params_lookup( 'source_dir' ),
  $source_dir_purge    = params_lookup( 'source_dir_purge' ),
  $template            = params_lookup( 'template' ),
  $options             = params_lookup( 'options' ),
  $version             = params_lookup( 'version' ),
  $absent              = params_lookup( 'absent' ),
  $audit_only          = params_lookup( 'audit_only' , 'global' ),
  $noops               = params_lookup( 'noops' ),
  $package             = params_lookup( 'package' ),
  $config_dir          = params_lookup( 'config_dir' ),
  $config_file         = params_lookup( 'config_file' )
  ) inherits svn::params {

  $config_file_mode=$svn::params::config_file_mode
  $config_file_owner=$svn::params::config_file_owner
  $config_file_group=$svn::params::config_file_group

  $bool_source_dir_purge=any2bool($source_dir_purge)
  $bool_absent=any2bool($absent)
  $bool_audit_only=any2bool($audit_only)
  $bool_noops=any2bool($noops)

  ### Definition of some variables used in the module
  $manage_package = $svn::bool_absent ? {
    true  => 'absent',
    false => $svn::version,
  }

  $manage_file = $svn::bool_absent ? {
    true    => 'absent',
    default => 'present',
  }

  $manage_audit = $svn::bool_audit_only ? {
    true  => 'all',
    false => undef,
  }

  $manage_file_replace = $svn::bool_audit_only ? {
    true  => false,
    false => true,
  }

  $manage_file_source = $svn::source ? {
    ''        => undef,
    default   => $svn::source,
  }

  $manage_file_content = $svn::template ? {
    ''        => undef,
    default   => template($svn::template),
  }

  ### Managed resources
  package { $svn::package:
    ensure  => $svn::manage_package,
    noop    => $svn::bool_noops,
  }

  file { 'svn.conf':
    ensure  => $svn::manage_file,
    path    => $svn::config_file,
    mode    => $svn::config_file_mode,
    owner   => $svn::config_file_owner,
    group   => $svn::config_file_group,
    require => Package[$svn::package],
    source  => $svn::manage_file_source,
    content => $svn::manage_file_content,
    replace => $svn::manage_file_replace,
    audit   => $svn::manage_audit,
    noop    => $svn::bool_noops,
  }

  # The whole svn configuration directory can be recursively overriden
  if $svn::source_dir {
    file { 'svn.dir':
      ensure  => directory,
      path    => $svn::config_dir,
      require => Package[$svn::package],
      source  => $svn::source_dir,
      recurse => true,
      purge   => $svn::bool_source_dir_purge,
      force   => $svn::bool_source_dir_purge,
      replace => $svn::manage_file_replace,
      audit   => $svn::manage_audit,
      noop    => $svn::bool_noops,
    }
  }


  ### Include custom class if $my_class is set
  if $svn::my_class {
    include $svn::my_class
  }

}