Skip to content

Commit b4d176f

Browse files
authored
Merge pull request #39 from vchepkov/targets
change nodes to targets in README
2 parents 8fe8c55 + 0fd048e commit b4d176f

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
A framework for building patching workflows. This module is designed to be used as building
3939
blocks for complex patching environments of Windows and Linux (RHEL, Ubuntu) systems.
4040

41-
No Puppet agent is required on the end nodes. The node executing the patching will need to
41+
No Puppet agent is required on the end targets. The node executing the patching will need to
4242
have `bolt` installed.
4343

4444
## Setup
@@ -66,7 +66,7 @@ mod 'encore/patching'
6666
EOF
6767

6868
bolt puppetfile install
69-
bolt plan run patching::available_updates --nodes group_a
69+
bolt plan run patching::available_updates --targets group_a
7070

7171
# install rbvmomi for VMware snapshot support
7272
/opt/puppetlabs/bolt/bin/gem install --user-install rbvmomi
@@ -77,9 +77,9 @@ bolt plan run patching::available_updates --nodes group_a
7777
This module is designed to work in enterprise patching environments.
7878

7979
Assumptions:
80-
* RHEL nodes are registered to Satellite / Foreman or the internet
81-
* Ubuntu nodes are registered to Landscape or the internet
82-
* Windows nodes are registered to WSUS and Chocolatey (optional)
80+
* RHEL targets are registered to Satellite / Foreman or the internet
81+
* Ubuntu targets are registered to Landscape or the internet
82+
* Windows targets are registered to WSUS and Chocolatey (optional)
8383

8484
Registration to a central patching server is preferred for speed of software downloads
8585
and control of phased patching promotions.
@@ -94,7 +94,7 @@ these central patching server tools.
9494
`patching` is designed around `bolt` tasks and plans.
9595

9696
Individual tasks have been written to accomplish targeted steps in the patching process.
97-
Examples: `patching::available_updates` is used to check for available updates on target nodes.
97+
Examples: `patching::available_updates` is used to check for available updates on targets.
9898

9999
Plans are then used to pretty up output and tie tasks together.
100100

@@ -129,14 +129,14 @@ This workflow consists of the following phases:
129129

130130
### Check for available updates
131131

132-
This will reach out to all nodes in `group_a` in your inventory and check for any available
132+
This will reach out to all targets in `group_a` in your inventory and check for any available
133133
updates through the system's package manager:
134134
* RHEL = yum
135135
* Ubuntu = apt
136136
* Windows = Windows Update + Chocolatey (if installed)
137137

138138
``` shell
139-
bolt plan run patching::available_updates --nodes group_a
139+
bolt plan run patching::available_updates --targets group_a
140140
```
141141

142142
### Disable monitoring
@@ -148,7 +148,7 @@ This plan/task utilizes the `remote` transport []
148148

149149

150150
``` shell
151-
bolt plan run patching::monitoring_solarwinds --nodes group_a action=disable' monitoring_target=solarwinds
151+
bolt plan run patching::monitoring_solarwinds --targets group_a action=disable' monitoring_target=solarwinds
152152
```
153153
154154
### Create snapshots
@@ -159,7 +159,7 @@ be the `uri` of the node the inventory file.
159159
``` shell
160160
/opt/puppetlabs/bolt/bin/gem install rbvmomi
161161
162-
bolt plan run patching::snapshot_vmware --nodes group_a action='create' vsphere_host='vsphere.domain.tld' vsphere_username='xyz' vsphere_password='abc123' vsphere_datacenter='dctr1'
162+
bolt plan run patching::snapshot_vmware --targets group_a action='create' vsphere_host='vsphere.domain.tld' vsphere_username='xyz' vsphere_password='abc123' vsphere_datacenter='dctr1'
163163
```
164164
165165
### Perform pre-patching checks and actions
@@ -172,10 +172,10 @@ Best practice is to define and distribute these scripts as part of your normal P
172172
as part of othe role for that node.
173173
174174
``` shell
175-
bolt plan run patching::pre_update --nodes group_a
175+
bolt plan run patching::pre_update --targets group_a
176176
```
177177
178-
By default this executes the following scripts (nodes where the script doesn't exist are ignored):
178+
By default this executes the following scripts (targets where the script doesn't exist are ignored):
179179
* Linux = `/opt/patching/bin/pre_update.sh`
180180
* Windows = `C:\ProgramData\patching\pre_update.ps1`
181181

@@ -236,7 +236,7 @@ Then, for each group:
236236
* `patching::snapshot_vmware action='delete'`
237237

238238
``` shell
239-
bolt plan run patching --nodes group_a
239+
bolt plan run patching --targets group_a
240240
```
241241

242242
### Patching with Puppet Enterprise (PE)
@@ -275,7 +275,7 @@ in the inventory file.
275275

276276
For details on all of the available configuration options, see [REFERENCE_CONFIGURATION.md](REFERENCE_CONFIGURATION.md)
277277

278-
Example: Let's say we want to prevent some nodes from rebooting during patching.
278+
Example: Let's say we want to prevent some targets from rebooting during patching.
279279
This can be customized with the `patching_reboot_strategy` variable in inventory:
280280
281281
``` yaml

0 commit comments

Comments
 (0)