Document partitioning overrides and inventory host vars
This commit is contained in:
14
README.md
14
README.md
@@ -105,7 +105,7 @@ These are required when `hypervisor: vmware` uses the `vmware_tools` connection.
|
||||
| `luks_passphrase` | Passphrase used for initial LUKS format/unlock. | `1234` |
|
||||
| `luks_mapper_name` | Decrypted mapper name. | `SYSTEM_DECRYPTED` |
|
||||
| `luks_auto_decrypt` | Enable automatic unlock on boot. | `true`, `false` |
|
||||
| `luks_auto_decrypt_method` | Auto-unlock method. | `tpm2`, `keyfile` |
|
||||
| `luks_auto_decrypt_method` | Auto-unlock method. | `tpm2`, `keyfile`, `manual` |
|
||||
| `luks_tpm2_device` | TPM2 device for enrollment. | `auto` |
|
||||
| `luks_tpm2_pcrs` | TPM2 PCR list (systemd-cryptenroll). | `7` |
|
||||
| `luks_keyfile_size` | Keyfile size in bytes for initramfs. | `64` |
|
||||
@@ -119,6 +119,17 @@ These are required when `hypervisor: vmware` uses the `vmware_tools` connection.
|
||||
| `luks_use_urandom` | Reserved; module uses cryptsetup defaults. | `true` |
|
||||
| `luks_verify_passphrase` | Reserved; module uses cryptsetup defaults. | `true` |
|
||||
|
||||
### 2.5 Partitioning Overrides (advanced)
|
||||
|
||||
Use these only when you need to override the default layout logic.
|
||||
|
||||
| Variable | Description | Example Value |
|
||||
| ---------------------------- | -------------------------------------------------------- | ------------- |
|
||||
| `partitioning_efi_size_mib` | ESP size in MiB. | `512` |
|
||||
| `partitioning_boot_size_mib` | `/boot` size in MiB when a separate boot is used. | `1024` |
|
||||
| `partitioning_separate_boot` | Force a separate `/boot` partition. | `true` |
|
||||
| `partitioning_boot_fs_fstype` | Filesystem for `/boot` when separate. | `ext4` |
|
||||
|
||||
To protect sensitive information, such as passwords, API keys, and other confidential variables (e.g., `hypervisor_password`), **it is recommended to use Ansible Vault**.
|
||||
|
||||
## 3. Inventory Variables
|
||||
@@ -129,6 +140,7 @@ Inventory variables are defined for individual hosts or VMs in the inventory fil
|
||||
|
||||
| Variable | Description | Example Value |
|
||||
| ------------ | -------------------------------------- | ---------------------- |
|
||||
| `ansible_host` | Ansible connection address for the host. | `192.168.0.10` |
|
||||
| `os` | Operating system to be installed. | `ubuntu-lts` |
|
||||
| `filesystem` | Filesystem type for the root volume. | `btrfs`, `ext4`, `xfs` |
|
||||
| `hostname` | The hostname assigned to the system. | `vm01` |
|
||||
|
||||
Reference in New Issue
Block a user