Skip to content

Commit a800565

Browse files
committed
Update docs to reflect tasks
1 parent 03db941 commit a800565

File tree

2 files changed

+399
-7
lines changed

2 files changed

+399
-7
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,26 @@ class { 'zendhq':
3535
}
3636
```
3737

38+
Creating a new group and user with read-only permissions using Bolt.
39+
40+
```
41+
$ bolt task run zendhq::group_add group=readonly permissions='r zray,mon,conf,ct,jq' -t zendhq_server
42+
$ bolt task run zendhq::group_print group=readonly -t zendhq_server # verify group creation and permissions
43+
$ bolt task run zendhq::user_add user=readonly_user password=readonly_password group=readonly -t zendhq_server
44+
$ bolt task run zendhq::user_print user=readonly_user -t zendhq_server # verify user creation and permissions
45+
```
46+
47+
## Tasks
48+
49+
Installation of ZendHQ comes with a helpful tool, `zendhqctl`, for managing
50+
groups, users, and their permissions. While this CLI could be called with
51+
Puppet's `exec` functionality, this module comes with tasks for all the
52+
`zendhqctl` commands, making them easy to call with
53+
[PE](https://www.puppet.com/docs/pe/latest/running_tasks_from_the_command_line.html)
54+
or [Bolt](https://www.puppet.com/docs/bolt/latest/bolt_running_tasks).
55+
56+
Please see the reference below for a list of tasks in this module.
57+
3858
## Reference
3959

4060
See [REFERENCE.md](./REFERENCE.md)

0 commit comments

Comments
 (0)