group

manage a group

Keys

KeyTypeDefaultMeaning
namestringrequired
gidID-
systembooleanfalsesystem group, at creation only
absentbooleanfalse

group.name

string, required

A new group's name has lowercase letters, digits, _, and -, and does not start with a digit or -. It has at most 32 characters.

group.gid

ID

A whole number. A gid that another group has fails the check.

group.system

boolean, default false

System group, at creation only. It counts only when the step creates the group.

group.absent

boolean, default false

Remove the group. The check fails when the group is the primary group of a user.

Example

- group:
    name: deploy
    system: true