Skip to content

promise-types/groups/README.md: Formatted file and added syntax highlighting #152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
olehermanse merged 2 commits into from
Jul 29, 2026
Merged

promise-types/groups/README.md: Formatted file and added syntax highlighting #152

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8258f78
Added syntax highlighting to README.md for groups promise type
larsewi Jul 29, 2026
725a214
Formatted README.md for groups promise type
larsewi Jul 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions promise-types/groups/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,21 @@ The `groups` promise type helps managing local groups, letting you ensure some u

## Requirements

* Unix-like system.
- Unix-like system.

## Attributes

| Name | Type | Description | Mandatory | Default |
| --------- | --------------------------- | ----------------------------------------------------------------------------------------------- | --------- | ------- |
| `policy` | `string` | Whether group should be present or absent on the local host | no | present |
| `members` | `string` / `data` / `body` | JSON string / data container / custom body containing attributes "include", "exclude" & "only" | no | - |
| `gid` | `integer` | The GID of the group | no | - |
| Name | Type | Description | Mandatory | Default |
| --------- | -------------------------- | ---------------------------------------------------------------------------------------------- | --------- | ------- |
| `policy` | `string` | Whether group should be present or absent on the local host | no | present |
| `members` | `string` / `data` / `body` | JSON string / data container / custom body containing attributes "include", "exclude" & "only" | no | - |
| `gid` | `integer` | The GID of the group | no | - |

## Examples

Present group `foo` including user `alice` and `bob`, but excluding user `malcom`:

```
```cf3
@if minimum_version(3.20)
body members foo
{
Expand All @@ -43,7 +43,7 @@ bundle agent main

Present group `bar` with GID `123` including only user `alice`:

```
```cf3
@if minimum_version(3.20)
body members bar
{
Expand All @@ -66,7 +66,7 @@ bundle agent main

Absent group `baz`:

```
```cf3
bundle agent main
{
groups:
Expand Down
Loading