Skip to content

Commit

Permalink
Release v1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
treydock committed Mar 19, 2022
1 parent 6da2693 commit 11a29ff
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 34 deletions.
14 changes: 13 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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)*
89 changes: 57 additions & 32 deletions REFERENCE.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
# Reference

<!-- DO NOT EDIT: This document was generated by Puppet Strings -->

## Table of Contents

**Classes**
### Classes

* [`kdump`](#kdump): Manage kdump

## Classes

### kdump
### <a name="kdump"></a>`kdump`

Manage kdump

Expand All @@ -31,119 +32,143 @@ 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)

##### <a name="enable"></a>`enable`

Data type: `Boolean`

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`
##### <a name="crashkernel"></a>`crashkernel`

Data type: `String`

Kernel crashkernel argument value

Default value: 'auto'
Default value: `'auto'`

##### `crashkernel_bootmode`
##### <a name="crashkernel_bootmode"></a>`crashkernel_bootmode`

Data type: `String`

The bootmode for crashkernel kernel argument

Default value: 'all'
Default value: `'all'`

##### `bootloader_config_path`
##### <a name="bootloader_config_path"></a>`bootloader_config_path`

Data type: `Optional[Stdlib::AbsolutePath]`

Path to boot loader config

Default value: `undef`
Default value: ``undef``

##### `package_name`
##### <a name="package_name"></a>`package_name`

Data type: `String`

Package name that provides kdump.

Default value: 'kexec-tools'
Default value: `'kexec-tools'`

##### `service_name`
##### <a name="service_name"></a>`service_name`

Data type: `String`

Service name for kdump.

Default value: 'kdump'
Default value: `'kdump'`

##### `service_ensure`
##### <a name="service_ensure"></a>`service_ensure`

Data type: `Optional[String]`

The service ensure property for kdump.

Default value: `undef`
Default value: ``undef``

##### `service_enable`
##### <a name="service_enable"></a>`service_enable`

Data type: `Optional[Boolean]`

The service enable property for kdump.

Default value: `undef`
Default value: ``undef``

##### `service_hasstatus`
##### <a name="service_hasstatus"></a>`service_hasstatus`

Data type: `Boolean`

The service hasstatus property for kdump.

Default value: `true`
Default value: ``true``

##### `service_hasrestart`
##### <a name="service_hasrestart"></a>`service_hasrestart`

Data type: `Boolean`

The service hasrestart property for kdump.

Default value: `true`
Default value: ``true``

##### `config_path`
##### <a name="config_path"></a>`config_path`

Data type: `Stdlib::AbsolutePath`

The configuration file path for kdump.

Default value: '/etc/kdump.conf'
Default value: `'/etc/kdump.conf'`

##### `config_overrides`
##### <a name="config_overrides"></a>`config_overrides`

Data type: `Hash`

Hash of config values to add to kdump.conf

Default value: {}
Default value: `{}`

##### `kernel_parameter_provider`
##### <a name="kernel_parameter_provider"></a>`kernel_parameter_provider`

Data type: `String`

The provider property for the kernel_parameter defined type.

Default value: 'grub2'
Default value: `'grub2'`

##### <a name="manage_kernel_parameter"></a>`manage_kernel_parameter`

Data type: `Boolean`

Controls if kernel_parameter resource is managed

Default value: ``true``

##### `grub_kdump_cfg`
##### <a name="grub_kdump_cfg"></a>`grub_kdump_cfg`

Data type: `Optional[String]`

Path to grub2 kdump config. Only used on Ubuntu.

Default value: `undef`
Default value: ``undef``

2 changes: 1 addition & 1 deletion metadata.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down

0 comments on commit 11a29ff

Please sign in to comment.