Version information
This version is compatible with:
- Puppet Enterprise 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >=3.8.7 < 5.0.0
- , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'juniorsysadmin-irqbalance', '1.1.0'Learn more about managing modules with a PuppetfileDocumentation
irqbalance
Table of Contents
Overview
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.
Unmanaged service states
This module will not manage the running state of the irqbalance service when
applied to a single processor system, or when oneshot is set to yes. In
these scenarios the service_ensure parameter is simply ignored.
Init scripts
The Upstart init script that was included with Ubuntu Trusty Tahr (14.04) does not seem to support the full set of options that the installed irqbalance version itself supports.
If manage_init_script_file is set to true, this module will generally
provide a sensible init script replacement for Ubuntu distributions.
Additionally, if you wish to provide your own init script you can do so by
passing the appropriate parameter:
eg. upstart_init_script_file_source or systemd_init_script_file_template.
This module will default to using the following init types to manage the service:
- CentOS/RHEL5 will use SysV init scripts.
- CentOS/RHEL6 will use SysV init scripts.
- CentOS/RHEL7 will use systemd.
- Fedora will use systemd.
- Debian 6 will use SysV init scripts.
- Debian 7 will use SysV init scripts.
- Ubuntu 10.04 will use Upstart.
- Ubuntu 12.04 will use Upstart.
- Ubuntu 14.04 will use Upstart.
- SLES 11 SP1 will use SysV init scripts.
- Gentoo will use OpenRC.
Debian 7 and Ubuntu 14.04 support systemd as a non-default init but note that neither come with an irqbalance service unit file. Examples of managing irqbalance under systemd on Debian/Ubuntu are shown below.
Usage
Install and run the irqbalance service using the distribution defaults:
include '::irqbalance'
Set the powerthresh option to 2 if the irqbalance version included with this distribution supports it:
class { '::irqbalance':
powerthresh => '2',
}
Set all of the irqbalance options at once: (These won't be checked to see if the installed irqbalance version supports them)
class { '::irqbalance':
args => '--powerthresh=2 --deepestcache=2',
}
Set the ONESHOT environment variable:
class { '::irqbalance':
oneshot => 'yes',
}
Use your own irqbalance configuration file:
class { '::irqbalance':
config_file_source => '/path/to/config',
}
Manage irqbalance on Debian 7 under systemd (untested):
class { '::irqbalance':
$manage_init_script_file => true,
$service_provider = 'systemd'
$systemd_init_script_file_template = 'irqbalance/init/systemd/without-foreground-irqbalance.service.erb'
}
Manage irqbalance on Ubuntu 14.04 under systemd (untested):
class { '::irqbalance':
$manage_init_script_file => true,
$service_provider = 'systemd'
$systemd_init_script_file_template = 'irqbalance/init/systemd/with-foreground-irqbalance.service.erb'
}
Parameters
Environment variables for the configuration file:
affinity_mask
Must be an array. eg. affinity_mask => ['ff000000', '0000000'],
banned_cpus
Must be an array. eg. banned_cpus => ['fc3', '0000001'],
banned_interrupts
Must be an array. eg. banned_interrupts => ['01', '03'],
oneshot
Can be set to 'yes', but accepts most boolean forms as a string. If set, the
service_ensure parameter will be ignored.
eg. oneshot => 'yes',
Options passed to the service:
banirq
Must be an array. eg. banirq => ['01', '03', '04'],
banscript
eg. banscript => '/path/to/banscript.sh',
debug
Must be set to true or false. Mostly ignored unless the irqbalance version also supports the foreground option. eg. debug => true,
deepestcache
eg. deepestcache => '2',
hintpolicy
eg. hintpolicy => 'exact',
pid
Generally ignored when using SysV init scripts, as they use their own path.
eg. pid => '/path/to/irqbalance.pid',
policyscript
eg. policyscript => '/path/to/policyscript.sh',
powerthresh
eg. powerthresh => '2',
Other parameters:
args
Options that will passed to irqbalance, in the same way that one would do it from the command line. eg. args => '--powerthresh=2 --deepestcache=2',
config_file_group
Group for the irqbalance configuration file. Defaults to '0'.
config_file_mode
Mode for the irqbalance configuration file. Defaults to '0644'.
config_file_name
The filename that the irqbalance configuration is written into.
config_file_owner
Owner for the irqbalance configuration file. Defaults to '0'.
config_file_source
Used for providing your own irqbalance configuration file.
Needs to follow the same requirements as the Puppet File source attribute.
eg. config_file_source => 'puppet:///modules/irqbalance/config/irq.conf',
If this parameter is provided, you should also set the oneshot parameter to
'yes' if the file contains ONESHOT=yes, since this module does not know about
the contents and uses oneshot to decide how to manage the service. See the
service_ensure parameter.
config_file_template
Determines which template Puppet should use for the irqbalance configuration.
dependency_class
Determines whether to include a dependency class for this irqbalance module. eg. dependency_class => 'irqbalance_deps',
manage_init_script_file
Determines whether to manage init scripts. Defaults to false. It is recommended that this be set to true to ensure that you can use most available options that irqbalance supports. This will also need to be set to true if the distribution does not provide one for systemd. For example, Debian Wheezy.
manage_systemd_dir_path
Determines whether to manage the systemd unit file directory. Defaults to true. In the next release this directory will be unmanaged by this module and this parameter will be removed.
package_ensure
Sets the irqbalance package to be installed. Can be set to present,
'latest', or a specific version.
package_manage
Determines whether to manage the irqbalance package. Defaults to true.
prefer_systemd
Determines whether to use systemd init scripts on certain Debian or Ubuntu distributions.
service_enable
Determines if the service should be enabled at boot.
service_ensure
Determines if the service should be running or not. This parameter is ignored
if running on a single processor system, or if oneshot is set to 'yes'.
service_manage
Selects whether Puppet should manage the service. eg. service_manage => false
systemd_init_script_file_group
Group for the systemd init service file. Defaults to '0'.
systemd_init_script_file_mode
Mode for the systemd init service file. Defaults to '0644'.
systemd_init_script_file_owner
Owner for the systemd init service file. Defaults to '0'.
systemd_init_script_file_source
Used for providing your own irqbalance systemd service file for systems using systemd.
systemd_init_script_file_template
Determines which systemd service template Puppet should use for systems using systemd.
sysv_init_script_file_group
Group for SysV-like init scripts. Defaults to '0'.
sysv_init_script_file_mode
Mode for SysV-like init scripts. Defaults to '0755'.
sysv_init_script_file_owner
Owner for SysV-like init scripts. Defaults to '0'.
sysv_init_script_file_source
Used for providing your own irqbalance init script for systems using SysV-like init.
sysv_init_script_file_template
Determines which init script template Puppet should use for systems using SysV-like init.
upstart_file_group
Group for Upstart init scripts. Defaults to '0'.
upstart_init_script_file_mode
Mode for Upstart init scripts. Defaults to '0644'.
upstart_init_script_file_owner
Owner for Upstart init scripts. Defaults to '0'.
upstart_init_script_file_source
Used for providing your own irqbalance init script for systems using Upstart.
upstart_init_script_file_template
Determines which init script template Puppet should use for systems using Upstart.
Limitations
This module has received very limited testing on:
- CentOS/RHEL 5/6/7
- Debian 6/7
- Fedora 20
- SLES 11 SP1
- Ubuntu 10.04/12.04/14.04
against Puppet 3.8.7 and Puppet 4.x
Development
Patches are welcome.
2016-12-13 Release 1.1.0
Backwards-incompatible changes
none
Summary
Code cleanup and preparation for next major release
Features
- Drops testing and support of Puppet versions less than 3.8.7
- Drops testing of Facter versions less than 2.4.0
- Drops testing of Ruby versions less than 2.1.9
- Deprecates
dependency_classparameter - Removes comments and whitespace taken from vendor defaults in irqbalance config templates
- Adds explicit Puppet 4 support
- Bumps stdlib minimum required version to 4.6.0
- Uses '0' for group rather than 'root'
Bugs
- Provides a workaround to #1 with
manage_systemd_dir_path => false
2015-01-11 Release 1.0.4
Backwards-incompatible changes:
none
Summary
Version bump
Features:
- None
Bugs:
- Fixed package resource to allow multiple packages
- Fixed parser errors when strict_variables is set
2014-12-02 Release 1.0.3
Backwards-incompatible changes:
none
Summary
Bug fix release
Features:
- Added a full set of rspec unit tests and basic acceptance tests
Bugs:
- Fixed typo that caused the args parameter to be ignored
- Fixed template typo that caused this module to fail on Ubuntu 14.04
- Fixed handling of banscript, pid and policyscript parameters
Dependencies
- puppetlabs/stdlib (>= 4.6.0 < 5.0.0)
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2014 Ben Spiccia
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.