Skip to content

Commit c438171

Browse files
committed
Merge branch 'development'
2 parents ba2494e + 27b765c commit c438171

5 files changed

Lines changed: 32 additions & 280 deletions

File tree

.sync.yml

Lines changed: 0 additions & 61 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 0 additions & 201 deletions
This file was deleted.

README.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
![](https://github.com/albatrossflavour/puppet_os_patching/actions/workflows/main.yml/badge.svg?branch=master)
2-
31
# os_patching
42

3+
[![CI](https://github.com/voxpupuli/puppet-os_patching/actions/workflows/main.yml/badge.svg)](https://github.com/voxpupuli/puppet-os_patching/actions/workflows/main.yml)
4+
[![Donated by albatrossflavor](https://img.shields.io/badge/donated%20by-albatrossflavor-fb7047.svg)](#transfer-notice)
5+
56
This module contains a set of tasks and custom facts to allow the automation of and reporting on operating system patching. Currently, patching works on Linux (Redhat, Suse and Debian derivatives) and Windows (Server 2008 through to 2019 have been tested). FreeBSD support is a work in progress and is currently reporting only.
67

78
Under the hood, it uses the OS level tools or APIs to carry out the actual patching. That does mean that you need to be sure that your nodes can search for their updates using the native tool - e.g. You still need to manage the configuration of YUM, APT, Zypper or Windows Update.
@@ -10,7 +11,7 @@ Under the hood, it uses the OS level tools or APIs to carry out the actual patch
1011

1112
**Note** - FreeBSD support is currently limited to reporting patch state only. Actual patching will be enabled in a future release.
1213

13-
[The wiki](https://github.com/albatrossflavour/puppet_os_patching/wiki/Background) contains some useful background information on the module and how it works.
14+
[The wiki](https://github.com/voxpupuli/puppet-os_patching/wiki/Background) contains some useful background information on the module and how it works.
1415

1516
## Description
1617

@@ -35,28 +36,33 @@ Install the module using the Puppetfile, include it on your nodes and then use t
3536
## Usage
3637

3738
### Manifest
39+
3840
Include the module:
41+
3942
```puppet
4043
include os_patching
4144
```
4245

4346
More advanced usage:
47+
4448
```puppet
4549
class { 'os_patching':
4650
patch_window => 'Week3',
47-
blackout_windows => { 'End of year change freeze':
48-
{
49-
'start': '2018-12-15T00:00:00+1000',
50-
'end': '2019-01-15T23:59:59+1000',
51-
}
51+
blackout_windows => {
52+
'End of year change freeze' => {
53+
'start' => '2018-12-15T00:00:00+10:00',
54+
'end' => '2019-01-15T23:59:59+10:00',
55+
},
5256
},
5357
}
5458
```
5559

5660
In that example, the node is assigned to a "patch window", will be forced to reboot regardless of the setting specified in the task and has a blackout window defined for the period of 2018-12-15 - 2019-01-15, during which time no patching through the task can be carried out.
5761

5862
### Task
63+
5964
Run a basic patching task from the command line:
65+
6066
```bash
6167
os_patching::patch_server - Carry out OS patching on the server, optionally including a reboot and/or only applying security-related updates
6268

@@ -77,6 +83,7 @@ PARAMETERS:
7783
```
7884
7985
Example:
86+
8087
```bash
8188
$ puppet task run os_patching::patch_server --params='{"reboot": "patched", "security_only": false}' --query="inventory[certname] { facts.os_patching.patch_window = 'Week3' and facts.os_patching.blocked = false and facts.os_patching.package_update_count > 0}"
8289
```
@@ -266,6 +273,7 @@ If patching was blocked, the task will report similar to below:
266273
Error: Task exited: 100
267274
Patching blocked
268275
```
276+
269277
A summary of the patch run is also written to `/var/cache/os_patching/run_history`, the last line of which is used by the `os_patching.last_run` fact.
270278
271279
```bash
@@ -362,3 +370,9 @@ Fork, develop, submit a pull request
362370
- [Jake Rogers](https://github.com/JakeTRogers)
363371
- [Nathan Giuliani](https://github.com/nathangiuliani)
364372
- [Massimiliano Adamo](https://github.com/maxadamo)
373+
374+
## Transfer Notice
375+
376+
This project was originally authored by @albatrossflavour.
377+
The maintainer preferred that Vox Pupuli take ownership of the project for future improvement and maintenance.
378+
Existing pull requests and issues were transferred over, please fork and continue to contribute here instead of albatrossflavour/puppet_os_patching.

REFERENCE.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ the `os_patching` fact.
3737
class { 'os_patching':
3838
patch_window => 'Week3',
3939
reboot_override => 'always',
40-
blackout_windows => { 'End of year change freeze':
41-
{
42-
'start': '2018-12-15T00:00:00+10:00',
43-
'end': '2019-01-15T23:59:59+10:00',
44-
}
40+
blackout_windows => {
41+
'End of year change freeze' => {
42+
'start' => '2018-12-15T00:00:00+10:00',
43+
'end' => '2019-01-15T23:59:59+10:00',
44+
},
4545
},
4646
}
4747
```

metadata.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
{
2-
"name": "albatrossflavour-os_patching",
2+
"name": "puppet-os_patching",
33
"version": "0.23.0",
4-
"author": "albatrossflavour",
4+
"author": "Vox Pupuli",
55
"summary": "Perform OS level patching through tasks and report on patch levels through facts",
66
"license": "Apache-2.0",
7-
"source": "https://github.com/albatrossflavour/puppet_os_patching",
8-
"project_page": "https://github.com/albatrossflavour/puppet_os_patching",
9-
"issues_url": "https://github.com/albatrossflavour/puppet_os_patching/issues",
7+
"source": "https://github.com/voxpupuli/puppet-os_patching",
8+
"project_page": "https://github.com/voxpupuli/puppet-os_patching",
9+
"issues_url": "https://github.com/voxpupuli/puppet-os_patching/issues",
1010
"dependencies": [
1111
{
1212
"name": "puppetlabs-stdlib",

0 commit comments

Comments
 (0)