Table of Contents

1. Description
2. Setup - The basics of getting started with tuned
   • What tuned affects
   • Beginning with tuned
3. Usage - Configuration options and additional functionality
4. Reference - An under-the-hood peek at what the module is doing and how
5. Limitations - OS compatibility, etc.
6. Development - Guide for contributing to the module
   • Acceptance Tests - Beaker env variables

Description

This Puppet module manages some facets of tuned and ktune.

This is a SIMP module

This module is a component of the System Integrity Management Platform, a compliance-management framework built on Puppet.

If you find any issues, they may be submitted to our bug tracker.

This module is optimally designed for use within a larger SIMP ecosystem, but it can be used independently:

• When included within the SIMP ecosystem, security compliance settings will be managed from the Puppet server.

Setup

What tuned affects

This module manages the following resouces:

• /etc/tuned.conf
• /etc/sysconfig/ktune
• /etc/sysctl.ktune
• tuned package
• tuned service

Beginning with tuned

Just include the tuned class on the systems you want to manage.

Usage

Include the class from hiera:

---
classes:
  - tuned

File contents can be tweaked by adding more hieradata:

---
tuned::disktuning_alpm: false
tuned::io_scheduler: cfq

Reference

Please refer to REFERENCE.md

Limitations

SIMP Puppet modules are generally intended for use on Red Hat Enterprise Linux and compatible distributions, such as CentOS. Please see the metadata.json file for the most up-to-date list of supported operating systems, Puppet versions, and module dependencies.

Development

Please read our [Contribution Guide] (https://simp.readthedocs.io/en/stable/contributors_guide/index.html).

Reference

Table of Contents

Classes

• tuned: Manages the activation of tuned The following options only affect 'tuned'

Data types

• Tuned::IoSchedule

Classes

tuned

Manages the activation of tuned

The following options only affect 'tuned'

Parameters

The following parameters are available in the tuned class:

• use_sysctl
• use_sysctl_post
• io_scheduler
• elevator_tune_devs
• tuning_interval
• diskmonitor_enable
• disktuning_enable
• disktuning_hdparm
• disktuning_alpm
• netmonitor_enable
• nettuning_enable
• cpumonitor_enable
• cputuning_enable
• package_ensure

use_sysctl

Data type: Boolean

This is the custom sysctl configuration file. Set to false to use only the ktune settings.

Default value: true

use_sysctl_post

Data type: Boolean

This is the ktune sysctl file. Any settings in this file will be applied after custom settings, overriding them. Comment this out to not use ktune settings.

Default value: false

io_scheduler

Data type: Tuned::IoSchedule

This is the I/O scheduler ktune will use. This will not override anything explicitly set on the kernel command line, nor will it change the scheduler for any block device that is using a non-default scheduler when ktune starts. You should probably leave this on "deadline", but "as", "cfq", and "noop" are also legal values.

Default value: 'deadline'

elevator_tune_devs

Data type: Array[String]

These are the devices, that should be tuned with the ELEVATOR

Default value: ['hd','sd','cciss']

tuning_interval

Data type: Integer

The number of seconds between tuning runs.

Default value: 10

diskmonitor_enable

Data type: Boolean

Enable the disk monitoring plugin.

Default value: true

disktuning_enable

Data type: Boolean

Enable the disk tuning plugin.

Default value: true

disktuning_hdparm

Data type: Boolean

Use 'hdparm' for disk tuning.

Default value: true

disktuning_alpm

Data type: Boolean

Use 'ALPM' when disk tuning.

Default value: true

netmonitor_enable

Data type: Boolean

Enable the network monitoring plugin.

Default value: true

nettuning_enable

Data type: Boolean

Enable the network tuning plugin.

Default value: true

cpumonitor_enable

Data type: Boolean

Enable the CPU monitoring plugin.

Default value: true

cputuning_enable

Data type: Boolean

Enable the CPU tuning plugin.

Default value: true

package_ensure

Data type: String

The ensure status of the tuned package

Default value: simplib::lookup('simp_options::package_ensure', { 'default_value' => 'installed' })

Data types

Tuned::IoSchedule

The Tuned::IoSchedule data type.

Alias of Enum['deadline', 'as', 'cfq', 'noop']

• Mon Oct 23 2023 Steven Pritchard steve@sicura.us - 0.7.0

• [puppetsync] Add EL9 support

• Wed Oct 11 2023 Steven Pritchard steve@sicura.us - 0.6.0

• [puppetsync] Updates for Puppet 8
  • These updates may include the following:
    • Update Gemfile
    • Add support for Puppet 8
    • Drop support for Puppet 6
    • Update module dependencies

• Wed Aug 23 2023 Steven Pritchard steve@sicura.us - 0.5.0

• Add AlmaLinux 8 support

• Mon Jun 12 2023 Chris Tessmer chris.tessmer@onyxpoint.com - 0.4.0

• Add RockyLinux 8 support

• Thu Jun 17 2021 Chris Tessmer chris.tessmer@onyxpoint.com - 0.3.0

• Removed support for Puppet 5
• Ensured support for Puppet 7 in requirements and stdlib

• Sat Dec 19 2020 Chris Tessmer chris.tessmer@onyxpoint.com - 0.2.2

• Removed EL6 support

• Thu Jul 23 2020 Jeanne Greulich jeanne.greulich@onyxpoint.com - 0.2.1-0

• update the upper bound of simplib for SIMP 6.5 release

• Fri Aug 02 2019 Robert Vincent pillarsdotnet@gmail.com - 0.2.0-0

• Drop Puppet 4 support
• Add Puppet 6 support
• Add puppetlabs-stdlib 6 support

• Thu Mar 07 2019 Liz Nemsick lnemsick.simp@gmail.com - 0.1.1-0

• Update the upper bound of stdlib to < 6.0.0
• Update a URL in the README.md

• Tue Nov 06 2018 Liz Nemsick lnemsick-simp@gmail.com - 0.1.0-0

• Update badges in README.md

• Fri Oct 12 2018 Nick Miller nick.miller@onyxpoint.com - 0.1.0-0

• Added $package_ensure parameter
  • Changed the package from 'latest' to 'installed'
  • It will also respect simp_options::package_ensure

• Thu Sep 13 2018 Nicholas Markowski nicholas.markowski@onyxpoint.com - 0.1.0-0

• Added support for Puppet 5 and OEL

• Fri Sep 07 2018 Liz Nemsick lnemsick.simp@gmail.com - 0.1.0-0

• Drop Hiera 4 support

• Thu Jul 06 2017 Liz Nemsick lnemsick.simp@gmail.com - 0.0.2-0

• Update puppet dependency and remove OBE pe dependency in metadata.json

• Mon Dec 12 2016 Nick Miller nick.miller@onyxpoint.com - 0.0.1

• Migrated material from simplib
• First cut