Puppet Class: irqbalance

Inherits:
irqbalance::params
Inherited by:
irqbalance::config
irqbalance::install
irqbalance::service
irqbalance::initscripts
Defined in:
manifests/init.pp

Overview

Class: irqbalance

This module installs and manages the irqbalance daemon. It will accept any option or environment variable that irqbalance supports and will simply ignore anything not supported by the default irqbalance version that comes with the distribution.

Usage

include ‘::irqbalance’

See the README.md for the full list of parameters

Parameters:

  • affinity_mask (Any) (defaults to: $irqbalance::params::affinity_mask)
  • args (Any) (defaults to: $irqbalance::params::args)
  • args_regex (Any) (defaults to: $irqbalance::params::args_regex)
  • banirq (Any) (defaults to: $irqbalance::params::banirq)
  • banned_cpus (Any) (defaults to: $irqbalance::params::banned_cpus)
  • banned_interrupts (Any) (defaults to: $irqbalance::params::banned_interrupts)
  • banscript (Any) (defaults to: $irqbalance::params::banscript)
  • config_dir_path (Any) (defaults to: $irqbalance::params::config_dir_path)
  • config_file_group (Any) (defaults to: $irqbalance::params::config_file_group)
  • config_file_mode (Any) (defaults to: $irqbalance::params::config_file_mode)
  • config_file_name (Any) (defaults to: $irqbalance::params::config_file_name)
  • config_file_owner (Any) (defaults to: $irqbalance::params::config_file_owner)
  • config_file_source (Any) (defaults to: $irqbalance::params::config_file_source)
  • config_file_template (Any) (defaults to: $irqbalance::params::config_file_template)
  • deepestcache (Any) (defaults to: $irqbalance::params::deepestcache)
  • debug (Any) (defaults to: $irqbalance::params::debug)
  • dependency_class (Any) (defaults to: $irqbalance::params::dependency_class)
  • hintpolicy (Any) (defaults to: $irqbalance::params::hintpolicy)
  • irqbalance_path (Any) (defaults to: $irqbalance::params::irqbalance_path)
  • manage_init_script_file (Any) (defaults to: $irqbalance::params::manage_init_script_file)
  • oneshot (Any) (defaults to: $irqbalance::params::oneshot)
  • package_ensure (Any) (defaults to: $irqbalance::params::package_ensure)
  • package_manage (Any) (defaults to: $irqbalance::params::package_manage)
  • package_name (Any) (defaults to: $irqbalance::params::package_name)
  • pid (Any) (defaults to: $irqbalance::params::pid)
  • policyscript (Any) (defaults to: $irqbalance::params::policyscript)
  • powerthresh (Any) (defaults to: $irqbalance::params::powerthresh)
  • service_enable (Any) (defaults to: $irqbalance::params::service_enable)
  • service_ensure (Any) (defaults to: $irqbalance::params::service_ensure)
  • service_manage (Any) (defaults to: $irqbalance::params::service_manage)
  • service_name (Any) (defaults to: $irqbalance::params::service_name)
  • service_provider (Any) (defaults to: $irqbalance::params::service_provider)
  • systemd_dir_path (Any) (defaults to: $irqbalance::params::systemd_dir_path)
  • systemd_init_script_file_group (Any) (defaults to: $irqbalance::params::systemd_init_script_file_group)
  • systemd_init_script_file_mode (Any) (defaults to: $irqbalance::params::systemd_init_script_file_mode)
  • systemd_init_script_file_owner (Any) (defaults to: $irqbalance::params::systemd_init_script_file_owner)
  • systemd_init_script_file_source (Any) (defaults to: $irqbalance::params::systemd_init_script_file_source)
  • systemd_init_script_file_template (Any) (defaults to: $irqbalance::params::systemd_init_script_file_template)
  • sysv_init_script_file_group (Any) (defaults to: $irqbalance::params::sysv_init_script_file_group)
  • sysv_init_script_file_mode (Any) (defaults to: $irqbalance::params::sysv_init_script_file_mode)
  • sysv_init_script_file_owner (Any) (defaults to: $irqbalance::params::sysv_init_script_file_owner)
  • sysv_init_script_file_source (Any) (defaults to: $irqbalance::params::sysv_init_script_file_source)
  • sysv_init_script_file_template (Any) (defaults to: $irqbalance::params::sysv_init_script_file_template)
  • upstart_init_script_file_group (Any) (defaults to: $irqbalance::params::upstart_init_script_file_group)
  • upstart_init_script_file_mode (Any) (defaults to: $irqbalance::params::upstart_init_script_file_mode)
  • upstart_init_script_file_owner (Any) (defaults to: $irqbalance::params::upstart_init_script_file_owner)
  • upstart_init_script_file_source (Any) (defaults to: $irqbalance::params::upstart_init_script_file_source)
  • upstart_init_script_file_template (Any) (defaults to: $irqbalance::params::upstart_init_script_file_template) 


