sandwich/Ansible-Bootstrap
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(readme): document every system.users attribute and per-disk storage

Browse Source
This commit is contained in:
sandwich
2026-10-05 18:05:05 +02:00
parent 2d1a875577
commit 7253f6af96
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6
View File
@@ -238,6 +238,11 @@ system:
| `password` | string | -- | User password (required for at least one user) | | `password` | string | -- | User password (required for at least one user) |
| `keys` | list | `[]` | SSH public keys | | `keys` | list | `[]` | SSH public keys |
| `sudo` | bool/string | -- | `true` for NOPASSWD ALL, or custom sudoers string | | `sudo` | bool/string | -- | `true` for NOPASSWD ALL, or custom sudoers string |
| `groups` | list | derived | Supplementary groups; empty means the platform sudo group when `sudo` is set |
| `shell` | string | `/bin/bash` | Login shell |
| `password_login` | bool | `false` | Read by the main repository's SSH hardening, ignored here |
| `uid` | int | -- | Read by the main repository's user actions; the bootstrap assigns `1000 + index` |
| `disabled` | bool | `false` | Read by the main repository's user actions, ignored here |
Users must be defined in inventory. The dict format enables additive merging across inventory layers with `hash_behaviour=merge`. Users must be defined in inventory. The dict format enables additive merging across inventory layers with `hash_behaviour=merge`.
@@ -544,6 +549,7 @@ On VMware, `device` is resolved on the target from the SCSI address instead: ent
| ------------- | ------ | ------------------------------------------------------ | | ------------- | ------ | ------------------------------------------------------ |
| `size` | number | Disk size in GB (required for virtual) | | `size` | number | Disk size in GB (required for virtual) |
| `device` | string | Block device path (required for physical data disks) | | `device` | string | Block device path (required for physical data disks) |
| `storage` | string | Proxmox storage for this disk; empty uses `hypervisor.storage` |
| `partition` | string | Derived from `device` during normalization (not user input) | | `partition` | string | Derived from `device` during normalization (not user input) |
| `mount.path` | string | Mount point (additional disks only) | | `mount.path` | string | Mount point (additional disks only) |
| `mount.fstype`| string | `btrfs`, `ext4`, or `xfs` | | `mount.fstype`| string | `btrfs`, `ext4`, or `xfs` |