Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rgl/packer-plugin-windows-update
Packer plugin for installing Windows updates
https://github.com/rgl/packer-plugin-windows-update
packer windows windows-updates
Last synced: 17 days ago
JSON representation
Packer plugin for installing Windows updates
- Host: GitHub
- URL: https://github.com/rgl/packer-plugin-windows-update
- Owner: rgl
- License: mpl-2.0
- Created: 2017-04-26T17:42:46.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-07T06:31:30.000Z (2 months ago)
- Last Synced: 2024-10-03T10:22:14.019Z (about 1 month ago)
- Topics: packer, windows, windows-updates
- Language: PowerShell
- Size: 233 KB
- Stars: 303
- Watchers: 26
- Forks: 71
- Open Issues: 39
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Packer Windows Update Provisioner
[](https://github.com/rgl/packer-plugin-windows-update/actions?query=workflow%3ABuild)
This is a Packer plugin for installing Windows updates (akin to [rgl/vagrant-windows-update](https://github.com/rgl/vagrant-windows-update)).
**NB** This was only tested with Packer 1.11.2 and the images at [rgl/windows-vagrant](https://github.com/rgl/windows-vagrant), so YMMV.
# Usage
Configure your packer template to require a [release version of the plugin](https://github.com/rgl/packer-plugin-windows-update/releases), e.g.:
```hcl
packer {
required_plugins {
windows-update = {
version = "0.16.8"
source = "github.com/rgl/windows-update"
}
}
}
```
Initialize your packer template (it will install the plugin):
```bash
packer init your-template.pkr.hcl
```
Use this provisioner plugin from your packer template file, e.g. like in [rgl/windows-vagrant](https://github.com/rgl/windows-vagrant):
```hcl
build {
provisioner "windows-update" {
}
}
```
Note, the plugin automatically restarts the machine after Windows Updates are applied. The reboots occur similar to the windows-restart provisioner built into packer where packer is aware that a shutdown is in progress.
## Search Criteria, Filters and Update Limit
You can select which Windows Updates are installed by defining the search criteria, a set of filters, and how many updates are installed at a time.
Normally you would use one of the following settings:
| Name | `search_criteria` | `filters` |
|---------------|---------------------------------------------|-----------------|
| Important | `AutoSelectOnWebSites=1 and IsInstalled=0` | `$true` |
| Recommended | `BrowseOnly=0 and IsInstalled=0` | `$true` |
| All | `IsInstalled=0` | `$true` |
| Optional Only | `AutoSelectOnWebSites=0 and IsInstalled=0` | `$_.BrowseOnly` |
**NB** `Recommended` is the default setting.
But you can customize them, e.g.:
```hcl
build {
provisioner "windows-update" {
search_criteria = "IsInstalled=0"
filters = [
"exclude:$_.Title -like '*Preview*'",
"include:$true",
]
update_limit = 25
}
}
```
**NB** For more information about the search criteria see the [IUpdateSearcher::Search method](https://docs.microsoft.com/en-us/windows/desktop/api/wuapi/nf-wuapi-iupdatesearcher-search) documentation and the [xWindowsUpdateAgent DSC resource source](https://github.com/PowerShell/xWindowsUpdate/blob/dev/DscResources/MSFT_xWindowsUpdateAgent/MSFT_xWindowsUpdateAgent.psm1).
**NB** If the `update_limit` attribute is not declared, it defaults to `1000`.
The general filter syntax is:
ACTION:EXPRESSION
`ACTION` is a string that can have one of the following values:
| action | description |
| --------- | ------------------------------------------------------------ |
| `include` | includes the update when the expression evaluates to `$true` |
| `exclude` | excludes the update when the expression evaluates to `$true` |
**NB** If no `ACTION` evaluates to `$true` the update will **NOT** be installed.
`EXPRESSION` is a PowerShell expression. When it returns `$true`, the
`ACTION` is executed and no further filters are evaluated.
Inside an expression, the Windows Update [IUpdate interface](https://msdn.microsoft.com/en-us/library/windows/desktop/aa386099(v=vs.85).aspx) can be referenced by the `$_` variable.
# Development
Build:
```bash
make
```
Install the [rgl/windows-vagrant](https://github.com/rgl/windows-vagrant) vagrant box.
Test with QEMU:
```bash
make test
```