puppet-module-grubby

Table of Contents

1. Description
2. Setup - The basics of getting started with grubby
   • What grubby affects
   • Beginning with grubby
3. Usage - Configuration options and additional functionality
4. Limitations - OS compatibility, etc.
5. Development - Guide for contributing to the module

Description

The Grubby Puppet module allows for managing the GRUB configuration using Grubby

Setup

What grubby affects

This module can be used to manage the boot loader configuration like setting default kernel, add or remove kernel arguments.

It modifies mostly the files under /boot.

Beginning with grubby

include ::grubby

Usage

Examples are provided in the REFERENCE.md

Reference

Please check REFERENCE.md

Limitations

This module should work with all platforms that can use grubby for managing their configuration, but is primary developed for and tested on RHEL 8.

Development

Please use Puppet Development kit (pdk)

Validate syntax

pdk validate

Run unit tests

pdk test unit

For details on how to add code comments and generate documentation with Strings, see the Puppet Strings documentation and style guide

Preparation for release: Please check CONTRIBUTING.md

Reference

Table of Contents

Classes

• grubby: Manage bootloader configuration via grubby
• grubby::config: Applies desired configuration via grubby

Defined types

• grubby::kernel_opt: Applies kernel parameter configuration via grubby

Data types

• Grubby::Kernel_Opts: Parameters for each kernel argument

Classes

grubby

Manage bootloader configuration via grubby

Examples

Include Class

include ::grubby

Specify Default Kernel

class{'grubby:
  default_kernel => 'vmlinuz-4.18.0-240.15.1.el8_3.x86_64',
}

Add and Remove Kernel Options

class{'grubby':
  kernel_opts => {
    audit  => {
      ensure => present,
      value  => 1,
      scope  => 'DEFAULT',
    },
    audit_backlog_limit => {
      value => 1,
    },
    selinux => {
      'ensure' => 'absent',
      'scope'  => 'ALL',
    }
  }
}

Parameters

The following parameters are available in the grubby class:

• default_kernel
• kernel_opts

default_kernel

Data type: Optional[String[1]]

The kernel version to set as default in the bootloader.

Default value: undef

kernel_opts

Data type: Optional[Hash[Pattern[/^\S+$/], Grubby::Kernel_Opts]]

The kernel options that should be managed for the default kernel If ensure is not specified, present will be used (the other option being absent) If scope is not specified, DEFAULT will be used (valid options are also ALL or specific kernel) Example: audit: ensure: present value: 1 scope: DEFAULT audit_backlog_limit: value: 8192 selinux: ensure: absent scope: ALL enforcing: ensure: absent

Default value: {}

grubby::config

This is a private class, that performs the necessary changes via grubby

Defined types

grubby::kernel_opt

Applies kernel parameter configuration via grubby

Examples

Add Single Parameter

grubby::kernel_opt{'keyword':}

Delete a Single Parameter

grubby::kernel_opt{'selinix':
  ensure => 'absent',
}

Add Parameter with Value

grubby::kernel_opt{'memsize':
  value  => '22',
}

Parameters

The following parameters are available in the grubby::kernel_opt defined type:

• opt
• ensure
• value
• scope

opt

Data type: Pattern[/^\S+$/]

Kernel option

Default value: $name

ensure

Data type: Enum['present', 'absent']

add or delete kernel option

Default value: 'present'

value

Data type: Optional[Variant[Pattern[/^\S+$/],Integer]]

Value of kernel option

Default value: undef

scope

Data type: Variant[Enum['DEFAULT','ALL'],Pattern[/^TITLE=.+$/]]

Which kernels to apply parameters to

Default value: 'DEFAULT'

Data types

Grubby::Kernel_Opts

Parameters for each kernel argument

Alias of

Struct[{
    Optional['ensure'] => Enum['present','absent'],
    Optional['value']  => Variant[Pattern[/^\S+$/],Integer],
    Optional['scope']  => Variant[Enum['DEFAULT','ALL'],Pattern[/^TITLE=.+$/]],
  }]

Change log

All notable changes to this project will be documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

v0.3.2 (2022-04-29)

Full Changelog

Fixed

• Minor update to changelog and metadata.json to support puppet 7 #15 (atsonkov)

v0.3.1 (2022-04-29)

Full Changelog

Added

• feat: update pdk template to 2.4.0 #14 (atsonkov)

v0.3.0 (2021-03-26)

Full Changelog

Added

• Values of kernel parameters cannot contain spacesNospacevalue #12 (traylenator)
• Restrict kernel parameters to not contain spaces #10 (traylenator)
• Create new type grubby::kernel_opt #8 (traylenator)
• Stronger typing of kernel options #6 (traylenator)

Fixed

• Fix alignment in docs #13 (traylenator)
• Avoid test "grubby command" == "grubby command" #9 (traylenator)
• Add examples of using parameters #7 (traylenator)

v0.2.2 (2020-06-05)

Full Changelog

v0.2.1 (2020-04-02)

Full Changelog

v0.2.0 (2020-04-02)

Full Changelog

v0.1.2 (2020-03-18)

Full Changelog

Added

• Prepare version for PuppetForge #1 (atsonkov)

v0.1.1 (2020-03-18)

Full Changelog

* This Changelog was automatically generated by github_changelog_generator