Improve documentation

This commit is contained in:
Raphael Dannecker 2025-03-26 14:51:31 +01:00
parent 1018912703
commit 88e650aae7
3 changed files with 59 additions and 4 deletions

View file

@ -1,10 +1,21 @@
# Custom roles
- Custom ansible roles can be stored in `roles/custom`
- To include custom roles into, you can list them in `custom_roles`.
- To include custom roles, you can list them in `custom_roles`.
## Configuration / Variables
* **custom_roles**
List of roles which will be applied
Type: *List of Strings*
Default: []
## Example
All hosts (e.g. 10.0.2.14) will get `role_a` and `role_c`,
but hosts in group laptop (e.g. 10.0.32.14) will get `role_a` and `role_b`
```
roles/custom/
├── role_a
@ -38,5 +49,3 @@ laptops:
- role_b
```
All hosts (e.g. 10.0.2.14) will get `role_a` and `role_c`,
but hosts in group laptop (e.g. 10.0.32.14) will get `role_a` and `role_b`

View file

@ -13,6 +13,25 @@ The associated password can be determined using the variable `localuser_password
Default: `Muster!`
## Configuration / Variables
* **localuser**
Username of local guest account
If set to `false` no user will be created
Type: *String*/*Boolean*
Values:
* `false` <-- (default)
* "username"
* **localuser_password**
Password of local guest user
Default: "Muster!"
Type: *String*
* **localuser_secretsalt**
Salt for creation of password hash
Default: "4ANAxPycC3q"
Type: *String*
## Example
* Create local guest user only on devices in group laptops.