Version information
This version is compatible with:
- Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x
- Puppet >= 5.0.0 < 7.0.0
- , ,
Start using this module
Add this module to your Puppetfile:
mod 'simp-simp_grub', '0.2.2'
Learn more about managing modules with a PuppetfileDocumentation
Table of Contents
Overview
This is a SIMP module
This module is a component of the System Integrity Management Platform
If you find any issues, please submit them via JIRA.
Please read our [Contribution Guide] (https://simp.readthedocs.io/en/stable/contributors_guide/index.html).
Module Description
Provides a Hiera-friendly interface to GRUB configuration activities.
Currently supports setting administrative GRUB passwords on both GRUB 2 and legacy GRUB systems.
See REFERENCE.md for more details.
Setup
What simp_grub affects
simp_grub
helps manage the GRUB configuration on your systems.
Usage
Simply include simp_grub
and set the simp_grub::password
parameter to
password protect GRUB.
Password entries that do not start with $1$
, $5$
, or $6$
will be encrypted
for you.
GRUB2
If your system supports GRUB2, you can also set up the administrative username.
Example: Set the admin username:
---
simp_grub::admin: my_admin_username
Limitations
SIMP Puppet modules are generally intended to be used on a Red Hat Enterprise Linux-compatible distribution such as EL6 and EL7.
Development
Please read our [Contribution Guide] (https://simp.readthedocs.io/en/stable/contributors_guide/index.html).
Unit tests
Unit tests, written in rspec-puppet
can be run by calling:
bundle exec rake spec
Acceptance tests
To run the system tests, you need Vagrant installed. Then, run:
bundle exec rake beaker:suites
Some environment variables may be useful:
BEAKER_debug=true
BEAKER_provision=no
BEAKER_destroy=no
BEAKER_use_fixtures_dir_for_modules=yes
BEAKER_debug
: show the commands being run on the STU and their output.BEAKER_destroy=no
: prevent the machine destruction after the tests finish so you can inspect the state.BEAKER_provision=no
: prevent the machine from being recreated. This can save a lot of time while you're writing the tests.BEAKER_use_fixtures_dir_for_modules=yes
: cause all module dependencies to be loaded from thespec/fixtures/modules
directory, based on the contents of.fixtures.yml
. The contents of this directory are usually populated bybundle exec rake spec_prep
. This can be used to run acceptance tests to run on isolated networks.
Reference
Table of Contents
Classes
simp_grub
: Manage common GRUB attributes Advanced configuration will need to use theaugeasproviders_grub
components directly.
Classes
simp_grub
Manage common GRUB attributes
Advanced configuration will need to use the augeasproviders_grub
components
directly.
Parameters
The following parameters are available in the simp_grub
class.
password
Data type: String[1]
The GRUB administrative password, if not in the hashed form, will be converted for you.
If a password starts with '$1$', '$5$', or '$6$' then it is assumed to be encrypted.
admin
Data type: Optional[String[1]]
The administrative username GRUB 2 systems.
Default value: undef
purge_unmanaged_users
Data type: Optional[Boolean]
Remove users from GRUB 2 systems that are not managed by Puppet.
Default value: undef
report_unmanaged_users
Data type: Optional[Boolean]
Report on any unmanaged users on GRUB 2 systems.
Default value: undef
hash_rounds
Data type: Optional[Integer[10]]
The rounds to use when hashing the password for GRUB 2 systems.
Default value: undef
- 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
- Mon Mar 30 2020 Trevor Vaughan tvaughan@onyxpoint.com - 0.2.0-0
- Add EL8 support
- Wed Jul 03 2019 Trevor Vaughan tvaughan@onyxpoint.com - 0.1.1-0
- Update README.md
- Mon Apr 22 2019 Trevor Vaughan tvaughan@onyxpoint.com - 0.1.0-0
- Initial module creation
Dependencies
- herculesteam/augeasproviders_grub (>= 3.1.0 < 4.0.0)
- puppetlabs/stdlib (>= 4.13.1 < 7.0.0)
- simp/simplib (>= 3.15.0 < 5.0.0)
pupmod-simp-simp_grub - A Puppet module for managing basic GRUB configuration -- Per Section 105 of the Copyright Act of 1976, these works are not entitled to domestic copyright protection under US Federal law. The US Government retains the right to pursue copyright protections outside of the United States. The United States Government has unlimited rights in this software and all derivatives thereof, pursuant to the contracts under which it was developed and the License under which it falls. --- 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.