14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
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
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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'manifests/init.pp', line 14

class irqbalance (
  $affinity_mask                     = $irqbalance::params::affinity_mask,
  $args                              = $irqbalance::params::args,
  $args_regex                        = $irqbalance::params::args_regex,
  $banirq                            = $irqbalance::params::banirq,
  $banned_cpus                       = $irqbalance::params::banned_cpus,
  $banned_interrupts                 = $irqbalance::params::banned_interrupts,
  $banscript                         = $irqbalance::params::banscript,
  $config_dir_path                   = $irqbalance::params::config_dir_path,
  $config_file_group                 = $irqbalance::params::config_file_group,
  $config_file_mode                  = $irqbalance::params::config_file_mode,
  $config_file_name                  = $irqbalance::params::config_file_name,
  $config_file_owner                 = $irqbalance::params::config_file_owner,
  $config_file_source                = $irqbalance::params::config_file_source,
  $config_file_template              = $irqbalance::params::config_file_template,
  $deepestcache                      = $irqbalance::params::deepestcache,
  $debug                             = $irqbalance::params::debug,
  $dependency_class                  = $irqbalance::params::dependency_class,
  $hintpolicy                        = $irqbalance::params::hintpolicy,
  $irqbalance_path                   = $irqbalance::params::irqbalance_path,
  $manage_init_script_file           = $irqbalance::params::manage_init_script_file,
  $oneshot                           = $irqbalance::params::oneshot,
  $package_ensure                    = $irqbalance::params::package_ensure,
  $package_manage                    = $irqbalance::params::package_manage,
  $package_name                      = $irqbalance::params::package_name,
  $pid                               = $irqbalance::params::pid,
  $policyscript                      = $irqbalance::params::policyscript,
  $powerthresh                       = $irqbalance::params::powerthresh,
  $service_enable                    = $irqbalance::params::service_enable,
  $service_ensure                    = $irqbalance::params::service_ensure,
  $service_manage                    = $irqbalance::params::service_manage,
  $service_name                      = $irqbalance::params::service_name,
  $service_provider                  = $irqbalance::params::service_provider,
  $systemd_dir_path                  = $irqbalance::params::systemd_dir_path,
  $systemd_init_script_file_group    = $irqbalance::params::systemd_init_script_file_group,
  $systemd_init_script_file_mode     = $irqbalance::params::systemd_init_script_file_mode,
  $systemd_init_script_file_owner    = $irqbalance::params::systemd_init_script_file_owner,
  $systemd_init_script_file_source   = $irqbalance::params::systemd_init_script_file_source,
  $systemd_init_script_file_template = $irqbalance::params::systemd_init_script_file_template,
  $sysv_init_script_file_group       = $irqbalance::params::sysv_init_script_file_group,
  $sysv_init_script_file_mode        = $irqbalance::params::sysv_init_script_file_mode,
  $sysv_init_script_file_owner       = $irqbalance::params::sysv_init_script_file_owner,
  $sysv_init_script_file_source      = $irqbalance::params::sysv_init_script_file_source,
  $sysv_init_script_file_template    = $irqbalance::params::sysv_init_script_file_template,
  $upstart_init_script_file_group    = $irqbalance::params::upstart_init_script_file_group,
  $upstart_init_script_file_mode     = $irqbalance::params::upstart_init_script_file_mode,
  $upstart_init_script_file_owner    = $irqbalance::params::upstart_init_script_file_owner,
  $upstart_init_script_file_source   = $irqbalance::params::upstart_init_script_file_source,
  $upstart_init_script_file_template = $irqbalance::params::upstart_init_script_file_template,
) inherits irqbalance::params {

  if $dependency_class {
    require $dependency_class
  }

  case $service_provider {
    /(debian|openrc|redhat)/: {
      $init_script_file_group    = $sysv_init_script_file_group
      $init_script_file_mode     = $sysv_init_script_file_mode
      $init_script_file_owner    = $sysv_init_script_file_owner
      $init_script_file_path     = "/etc/init.d/${irqbalance::service_name}"
      $init_script_file_source   = $sysv_init_script_file_source
      $init_script_file_template = $sysv_init_script_file_template
    }
    'systemd': {
      $init_script_file_group    = $systemd_init_script_file_group
      $init_script_file_mode     = $systemd_init_script_file_mode
      $init_script_file_owner    = $systemd_init_script_file_owner
      $init_script_file_path     = "${irqbalance::systemd_dir_path}/${irqbalance::service_name}.service"
      $init_script_file_source   = $systemd_init_script_file_source
      $init_script_file_template = $systemd_init_script_file_template

      file { $systemd_dir_path:
        ensure => 'directory',
        group  => 'root',
        mode   => '2755',
      }

    }
    'upstart': {
      $init_script_file_group    = $upstart_init_script_file_group
      $init_script_file_mode     = $upstart_init_script_file_mode
      $init_script_file_owner    = $upstart_init_script_file_owner
      $init_script_file_path     = "/etc/init/${irqbalance::service_name}.conf"
      $init_script_file_source   = $upstart_init_script_file_source
      $init_script_file_template = $upstart_init_script_file_template
    }
    default: {
      fail('An unknown Puppet service_provider parameter was provided')
    }
  }

  validate_absolute_path($config_dir_path)
  validate_re($config_file_mode, '[0-7]{3,4}', 'An invalid config file mode value was provided.')
  validate_string($config_file_owner)
  validate_re($init_script_file_mode, '[0-7]{3,4}', 'An invalid init file mode value was provided.')
  validate_absolute_path($init_script_file_path)

  if ($init_script_file_source) {
    validate_string($init_script_file_source)
  }

  if ($init_script_file_template) {
    validate_string($init_script_file_template)
  }

  validate_string($package_ensure)
  validate_bool($package_manage)
  validate_array($package_name)
  validate_bool($manage_init_script_file)
  validate_bool($service_enable)
  validate_re($service_ensure, '^(running|stopped|true|false)$', 'The service_ensure value was invalid.')
  validate_bool($service_manage)
  validate_string($service_name)
  validate_string($service_provider)

  if !$config_file_source {

    # Validate the environment variables for the configuration file if using a template

    if $affinity_mask {
      validate_array($affinity_mask)
      $affinity_mask_args = join($affinity_mask, ',')
      validate_re($affinity_mask_args, '^([0-9a-fA-F]+(,[0-9a-fA-F]+)*)$', 'An invalid affinity_mask value was provided.')
    }

    if $banned_cpus {
      validate_array($banned_cpus)
      $banned_cpus_args = join($banned_cpus, ',')
      validate_re($banned_cpus_args, '^([0-9a-fA-F]+(,[0-9a-fA-F]+)*)$', 'An invalid banned_cpu value was provided.')
    }

    if $banned_interrupts {
      validate_array($banned_interrupts)
      $banned_interrupts_args = join($banned_interrupts, ' ')
      validate_re($banned_interrupts_args, '^(\d{2}(\s\d{2})*)$', 'One or more invalid banned_interrupts values were provided.')
    }

    $bool_oneshot = str2bool($oneshot)

    # If a full set of options have been provided, each option will not be validated

    if $args {
      validate_string($args)
      $real_args = $args
    }

    else {

      # Check each irqbalance option that has been provided

      if $banirq {
        validate_array($banirq)
        # The banirq irqbalance option is additive only
        $banirq_withopt = prefix($banirq, '--banirq=')
        $banirq_args = join($banirq_withopt, ' ')
        validate_re($banirq_args, '^(--banirq=\d{2}(\s--banirq=\d{2})*)$', 'One or more invalid banirq values were provided.')
      }

      if $banscript {
        validate_absolute_path($banscript)
      }

      if $deepestcache {
        validate_re($deepestcache, '[1-9]\d*', 'The deepestcache option value must be a positive integer.')
      }

      if $debug {
        validate_bool($debug)
      }

      if $hintpolicy {
        validate_re($hintpolicy, '^(exact|subset|ignore)$', 'The hintpolicy option value must be either exact, subset or ignore.')
      }

      if $pid {
        validate_absolute_path($pid)
      }

      if $policyscript {
        validate_absolute_path($policyscript)
      }

      if $powerthresh {
        validate_re($powerthresh, '[\d]+', 'The powerthresh option value must be an integer.')
      }

      $real_debug_string = $debug ? {
        true    => '--debug',
        default => '',
      }

      # Join options together only if the irqbalance version on this
      # operating system accepts them
      $arg_commands = [
        $banirq_args,
        "--banscript=${banscript}",
        $real_debug_string,
        "--deepestcache=${deepestcache}",
        "--hintpolicy=${hintpolicy}",
        "--pid=${pid}",
        "--policyscript=${policyscript}",
        "--powerthresh=${powerthresh}",
        ]

      $acceptable_args = grep($arg_commands, $args_regex)

      if !empty($acceptable_args) {
        $real_args = join($acceptable_args, ' ')
      }

    }
  }

  anchor { 'irqbalance::begin':
    before => Class['::irqbalance::install'],
  }

  class { '::irqbalance::install':
    before => [
    Class['::irqbalance::config'],
    Class['::irqbalance::initscripts'],
    ],
  }

  class { '::irqbalance::config':
    notify => Class['::irqbalance::service'],
  }

  class { '::irqbalance::initscripts':
    notify => Class['::irqbalance::service'],
  }

  class { '::irqbalance::service': } ->
  anchor { 'irqbalance::end': }

}