Skip to content

Commit 8162396

Browse files
committed
docs: clarify bootable and revertable parameter precedence and conflict handling
Update documentation for both snapshot_lvm_bootable and snapshot_lvm_revertable to explicitly describe: - The two configuration locations (global vs. set-level) - Precedence rules (global takes precedence when set) - Conflict behavior (ERROR_BOOTABLE_CONFLICT or ERROR_REVERTABLE_CONFLICT) - That no snapshot is created when conflicting values are detected This addresses potential confusion about parameter precedence and makes it clear that conflicting values will cause the role to fail rather than silently choosing one value over the other. Signed-off-by: Todd Gill <tgill@redhat.com>
1 parent 9e5cdff commit 8162396

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -332,13 +332,41 @@ support snapshot manager (snapm). When set to true, and passed to the
332332
'snapshot' command, the snapshot created will have a corresponding boot
333333
entry. The boot entry will be removed when the snapset is removed.
334334

335+
This parameter can be set in two locations:
336+
337+
- **Global level**: `snapshot_lvm_bootable: true` applies to all snapshots
338+
- **Set level**: `bootable: true` in the `snapshot_lvm_set` definition
339+
340+
**Precedence and conflict handling:**
341+
342+
- If the global parameter is set, it takes precedence
343+
- If both global and set-level parameters are set to **different** values
344+
(e.g., global is `true` and set-level is `false`), the role will fail with
345+
`ERROR_BOOTABLE_CONFLICT` and no snapshot will be created
346+
- If both are set to the **same** value, the operation proceeds normally
347+
- If only one is set, that value is used
348+
335349
### snapshot_lvm_revertable
336350

337351
Boolean - default is false. Only supported on operating systems that
338352
support snapshot manager (snapm) version 0.5.0 or later. When set to true,
339353
and passed to the 'snapshot' command, the snapshot created will have a
340354
corresponding revert boot entry.
341355

356+
This parameter can be set in two locations:
357+
358+
- **Global level**: `snapshot_lvm_revertable: true` applies to all snapshots
359+
- **Set level**: `revertable: true` in the `snapshot_lvm_set` definition
360+
361+
**Precedence and conflict handling:**
362+
363+
- If the global parameter is set, it takes precedence
364+
- If both global and set-level parameters are set to **different** values
365+
(e.g., global is `true` and set-level is `false`), the role will fail with
366+
`ERROR_REVERTABLE_CONFLICT` and no snapshot will be created
367+
- If both are set to the **same** value, the operation proceeds normally
368+
- If only one is set, that value is used
369+
342370
To perform a disaster recovery revert:
343371

344372
1. Run `snapshot_lvm_action: revert` to initiate the revert operation

0 commit comments

Comments
 (0)