From 11a29ffd4b248a9d373cc4f7365c2a01d7b65b20 Mon Sep 17 00:00:00 2001 From: Trey Dockendorf Date: Sat, 19 Mar 2022 15:32:05 -0400 Subject: [PATCH] Release v1.0.0 --- CHANGELOG.md | 14 +++++++- REFERENCE.md | 89 +++++++++++++++++++++++++++++++++------------------ metadata.json | 2 +- 3 files changed, 71 insertions(+), 34 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 81e1b3c..234a482 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,18 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## [v1.0.0](https://github.com/treydock/puppet-kdump/tree/v1.0.0) (2022-03-19) + +[Full Changelog](https://github.com/treydock/puppet-kdump/compare/v0.4.1...v1.0.0) + +### Changed + +- Major updates [\#17](https://github.com/treydock/puppet-kdump/pull/17) ([treydock](https://github.com/treydock)) + +### Added + +- Add manage\_kernel\_parameter parameter [\#18](https://github.com/treydock/puppet-kdump/pull/18) ([treydock](https://github.com/treydock)) + ## [v0.4.1](https://github.com/treydock/puppet-kdump/tree/v0.4.1) (2019-08-19) [Full Changelog](https://github.com/treydock/puppet-kdump/compare/v0.4.0...v0.4.1) @@ -70,4 +82,4 @@ All notable changes to this project will be documented in this file. The format -\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)* +\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)* diff --git a/REFERENCE.md b/REFERENCE.md index 09e42ff..ffe087f 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -1,15 +1,16 @@ # Reference + ## Table of Contents -**Classes** +### Classes * [`kdump`](#kdump): Manage kdump ## Classes -### kdump +### `kdump` Manage kdump @@ -31,9 +32,25 @@ class { 'kdump': #### Parameters -The following parameters are available in the `kdump` class. - -##### `enable` +The following parameters are available in the `kdump` class: + +* [`enable`](#enable) +* [`crashkernel`](#crashkernel) +* [`crashkernel_bootmode`](#crashkernel_bootmode) +* [`bootloader_config_path`](#bootloader_config_path) +* [`package_name`](#package_name) +* [`service_name`](#service_name) +* [`service_ensure`](#service_ensure) +* [`service_enable`](#service_enable) +* [`service_hasstatus`](#service_hasstatus) +* [`service_hasrestart`](#service_hasrestart) +* [`config_path`](#config_path) +* [`config_overrides`](#config_overrides) +* [`kernel_parameter_provider`](#kernel_parameter_provider) +* [`manage_kernel_parameter`](#manage_kernel_parameter) +* [`grub_kdump_cfg`](#grub_kdump_cfg) + +##### `enable` Data type: `Boolean` @@ -41,109 +58,117 @@ Set state of kdump. `true` - Ensure service running and crashkernel kernel argument set `false` - Ensure service stopped and crashkernel kernel argument absent -Default value: `false` +Default value: ``false`` -##### `crashkernel` +##### `crashkernel` Data type: `String` Kernel crashkernel argument value -Default value: 'auto' +Default value: `'auto'` -##### `crashkernel_bootmode` +##### `crashkernel_bootmode` Data type: `String` The bootmode for crashkernel kernel argument -Default value: 'all' +Default value: `'all'` -##### `bootloader_config_path` +##### `bootloader_config_path` Data type: `Optional[Stdlib::AbsolutePath]` Path to boot loader config -Default value: `undef` +Default value: ``undef`` -##### `package_name` +##### `package_name` Data type: `String` Package name that provides kdump. -Default value: 'kexec-tools' +Default value: `'kexec-tools'` -##### `service_name` +##### `service_name` Data type: `String` Service name for kdump. -Default value: 'kdump' +Default value: `'kdump'` -##### `service_ensure` +##### `service_ensure` Data type: `Optional[String]` The service ensure property for kdump. -Default value: `undef` +Default value: ``undef`` -##### `service_enable` +##### `service_enable` Data type: `Optional[Boolean]` The service enable property for kdump. -Default value: `undef` +Default value: ``undef`` -##### `service_hasstatus` +##### `service_hasstatus` Data type: `Boolean` The service hasstatus property for kdump. -Default value: `true` +Default value: ``true`` -##### `service_hasrestart` +##### `service_hasrestart` Data type: `Boolean` The service hasrestart property for kdump. -Default value: `true` +Default value: ``true`` -##### `config_path` +##### `config_path` Data type: `Stdlib::AbsolutePath` The configuration file path for kdump. -Default value: '/etc/kdump.conf' +Default value: `'/etc/kdump.conf'` -##### `config_overrides` +##### `config_overrides` Data type: `Hash` Hash of config values to add to kdump.conf -Default value: {} +Default value: `{}` -##### `kernel_parameter_provider` +##### `kernel_parameter_provider` Data type: `String` The provider property for the kernel_parameter defined type. -Default value: 'grub2' +Default value: `'grub2'` + +##### `manage_kernel_parameter` + +Data type: `Boolean` + +Controls if kernel_parameter resource is managed + +Default value: ``true`` -##### `grub_kdump_cfg` +##### `grub_kdump_cfg` Data type: `Optional[String]` Path to grub2 kdump config. Only used on Ubuntu. -Default value: `undef` +Default value: ``undef`` diff --git a/metadata.json b/metadata.json index 4dcf8e8..afd9b6c 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "treydock-kdump", - "version": "0.4.1", + "version": "1.0.0", "author": "treydock", "summary": "Kdump Puppet module", "license": "Apache-2.0",