Files
gitlab-mirror/roles/users/README.md
Alexander Gorelyshev 708d3c67d8 Fix minor README issues
2025-12-18 17:23:33 +04:00

63 lines
1.3 KiB
Markdown

users
=====
Create user accounts according to a YAML manifest.
Controls:
- username and UID
- groupname and GID
- homedir creation
- GECOS field (typically full user name)
- shell
- SSH public key deployment to `.ssh/authorized_keys`
- account expiration
- memory, swap and CPU allocation limits via user slices
Check out [corvus-migratorius/ansible-disk-quotas](https://github.com/corvus-migratorius/ansible-disk-quotas) for controlling non-root filesystem quotas.
Requirements
------------
Target node:
- `systemd`
- openssh client library
Controller:
- `passlib` (for working with user passwords)
Role Variables
--------------
`manifest_path`: a YAML file containing user definitions (see `molecule/default/users.yml` for an example)
`users`: a list of objects mirroring the YAML structure expected by `manifest_path`; takes precedence over it
`common_memory_max`: e.g. `"500M"`, optional
`common_swap_max`: e.g. `"2G"`, optional
`common_cpu_quota`: e.g. `"100%"`, optional
Dependencies
------------
Example Playbook
----------------
- Configuring users in a YAML manifest: [converge.yml](molecule/default/converge.yml)
- Configuring user list as a variable: [converge.yml](molecule/users_from_var/converge.yml)
License
-------
BSD
Author Information
------------------
corvus-migratorius@proton.me
sayganova@genlab.llc