Skip to content

Commit e60e8b2

Browse files
authoredAug 28, 2024··
Merge pull request #99 from puppetlabs/release-prep
Release prep v1.1.9
2 parents 4ce3f44 + 5223725 commit e60e8b2

File tree

3 files changed

+136
-128
lines changed

3 files changed

+136
-128
lines changed
 

‎CHANGELOG.md

+12-4
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,21 @@
22

33
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).
44

5-
## [v1.1.8](https://github.com/puppetlabs/puppetlabs-patching_as_code/tree/v1.1.8) 92024-08-22)
5+
## [v1.1.9](https://github.com/puppetlabs/puppetlabs-patching_as_code/tree/v1.1.9) (2024-08-27)
66

7-
[Full Changelog](https://github.com/puppetlabs/puppetlabs-patching_as_code/compare/v1.1.7...v1.1.8)
7+
[Full Changelog](https://github.com/puppetlabs/puppetlabs-patching_as_code/compare/v1.1.7...v1.1.9)
88

9-
## Fixed
9+
### Fixed
10+
11+
- Fix unsafe process list [\#89](https://github.com/puppetlabs/puppetlabs-patching_as_code/pull/89) ([kreeuwijk](https://github.com/kreeuwijk))
12+
13+
### UNCATEGORIZED PRS; LABEL THEM ON GITHUB
1014

11-
- Release 1.1.8: Powershell scripts should be executed with the -NoProfile parameter [\#96](https://github.com/puppetlabs/puppetlabs-patching_as_code/pull/96) ([elfranne](https://github.com/elfranne))
15+
- Powershell scripts should be executed with the -NoProfile parameter [\#96](https://github.com/puppetlabs/puppetlabs-patching_as_code/pull/96) ([elfranne](https://github.com/elfranne))
16+
- Exclude 'patching\_as\_code' fact from running on Darwin systems [\#93](https://github.com/puppetlabs/puppetlabs-patching_as_code/pull/93) ([kennyb-222](https://github.com/kennyb-222))
17+
- Pdk release prep fix fix [\#92](https://github.com/puppetlabs/puppetlabs-patching_as_code/pull/92) ([kreeuwijk](https://github.com/kreeuwijk))
18+
- fix PDK Release Prep action step [\#91](https://github.com/puppetlabs/puppetlabs-patching_as_code/pull/91) ([kreeuwijk](https://github.com/kreeuwijk))
19+
- remove travis [\#87](https://github.com/puppetlabs/puppetlabs-patching_as_code/pull/87) ([binford2k](https://github.com/binford2k))
1220

1321
## [v1.1.7](https://github.com/puppetlabs/puppetlabs-patching_as_code/tree/v1.1.7) (2022-11-01)
1422

‎REFERENCE.md

+123-123
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@
77
### Classes
88

99
* [`patching_as_code`](#patching_as_code): Framework for patch management as code. Works alongside the puppetlabs/pe_patch or albatrossflavour/os_patching modules
10-
* [`patching_as_code::high_prio_reboot`](#patching_as_codehigh_prio_reboot): This class gets called by init.pp to reboot the node. You can use Hiera to set a different default for the reboot_delay if desired.
11-
* [`patching_as_code::linux::patchday`](#patching_as_codelinuxpatchday): This class gets called by init.pp to perform the actual patching on Linux.
12-
* [`patching_as_code::reboot`](#patching_as_codereboot): This class gets called by init.pp to reboot the node. You can use Hiera to set a different default for the reboot_delay if desired.
13-
* [`patching_as_code::windows::patchday`](#patching_as_codewindowspatchday): This class gets called by init.pp to perform the actual patching on Windows.
14-
* [`patching_as_code::wu`](#patching_as_codewu): class patching_as_code::wu
10+
* [`patching_as_code::high_prio_reboot`](#patching_as_code--high_prio_reboot): This class gets called by init.pp to reboot the node. You can use Hiera to set a different default for the reboot_delay if desired.
11+
* [`patching_as_code::linux::patchday`](#patching_as_code--linux--patchday): This class gets called by init.pp to perform the actual patching on Linux.
12+
* [`patching_as_code::reboot`](#patching_as_code--reboot): This class gets called by init.pp to reboot the node. You can use Hiera to set a different default for the reboot_delay if desired.
13+
* [`patching_as_code::windows::patchday`](#patching_as_code--windows--patchday): This class gets called by init.pp to perform the actual patching on Windows.
14+
* [`patching_as_code::wu`](#patching_as_code--wu): class patching_as_code::wu
1515

1616
### Defined types
1717

18-
* [`patching_as_code::kb`](#patching_as_codekb): This define gets called by init.pp to install Windows KB patches.
18+
* [`patching_as_code::kb`](#patching_as_code--kb): This define gets called by init.pp to install Windows KB patches.
1919

2020
### Resource types
2121

@@ -24,11 +24,11 @@
2424

2525
### Functions
2626

27-
* [`patching_as_code::dedupe_arch`](#patching_as_codededupe_arch)
28-
* [`patching_as_code::high_prio_last_run`](#patching_as_codehigh_prio_last_run)
29-
* [`patching_as_code::is_patchday`](#patching_as_codeis_patchday)
30-
* [`patching_as_code::last_run`](#patching_as_codelast_run)
31-
* [`patching_as_code::process_patch_groups`](#patching_as_codeprocess_patch_groups)
27+
* [`patching_as_code::dedupe_arch`](#patching_as_code--dedupe_arch)
28+
* [`patching_as_code::high_prio_last_run`](#patching_as_code--high_prio_last_run)
29+
* [`patching_as_code::is_patchday`](#patching_as_code--is_patchday)
30+
* [`patching_as_code::last_run`](#patching_as_code--last_run)
31+
* [`patching_as_code::process_patch_groups`](#patching_as_code--process_patch_groups)
3232

3333
### Tasks
3434

@@ -68,39 +68,39 @@ class {'patching_as_code':
6868

6969
The following parameters are available in the `patching_as_code` class:
7070

71-
* [`Variant`](#Variant)
72-
* [`patch_schedule`](#patch_schedule)
73-
* [`blocklist`](#blocklist)
74-
* [`allowlist`](#allowlist)
75-
* [`blocklist_choco`](#blocklist_choco)
76-
* [`allowlist_choco`](#allowlist_choco)
77-
* [`high_priority_patch_group`](#high_priority_patch_group)
78-
* [`high_priority_list`](#high_priority_list)
79-
* [`high_priority_list_choco`](#high_priority_list_choco)
80-
* [`unsafe_process_list`](#unsafe_process_list)
81-
* [`pre_patch_commands`](#pre_patch_commands)
82-
* [`post_patch_commands`](#post_patch_commands)
83-
* [`pre_reboot_commands`](#pre_reboot_commands)
84-
* [`fact_upload`](#fact_upload)
85-
* [`enable_patching`](#enable_patching)
86-
* [`security_only`](#security_only)
87-
* [`high_priority_only`](#high_priority_only)
88-
* [`patch_choco`](#patch_choco)
89-
* [`use_pe_patch`](#use_pe_patch)
90-
* [`classify_pe_patch`](#classify_pe_patch)
91-
* [`patch_on_metered_links`](#patch_on_metered_links)
92-
* [`plan_patch_fact`](#plan_patch_fact)
93-
* [`patch_group`](#patch_group)
94-
95-
##### <a name="Variant"></a>`Variant`
71+
* [`Variant`](#-patching_as_code--Variant)
72+
* [`patch_schedule`](#-patching_as_code--patch_schedule)
73+
* [`blocklist`](#-patching_as_code--blocklist)
74+
* [`allowlist`](#-patching_as_code--allowlist)
75+
* [`blocklist_choco`](#-patching_as_code--blocklist_choco)
76+
* [`allowlist_choco`](#-patching_as_code--allowlist_choco)
77+
* [`high_priority_patch_group`](#-patching_as_code--high_priority_patch_group)
78+
* [`high_priority_list`](#-patching_as_code--high_priority_list)
79+
* [`high_priority_list_choco`](#-patching_as_code--high_priority_list_choco)
80+
* [`unsafe_process_list`](#-patching_as_code--unsafe_process_list)
81+
* [`pre_patch_commands`](#-patching_as_code--pre_patch_commands)
82+
* [`post_patch_commands`](#-patching_as_code--post_patch_commands)
83+
* [`pre_reboot_commands`](#-patching_as_code--pre_reboot_commands)
84+
* [`fact_upload`](#-patching_as_code--fact_upload)
85+
* [`enable_patching`](#-patching_as_code--enable_patching)
86+
* [`security_only`](#-patching_as_code--security_only)
87+
* [`high_priority_only`](#-patching_as_code--high_priority_only)
88+
* [`patch_choco`](#-patching_as_code--patch_choco)
89+
* [`use_pe_patch`](#-patching_as_code--use_pe_patch)
90+
* [`classify_pe_patch`](#-patching_as_code--classify_pe_patch)
91+
* [`patch_on_metered_links`](#-patching_as_code--patch_on_metered_links)
92+
* [`plan_patch_fact`](#-patching_as_code--plan_patch_fact)
93+
* [`patch_group`](#-patching_as_code--patch_group)
94+
95+
##### <a name="-patching_as_code--Variant"></a>`Variant`
9696

9797
Data type: `String, Array[String]`
9898

9999
patch_group
100100
Name(s) of the patch_group(s) for this node. Must match one or more of the patch groups in $patch_schedule
101101
To assign multiple patch groups, provide this parameter as an array
102102

103-
##### <a name="patch_schedule"></a>`patch_schedule`
103+
##### <a name="-patching_as_code--patch_schedule"></a>`patch_schedule`
104104

105105
Data type: `Hash`
106106

@@ -114,57 +114,57 @@ Options:
114114
* **:max_runs** `String`: How many Puppet runs during the patch window can Puppet install patches. Must be at least 1.
115115
* **:reboot** `String`: Reboot behavior, valid options: 'always', 'never', 'ifneeded'
116116

117-
##### <a name="blocklist"></a>`blocklist`
117+
##### <a name="-patching_as_code--blocklist"></a>`blocklist`
118118

119119
Data type: `Array`
120120

121121
List of updates to block from installing
122122

123-
##### <a name="allowlist"></a>`allowlist`
123+
##### <a name="-patching_as_code--allowlist"></a>`allowlist`
124124

125125
Data type: `Array`
126126

127127
List of updates that are allowed to be installed. Any updates not on this list get blocked.
128128

129-
##### <a name="blocklist_choco"></a>`blocklist_choco`
129+
##### <a name="-patching_as_code--blocklist_choco"></a>`blocklist_choco`
130130

131131
Data type: `Array`
132132

133133
List of Chocolatey updates to block from installing
134134

135-
##### <a name="allowlist_choco"></a>`allowlist_choco`
135+
##### <a name="-patching_as_code--allowlist_choco"></a>`allowlist_choco`
136136

137137
Data type: `Array`
138138

139139
List of Chocolatey updates that are allowed to be installed. Any Chocolatey updates not on this list get blocked.
140140

141-
##### <a name="high_priority_patch_group"></a>`high_priority_patch_group`
141+
##### <a name="-patching_as_code--high_priority_patch_group"></a>`high_priority_patch_group`
142142

143143
Data type: `String`
144144

145145
Name of the high_priority_patch_group for this node. Must match a patch group in `$patch_schedule`
146146
This patch schedule will only be used for patches in the `$high_priority_list`.
147147

148-
##### <a name="high_priority_list"></a>`high_priority_list`
148+
##### <a name="-patching_as_code--high_priority_list"></a>`high_priority_list`
149149

150150
Data type: `Array`
151151

152152
List of updates to install on the patch schedule set by `$high_priority_patch_group`.
153153

154-
##### <a name="high_priority_list_choco"></a>`high_priority_list_choco`
154+
##### <a name="-patching_as_code--high_priority_list_choco"></a>`high_priority_list_choco`
155155

156156
Data type: `Array`
157157

158158
List of Chocolatey updates to install on the patch schedule set by `$high_priority_patch_group`.
159159

160-
##### <a name="unsafe_process_list"></a>`unsafe_process_list`
160+
##### <a name="-patching_as_code--unsafe_process_list"></a>`unsafe_process_list`
161161

162162
Data type: `Array`
163163

164164
List of processes that will cause patching to be skipped if any of the processes in the list are active on the system.
165165
Prepend an entry with `{full}` to match against the full process arguments.
166166

167-
##### <a name="pre_patch_commands"></a>`pre_patch_commands`
167+
##### <a name="-patching_as_code--pre_patch_commands"></a>`pre_patch_commands`
168168

169169
Data type: `Hash`
170170

@@ -176,7 +176,7 @@ Options:
176176
* **:path** `String`: The path for the command
177177
* **:provider** `String`: The provider for the command
178178

179-
##### <a name="post_patch_commands"></a>`post_patch_commands`
179+
##### <a name="-patching_as_code--post_patch_commands"></a>`post_patch_commands`
180180

181181
Data type: `Hash`
182182

@@ -188,7 +188,7 @@ Options:
188188
* **:path** `String`: The path for the command
189189
* **:provider** `String`: The provider for the command
190190

191-
##### <a name="pre_reboot_commands"></a>`pre_reboot_commands`
191+
##### <a name="-patching_as_code--pre_reboot_commands"></a>`pre_reboot_commands`
192192

193193
Data type: `Hash`
194194

@@ -201,26 +201,26 @@ Options:
201201
* **:provider** `String`: The provider for the command
202202
Note: the provider for the command gets forced to `posix` on Linux and `powershell` on Windows
203203

204-
##### <a name="fact_upload"></a>`fact_upload`
204+
##### <a name="-patching_as_code--fact_upload"></a>`fact_upload`
205205

206206
Data type: `Boolean`
207207

208208
How os_patching/pe_patch handles changes to fact cache. Defaults to true.
209209
When true (default), `puppet fact upload` occurs as expected
210210
When false, changes to fact cache are not uploaded
211211

212-
Default value: ``true``
212+
Default value: `true`
213213

214-
##### <a name="enable_patching"></a>`enable_patching`
214+
##### <a name="-patching_as_code--enable_patching"></a>`enable_patching`
215215

216216
Data type: `Boolean`
217217

218218
Controls if `patching_as_code` is allowed to install any updates. Can be used to disable patching with a single override.
219219
Can be used to disable patching with a single override.
220220

221-
Default value: ``true``
221+
Default value: `true`
222222

223-
##### <a name="security_only"></a>`security_only`
223+
##### <a name="-patching_as_code--security_only"></a>`security_only`
224224

225225
Data type: `Boolean`
226226

@@ -229,9 +229,9 @@ When using `os_patching`, security updates can only be applied to Linux.
229229
If patching of Chocolatey packages is enabled, Chocolatey packages will still update even if
230230
`security_only` is set to `true`.
231231

232-
Default value: ``false``
232+
Default value: `false`
233233

234-
##### <a name="high_priority_only"></a>`high_priority_only`
234+
##### <a name="-patching_as_code--high_priority_only"></a>`high_priority_only`
235235

236236
Data type: `Boolean`
237237

@@ -240,25 +240,25 @@ regular patches from being installed, and will skip a pending reboot at the begi
240240
run if a pending reboot is detected. A pending reboot may still happen at the end of the patch run,
241241
as long as the patch schedule set by `$high_priority_patch_group` allows reboots to occur.
242242

243-
Default value: ``false``
243+
Default value: `false`
244244

245-
##### <a name="patch_choco"></a>`patch_choco`
245+
##### <a name="-patching_as_code--patch_choco"></a>`patch_choco`
246246

247247
Data type: `Boolean`
248248

249249
Also patch outdated Chocolatey packages (on Windows)
250250

251-
Default value: ``false``
251+
Default value: `false`
252252

253-
##### <a name="use_pe_patch"></a>`use_pe_patch`
253+
##### <a name="-patching_as_code--use_pe_patch"></a>`use_pe_patch`
254254

255255
Data type: `Boolean`
256256

257257
Use the pe_patch module if available (PE 2019.8+). Defaults to true.
258258

259-
Default value: ``true``
259+
Default value: `true`
260260

261-
##### <a name="classify_pe_patch"></a>`classify_pe_patch`
261+
##### <a name="-patching_as_code--classify_pe_patch"></a>`classify_pe_patch`
262262

263263
Data type: `Boolean`
264264

@@ -269,9 +269,9 @@ When disabled (default), you can use PE's own "PE Patch Management" groups
269269
to classify nodes with pe_patch. In that case, please make sure you match
270270
the patch_group variable in pe_patch with the patch_group in patching_as_code
271271

272-
Default value: ``false``
272+
Default value: `false`
273273

274-
##### <a name="patch_on_metered_links"></a>`patch_on_metered_links`
274+
##### <a name="-patching_as_code--patch_on_metered_links"></a>`patch_on_metered_links`
275275

276276
Data type: `Boolean`
277277

@@ -280,42 +280,42 @@ metered link. This setting only has affect for Windows operating systems.
280280
When enabled, patching are installed even over a metered link.
281281
When disabled (default), patches are not installed over a metered link.
282282

283-
Default value: ``false``
283+
Default value: `false`
284284

285-
##### <a name="plan_patch_fact"></a>`plan_patch_fact`
285+
##### <a name="-patching_as_code--plan_patch_fact"></a>`plan_patch_fact`
286286

287287
Data type: `Optional[String]`
288288

289289
Reserved parameter for running `patching_as_code` via a Plan (future functionality).
290290

291-
Default value: ``undef``
291+
Default value: `undef`
292292

293-
##### <a name="patch_group"></a>`patch_group`
293+
##### <a name="-patching_as_code--patch_group"></a>`patch_group`
294294

295295
Data type: `Variant[String,Array[String]]`
296296

297297

298298

299-
### <a name="patching_as_codehigh_prio_reboot"></a>`patching_as_code::high_prio_reboot`
299+
### <a name="patching_as_code--high_prio_reboot"></a>`patching_as_code::high_prio_reboot`
300300

301301
Class: patching_as_code::high_prio_reboot
302302

303303
#### Parameters
304304

305305
The following parameters are available in the `patching_as_code::high_prio_reboot` class:
306306

307-
* [`reboot_if_needed`](#reboot_if_needed)
308-
* [`reboot_delay`](#reboot_delay)
307+
* [`reboot_if_needed`](#-patching_as_code--high_prio_reboot--reboot_if_needed)
308+
* [`reboot_delay`](#-patching_as_code--high_prio_reboot--reboot_delay)
309309

310-
##### <a name="reboot_if_needed"></a>`reboot_if_needed`
310+
##### <a name="-patching_as_code--high_prio_reboot--reboot_if_needed"></a>`reboot_if_needed`
311311

312312
Data type: `Boolean`
313313

314314
Only reboot the node if a system reboot is pending. This parameter is passed automatically from init.pp
315315

316-
Default value: ``true``
316+
Default value: `true`
317317

318-
##### <a name="reboot_delay"></a>`reboot_delay`
318+
##### <a name="-patching_as_code--high_prio_reboot--reboot_delay"></a>`reboot_delay`
319319

320320
Data type: `Integer`
321321

@@ -324,69 +324,69 @@ To override for patching, specify an alternate value by setting the patching_as_
324324

325325
Default value: `120`
326326

327-
### <a name="patching_as_codelinuxpatchday"></a>`patching_as_code::linux::patchday`
327+
### <a name="patching_as_code--linux--patchday"></a>`patching_as_code::linux::patchday`
328328

329329
Class: patching_as_code::linux::patchday
330330

331331
#### Parameters
332332

333333
The following parameters are available in the `patching_as_code::linux::patchday` class:
334334

335-
* [`updates`](#updates)
336-
* [`choco_updates`](#choco_updates)
337-
* [`high_prio_updates`](#high_prio_updates)
338-
* [`high_prio_choco_updates`](#high_prio_choco_updates)
335+
* [`updates`](#-patching_as_code--linux--patchday--updates)
336+
* [`choco_updates`](#-patching_as_code--linux--patchday--choco_updates)
337+
* [`high_prio_updates`](#-patching_as_code--linux--patchday--high_prio_updates)
338+
* [`high_prio_choco_updates`](#-patching_as_code--linux--patchday--high_prio_choco_updates)
339339

340-
##### <a name="updates"></a>`updates`
340+
##### <a name="-patching_as_code--linux--patchday--updates"></a>`updates`
341341

342342
Data type: `Array`
343343

344344
List of Linux packages to update.
345345

346-
##### <a name="choco_updates"></a>`choco_updates`
346+
##### <a name="-patching_as_code--linux--patchday--choco_updates"></a>`choco_updates`
347347

348348
Data type: `Array`
349349

350350
List of Chocolatey packages to update, which should always be empty for Linux. This parameter exists only for compability.
351351

352352
Default value: `[]`
353353

354-
##### <a name="high_prio_updates"></a>`high_prio_updates`
354+
##### <a name="-patching_as_code--linux--patchday--high_prio_updates"></a>`high_prio_updates`
355355

356356
Data type: `Array`
357357

358358
List of high-priority Linux packages to update.
359359

360360
Default value: `[]`
361361

362-
##### <a name="high_prio_choco_updates"></a>`high_prio_choco_updates`
362+
##### <a name="-patching_as_code--linux--patchday--high_prio_choco_updates"></a>`high_prio_choco_updates`
363363

364364
Data type: `Array`
365365

366366
List of high-priority Chocolatey packages to update, which should always be empty for Linux. This parameter exists only for compability.
367367

368368
Default value: `[]`
369369

370-
### <a name="patching_as_codereboot"></a>`patching_as_code::reboot`
370+
### <a name="patching_as_code--reboot"></a>`patching_as_code::reboot`
371371

372372
Class: patching_as_code::reboot
373373

374374
#### Parameters
375375

376376
The following parameters are available in the `patching_as_code::reboot` class:
377377

378-
* [`reboot_if_needed`](#reboot_if_needed)
379-
* [`reboot_delay`](#reboot_delay)
378+
* [`reboot_if_needed`](#-patching_as_code--reboot--reboot_if_needed)
379+
* [`reboot_delay`](#-patching_as_code--reboot--reboot_delay)
380380

381-
##### <a name="reboot_if_needed"></a>`reboot_if_needed`
381+
##### <a name="-patching_as_code--reboot--reboot_if_needed"></a>`reboot_if_needed`
382382

383383
Data type: `Boolean`
384384

385385
Only reboot the node if a system reboot is pending. This parameter is passed automatically from init.pp
386386

387-
Default value: ``true``
387+
Default value: `true`
388388

389-
##### <a name="reboot_delay"></a>`reboot_delay`
389+
##### <a name="-patching_as_code--reboot--reboot_delay"></a>`reboot_delay`
390390

391391
Data type: `Integer`
392392

@@ -395,88 +395,88 @@ To override for patching, specify an alternate value by setting the patching_as_
395395

396396
Default value: `120`
397397

398-
### <a name="patching_as_codewindowspatchday"></a>`patching_as_code::windows::patchday`
398+
### <a name="patching_as_code--windows--patchday"></a>`patching_as_code::windows::patchday`
399399

400400
Class: patching_as_code::windows::patchday
401401

402402
#### Parameters
403403

404404
The following parameters are available in the `patching_as_code::windows::patchday` class:
405405

406-
* [`updates`](#updates)
407-
* [`choco_updates`](#choco_updates)
408-
* [`high_prio_updates`](#high_prio_updates)
409-
* [`high_prio_choco_updates`](#high_prio_choco_updates)
406+
* [`updates`](#-patching_as_code--windows--patchday--updates)
407+
* [`choco_updates`](#-patching_as_code--windows--patchday--choco_updates)
408+
* [`high_prio_updates`](#-patching_as_code--windows--patchday--high_prio_updates)
409+
* [`high_prio_choco_updates`](#-patching_as_code--windows--patchday--high_prio_choco_updates)
410410

411-
##### <a name="updates"></a>`updates`
411+
##### <a name="-patching_as_code--windows--patchday--updates"></a>`updates`
412412

413413
Data type: `Array`
414414

415415
List of Windows KB patches to install.
416416

417-
##### <a name="choco_updates"></a>`choco_updates`
417+
##### <a name="-patching_as_code--windows--patchday--choco_updates"></a>`choco_updates`
418418

419419
Data type: `Array`
420420

421421
List of Chocolatey packages to update.
422422

423-
##### <a name="high_prio_updates"></a>`high_prio_updates`
423+
##### <a name="-patching_as_code--windows--patchday--high_prio_updates"></a>`high_prio_updates`
424424

425425
Data type: `Array`
426426

427427
List of high-priority Windows KB patches to install.
428428

429429
Default value: `[]`
430430

431-
##### <a name="high_prio_choco_updates"></a>`high_prio_choco_updates`
431+
##### <a name="-patching_as_code--windows--patchday--high_prio_choco_updates"></a>`high_prio_choco_updates`
432432

433433
Data type: `Array`
434434

435435
List of high-priority Chocolatey packages to update.
436436

437437
Default value: `[]`
438438

439-
### <a name="patching_as_codewu"></a>`patching_as_code::wu`
439+
### <a name="patching_as_code--wu"></a>`patching_as_code::wu`
440440

441441
class patching_as_code::wu
442442

443443
## Defined types
444444

445-
### <a name="patching_as_codekb"></a>`patching_as_code::kb`
445+
### <a name="patching_as_code--kb"></a>`patching_as_code::kb`
446446

447447
define patching_as_code::kb
448448

449449
#### Parameters
450450

451451
The following parameters are available in the `patching_as_code::kb` defined type:
452452

453-
* [`ensure`](#ensure)
454-
* [`kb`](#kb)
455-
* [`maintwindow`](#maintwindow)
453+
* [`ensure`](#-patching_as_code--kb--ensure)
454+
* [`kb`](#-patching_as_code--kb--kb)
455+
* [`maintwindow`](#-patching_as_code--kb--maintwindow)
456456

457-
##### <a name="ensure"></a>`ensure`
457+
##### <a name="-patching_as_code--kb--ensure"></a>`ensure`
458458

459459
Data type: `String`
460460

461461
When set to 'enabled' or 'present', will allow this resource to be applied. Removing updates is currently not supported.
462462

463463
Default value: `'enabled'`
464464

465-
##### <a name="kb"></a>`kb`
465+
##### <a name="-patching_as_code--kb--kb"></a>`kb`
466466

467467
Data type: `String`
468468

469469
Name of the KB patch to install.
470470

471471
Default value: `$name`
472472

473-
##### <a name="maintwindow"></a>`maintwindow`
473+
##### <a name="-patching_as_code--kb--maintwindow"></a>`maintwindow`
474474

475475
Data type: `Optional[String]`
476476

477477
Name of the patch window to use for installing the patch.
478478

479-
Default value: ``undef``
479+
Default value: `undef`
480480

481481
## Resource types
482482

@@ -488,21 +488,21 @@ Define a package resource to patch
488488

489489
The following parameters are available in the `patch_package` type.
490490

491-
* [`chocolatey`](#chocolatey)
492-
* [`name`](#name)
493-
* [`patch_window`](#patch_window)
491+
* [`chocolatey`](#-patch_package--chocolatey)
492+
* [`name`](#-patch_package--name)
493+
* [`patch_window`](#-patch_package--patch_window)
494494

495-
##### <a name="chocolatey"></a>`chocolatey`
495+
##### <a name="-patch_package--chocolatey"></a>`chocolatey`
496496

497497
Whether this is a Chocolatey package (Windows only)
498498

499-
##### <a name="name"></a>`name`
499+
##### <a name="-patch_package--name"></a>`name`
500500

501501
namevar
502502

503503
Name of the package to patch
504504

505-
##### <a name="patch_window"></a>`patch_window`
505+
##### <a name="-patch_package--patch_window"></a>`patch_window`
506506

507507
Puppet schedule to link package resource to
508508

@@ -514,27 +514,27 @@ Perform a clean reboot if it was pending before this agent run
514514

515515
The following parameters are available in the `reboot_if_pending` type.
516516

517-
* [`name`](#name)
518-
* [`os`](#os)
519-
* [`patch_window`](#patch_window)
517+
* [`name`](#-reboot_if_pending--name)
518+
* [`os`](#-reboot_if_pending--os)
519+
* [`patch_window`](#-reboot_if_pending--patch_window)
520520

521-
##### <a name="name"></a>`name`
521+
##### <a name="-reboot_if_pending--name"></a>`name`
522522

523523
namevar
524524

525525
Name of this resource (has no function)
526526

527-
##### <a name="os"></a>`os`
527+
##### <a name="-reboot_if_pending--os"></a>`os`
528528

529529
OS type from kernel fact
530530

531-
##### <a name="patch_window"></a>`patch_window`
531+
##### <a name="-reboot_if_pending--patch_window"></a>`patch_window`
532532

533533
Puppet schedule to link the reboot resource to
534534

535535
## Functions
536536

537-
### <a name="patching_as_codededupe_arch"></a>`patching_as_code::dedupe_arch`
537+
### <a name="patching_as_code--dedupe_arch"></a>`patching_as_code::dedupe_arch`
538538

539539
Type: Ruby 4.x API
540540

@@ -552,7 +552,7 @@ Data type: `Array`
552552

553553

554554

555-
### <a name="patching_as_codehigh_prio_last_run"></a>`patching_as_code::high_prio_last_run`
555+
### <a name="patching_as_code--high_prio_last_run"></a>`patching_as_code::high_prio_last_run`
556556

557557
Type: Ruby 4.x API
558558

@@ -576,7 +576,7 @@ Data type: `Array`
576576

577577

578578

579-
### <a name="patching_as_codeis_patchday"></a>`patching_as_code::is_patchday`
579+
### <a name="patching_as_code--is_patchday"></a>`patching_as_code::is_patchday`
580580

581581
Type: Puppet Language
582582

@@ -606,7 +606,7 @@ Data type: `String`
606606

607607

608608

609-
### <a name="patching_as_codelast_run"></a>`patching_as_code::last_run`
609+
### <a name="patching_as_code--last_run"></a>`patching_as_code::last_run`
610610

611611
Type: Ruby 4.x API
612612

@@ -630,7 +630,7 @@ Data type: `Array`
630630

631631

632632

633-
### <a name="patching_as_codeprocess_patch_groups"></a>`patching_as_code::process_patch_groups`
633+
### <a name="patching_as_code--process_patch_groups"></a>`patching_as_code::process_patch_groups`
634634

635635
Type: Puppet Language
636636

‎metadata.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "puppetlabs-patching_as_code",
3-
"version": "1.1.8",
3+
"version": "1.1.9",
44
"author": "puppetlabs",
55
"summary": "Automated patching through desired state code",
66
"license": "Apache-2.0",

0 commit comments

Comments
 (0)
Please sign in to comment.