Skip to content

Commit ff26a50

Browse files
committed
update docs for openvox-agent installation via apply_prep
1 parent 82caa5d commit ff26a50

File tree

2 files changed

+21
-20
lines changed

2 files changed

+21
-20
lines changed

documentation/applying_manifest_blocks.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ Manifest blocks require facts to compile. When Bolt applies Puppet manifests, it
3333
automatically installs the packages necessary to run the apply command and
3434
gathers facts using [facter](https://puppet.com/docs/facter/latest/), making the
3535
facts available to the manifest block. Bolt also identifies targets that do not
36-
have Puppet agents and runs the [`puppet_agent::install`
37-
task](https://forge.puppet.com/puppetlabs/puppet_agent) to install the agent.
36+
have Puppet agents and runs the [`openvox_bootstrap::install`
37+
task](https://forge.puppet.com/puppet/openvox_bootstrap) to install the agent.
3838

39-
> **Note:** Bolt installs the Puppet agent package to enable the use of Puppet
39+
> **Note:** Bolt installs the OpenVox agent package to enable the use of Puppet
4040
code. It does not require setting up a server-agent architecture between the
4141
remote systems and the local system running Bolt.
4242

@@ -160,8 +160,8 @@ The `apply_prep` function installs the packages necessary to run the apply
160160
command and gathers facts by running
161161
[facter](https://puppet.com/docs/facter/latest/), making the facts available to
162162
the manifest block. The `apply_prep` function also identifies the targets that
163-
do not have Puppet agents and runs the [`puppet_agent::install`
164-
task](https://forge.puppet.com/puppetlabs/puppet_agent) to install the agent.
163+
do not have Puppet agents and runs the [`openvox_bootstrap::install`
164+
task](https://forge.puppet.com/puppet/openvox_bootstrap) to install the agent.
165165

166166
> **Note:** Bolt installs the Puppet agent package to enable the use of Puppet
167167
code. It does not require setting up a server-agent architecture between the
@@ -240,7 +240,7 @@ access the `logs` key in the report hash:
240240
plan example (
241241
TargetSpec $targets
242242
) {
243-
# Install the puppet-agent package and gather facts
243+
# Install the openvox-agent package and gather facts
244244
$targets.apply_prep
245245
246246
# Apply Puppet code
@@ -400,7 +400,7 @@ Create a manifest that sets up a web server with nginx, and run it as a plan.
400400
String $site_content = 'hello!',
401401
) {
402402
403-
# Install the puppet-agent package if Puppet is not detected.
403+
# Install the openvox-agent package if neither openvox-agent nor puppet-agent are detected.
404404
# Copy over custom facts from the Bolt modulepath.
405405
# Run the `facter` command line tool to gather target information.
406406
$targets.apply_prep
@@ -479,7 +479,7 @@ Create a manifest that sets up a web server with IIS and run it as a plan.
479479
String $site_content = 'hello!',
480480
) {
481481
482-
# Install the puppet-agent package if Puppet is not detected.
482+
# Install the openvox-agent package if neither openvox-agent nor puppet-agent are detected.
483483
# Copy over custom facts from the Bolt modulepath.
484484
# Run the `facter` command line tool to gather target information.
485485
$targets.apply_prep

documentation/bolt_inventory_reference.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,13 @@ level apply to all groups and targets in the inventory file.
5454

5555
- **Type:** Array
5656

57-
> 🔩 **Tip:** You can set the `puppet-agent` feature to indicate that Bolt
58-
> should skip installing the Puppet agent on all targets when using
59-
> `bolt apply` or the `apply_prep` plan function.
57+
> 🔩 **Tip:** You can set the `openvox-agent` feature to indicate that Bolt
58+
> should skip installing the OpenVox agent on all targets when using
59+
> `bolt apply` or the `apply_prep` plan function. `puppet-agent` is a synonym.
6060

6161
```yaml
6262
features:
63-
- puppet-agent
63+
- openvox-agent
6464
```
6565

6666
### `groups`
@@ -154,15 +154,16 @@ all groups and targets under the group.
154154

155155
- **Type:** Array
156156

157-
> 🔩 **Tip:** You can set the `puppet-agent` feature on the group to indicate
158-
> that Bolt should skip installing the Puppet agent on all targets under the
159-
> group when using `bolt apply` or the `apply_prep` plan function.
157+
> 🔩 **Tip:** You can set the `openvox-agent` feature on the group to indicate
158+
> that Bolt should skip installing the OpenVox agent on all targets under the
159+
> group when using `bolt apply` or the `apply_prep` plan function. `puppet-agent`
160+
> is a synonym.
160161

161162
```yaml
162163
groups:
163164
- name: agents
164165
features:
165-
- puppet-agent
166+
- openvox-agent
166167
```
167168

168169
### `groups`
@@ -315,15 +316,15 @@ A list of available features for the target.
315316

316317
- **Type:** Array
317318

318-
> 🔩 **Tip:** You can set the `puppet-agent` feature on the target to indicate
319-
> that Bolt should skip installing the Puppet agent on the target when using
320-
> `bolt apply` or the `apply_prep` plan function.
319+
> 🔩 **Tip:** You can set the `openvox-agent` feature on the target to indicate
320+
> that Bolt should skip installing the OpenVox agent on the target when using
321+
> `bolt apply` or the `apply_prep` plan function. `puppet-agent` is a synonym.
321322

322323
```yaml
323324
targets:
324325
- uri: linux.example.com
325326
features:
326-
- puppet-agent
327+
- openvox-agent
327328
```
328329

329330
### `name`

0 commit comments

Comments
 (0)