Merge pull request #79 from albatrossflavour/development

Fix a couple of strings issues

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Release 0.6.1
+
+- Fix a couple of puppet strings issues
+
 ## Release 0.6.0
 
 - [PDQtest](https://github.com/declarativesystems/pdqtest)ing a-go-go, lots of acceptance testing

REFERENCE.md

@@ -1,13 +1,16 @@
 # Reference
 <!-- DO NOT EDIT: This document was generated by Puppet Strings -->
 
-## Classes
+## Table of Contents
+
+**Classes**
 
 * [`os_patching`](#os_patching): This manifest sets up a script and cron job to populate
 the `os_patching` fact.
 
-## Tasks
+**Tasks**
 
+* [`clean_cache`](#clean_cache): Clean patch caches (yum/dpkg) via a task
 * [`patch_server`](#patch_server): Carry out OS patching on the server, optionally including a reboot and/or only applying security related updates
 
 ## Classes
@@ -27,8 +30,8 @@ class { 'os_patching':
   reboot_override  => 'always',
   blackout_windows => { 'End of year change freeze':
     {
-      'start': '2018-12-15T00:00:00+1000',
-      'end': '2019-01-15T23:59:59+1000',
+      'start': '2018-12-15T00:00:00+10:00',
+      'end': '2019-01-15T23:59:59+10:00',
     }
   },
 }
@@ -60,7 +63,7 @@ class profiles::soe::patching (
 ##### JSON hash to specify a change freeze from 2018-12-15 to 2019-01-15
 
 ```puppet
-{"End of year change freeze": {"start": "2018-12-15T00:00:00+1000", "end": "2019-01-15T23:59:59+1000"}}
+{"End of year change freeze": {"start": "2018-12-15T00:00:00+10:00", "end": "2019-01-15T23:59:59+10:00"}}
 ```
 
 ##### Run patching on the node `centos.example.com` using the smart reboot option
@@ -69,6 +72,14 @@ class profiles::soe::patching (
 puppet task run os_patching::patch_server --params '{"reboot": "smart"}' --nodes centos.example.com
 ```
 
+##### Remove from a managed system
+
+```puppet
+class { 'os_patching':
+  ensure => absent,
+}
+```
+
 #### Parameters
 
 The following parameters are available in the `os_patching` class.
@@ -101,7 +112,7 @@ Default value: $patch_data_owner
 
 Data type: `Boolean`
 
-Should the yum-utils package be managed by this module on RedHat family nodes?
+Should the yum_utils package be managed by this module on RedHat family nodes?
 If `true`, use the parameter `yum_utils` to determine how it should be manged
 
 Default value: `false`
@@ -131,6 +142,15 @@ If managed, what should the delta_rpm package set to?
 
 Default value: 'installed'
 
+##### `manage_yum_plugin_security`
+
+Data type: `Boolean`
+
+Should the yum_plugin_security package be managed by this module on RedHat family nodes?
+If `true`, use the parameter `yum_plugin_security` to determine how it should be manged
+
+Default value: `false`
+
 ##### `yum_plugin_security`
 
 Data type: `Enum['installed', 'absent', 'purged', 'held', 'latest']`
@@ -148,21 +168,6 @@ This overrides the setting in the task
 
 Default value: 'default'
 
-##### `blackout_windows`
-
-Data type: `Optional[Hash]`
-
-A hash containing the patch blackout windows, which prevent patching.
-The dates are in full ISO8601 format (YYYY-MM-DDTdd:mm:hh:ss[-+]hh:mm).
-
-Options:
-
-* **:title** `String`: Name of the blackout window
-* **:start** `String`: Start of the blackout window (ISO8601 format)
-* **:end** `String`: End of the blackout window (ISO8601 format)
-
-Default value: `undef`
-
 ##### `patch_window`
 
 Data type: `String`
@@ -211,16 +216,36 @@ The min(s) for the cron job to run (defaults to a random number between 0 and 59
 
 Default value: fqdn_rand(59)
 
-##### `manage_yum_plugin_security`
+##### `ensure`
 
-Data type: `Boolean`
+Data type: `Enum['present', 'absent']`
 
+`present` to install scripts, cronjobs, files, etc, `absent` to cleanup a system that previously hosted us
 
+Default value: 'present'
 
-Default value: `false`
+##### `blackout_windows`
+
+Data type: `Optional[Hash]`
+
+
+
+Options:
+
+* **:title** `String`: Name of the blackout window
+* **:start** `String`: Start of the blackout window (ISO8601 format)
+* **:end** `String`: End of the blackout window (ISO8601 format)
+
+Default value: `undef`
 
 ## Tasks
 
+### clean_cache
+
+Clean patch caches (yum/dpkg) via a task
+
+**Supports noop?** false
+
 ### patch_server
 
 Carry out OS patching on the server, optionally including a reboot and/or only applying security related updates
@@ -259,3 +284,9 @@ Data type: `Optional[Boolean]`
 
 Limit patches to those tagged as security related? (Defaults to false)
 
+##### `clean_cache`
+
+Data type: `Optional[Boolean]`
+
+Should the yum/dpkg caches be cleaned at the start of the task? (Defaults to false)
+

manifests/init.pp

@@ -24,7 +24,7 @@
 # @param delta_rpm [Enum]
 #   If managed, what should the delta_rpm package set to?
 #
-# @parammanage_yum_plugin_security [Boolean]
+# @param manage_yum_plugin_security [Boolean]
 #   Should the yum_plugin_security package be managed by this module on RedHat family nodes?
 #   If `true`, use the parameter `yum_plugin_security` to determine how it should be manged
 #

metadata.json

@@ -1,6 +1,6 @@
 {
   "name": "albatrossflavour-os_patching",
-  "version": "0.5.0",
+  "version": "0.6.1",
   "author": "Tony Green",
   "summary": "Perform OS level patching through tasks and report on patch levels through facts",
   "license": "Apache-2.0",

tasks/clean_cache.json

@@ -2,5 +2,7 @@
   "input_method": "stdin",
   "puppet_task_version": 1,
   "supports_noop": false,
-  "description": "Clean patch caches (yum/dpkg) via a task"
+  "description": "Clean patch caches (yum/dpkg) via a task",
+  "parameters": {
+  }
 }