Skip to content

Commit

Permalink
Merge pull request #465 from beechtom/MODULES-10477-readme-update
Browse files Browse the repository at this point in the history
(MODULES-10477) Update task documentation
  • Loading branch information
beechtom authored Jan 27, 2020
2 parents 60a0f3b + 2517807 commit 37ce739
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 6 deletions.
23 changes: 18 additions & 5 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -303,15 +303,28 @@ This is only applicable for Windows operating systems and pertains to /files/ins

#### `puppet_agent::version`

Checks for the version of puppet-agent package installed. Returns results as `{"version": "<ver>", "source": "<how version was
detected>"}`. If a version cannot be found, returns `{"version": null}`.
Checks for the version of puppet-agent package installed.

**Return value**

The `puppet_agent::version` task returns a Result on success specifying the version of the agent installed and how it was detected.

```
{
"version": <version>,
"source": <source>
}
```

#### `puppet_agent::install`

Installs the puppet-agent package. Currently only supports Linux variants: Debian, Ubuntu, SLES, RHEL/CentOS/Fedora, Amazon Linux 2. A specific
package `version` can be specified; if not, will install or upgrade to the latest Puppet 5 version available.
Installs the puppet-agent package.

> **Note:** The `puppet_agent::install_shell` task requires the `facts::bash` implementation from the [facts](https://forge.puppet.com/puppetlabs/facts) module. Both the `puppet_agent` and `facts` modules are packaged with Bolt. For use outside of Bolt make sure the `facts` module is installed to the same `modules` directory as `puppet_agent`.
**Return value**

**Note**: The `puppet_agent::install_shell` task requires the `facts::bash` implementation from the [facts](https://forge.puppet.com/puppetlabs/facts) module. Both the `puppet_agent` and `facts` modules are packaged with Bolt. For use outside of Bolt make sure the `facts` module is installed to the same `modules` directory as `puppet_agent`.
The task returns the output of the installation script.

## Limitations

Expand Down
2 changes: 1 addition & 1 deletion tasks/install.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"description": "Install the Puppet agent package",
"parameters": {
"version": {
"description": "The version of puppet-agent to install",
"description": "The version of puppet-agent to install (defaults to latest when no agent is installed)",
"type": "Optional[String]"
},
"collection": {
Expand Down

0 comments on commit 37ce739

Please sign in to comment.