Skip to content

Commit 7b0213e

Browse files
trgilltrgill
committed
feat: add support for "bootable" snapshots
This feature is only support on platforms that support snapshot manager (snapm) The bootable flag, when used with the snapm create command, creates a boot menu entry for the snapshot set. This allows the user to select the boot menu entry on reboot that will use the newly created snapshot set. Signed-off-by: Todd Gill <tgill@redhat.com>
1 parent 4f0f4c2 commit 7b0213e

File tree

8 files changed

+243
-3
lines changed

8 files changed

+243
-3
lines changed

‎README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ Sets are defined in the following format:
5454
```yaml
5555
snapshot_lvm_set:
5656
name: snapset1
57+
bootable: true
5758
volumes:
5859
- name: snapshot VG1 LV1
5960
vg: test_vg1
@@ -84,6 +85,7 @@ that it applies, for example:
8485
```yaml
8586
snapshot_lvm_set:
8687
name: snapset1
88+
bootable: false
8789
volumes:
8890
- name: snapshot VG1 LV1
8991
vg: test_vg1
@@ -243,6 +245,18 @@ the rest will be excluded. For example,
243245
`snapshot_lvm_vg_include: "^sql_db_"` will only operate on volume groups
244246
whose names start with `sql_db_`. This uses the Python `re.search`.
245247

248+
### snapshot_lvm_bootable
249+
250+
Boolean - default is unset. Only supported on operating systems that
251+
support snapshot manager (snapm). When set to true, and passed to the
252+
'snapshot' command, the snapshot created will have a corresponding boot
253+
entry. The boot entry will be removed when the snapset is removed.
254+
255+
### snapshot_use_copr (EXPERIMENTAL)
256+
257+
Boolean - default is unset - if you want to enable the copr repo to use the
258+
latest development version of snapm, use `snapshot_use_copr: true`
259+
246260
### Variables Exported by the Role
247261

248262
#### snapshot_facts

‎library/snapshot.py‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,13 +95,21 @@
9595
to a regex pattern that matches the names of the volume groups you want to use and
9696
the rest will be excluded
9797
type: str
98+
snapshot_lvm_bootable:
99+
description: Only supported on operating systems that support snapshot manager (snapm).
100+
When set to true, and passed to the 'snapshot' command, the snapshot created will have
101+
a corresponding boot entry. The boot entry will be removed when the snapset is removed.
102+
type: bool
98103
snapshot_lvm_set:
99104
description: set of volumes
100105
type: dict
101106
suboptions:
102107
name:
103108
description: name of set
104109
type: str
110+
bootable:
111+
description: create snapshot with boot menu entry (requires snapm)
112+
type: bool
105113
volumes:
106114
description: list of volumes
107115
type: list
@@ -282,6 +290,7 @@ def run_module():
282290
snapshot_lvm_all_vgs=dict(type="bool"),
283291
snapshot_lvm_verify_only=dict(type="bool"),
284292
snapshot_lvm_mount_origin=dict(type="bool"),
293+
snapshot_lvm_bootable=dict(type="bool"),
285294
snapshot_lvm_mountpoint_create=dict(type="bool"),
286295
snapshot_lvm_unmount_all=dict(type="bool"),
287296
snapshot_lvm_percent_space_required=dict(type="str"),
@@ -296,6 +305,7 @@ def run_module():
296305
type="dict",
297306
options=dict(
298307
name=dict(type="str"),
308+
bootable=dict(type="bool"),
299309
volumes=dict(
300310
type="list",
301311
elements="dict",

‎module_utils/snapshot_lsr/lvm.py‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,11 @@ def get_json_from_args(module, module_args, vg_include):
8181
if module_args["snapshot_lvm_snapset_name"]:
8282
args_dict["name"] = module_args["snapshot_lvm_snapset_name"]
8383

84+
if module_args["snapshot_lvm_bootable"]:
85+
args_dict["bootable"] = module_args["snapshot_lvm_bootable"]
86+
else:
87+
args_dict["bootable"] = False
88+
8489
for vg, lv_list in vgs_lvs_iterator(
8590
module,
8691
module_args["snapshot_lvm_vg"],

‎module_utils/snapshot_lsr/snapmgr.py‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,10 @@ def mgr_snapshot_cmd(module, module_args, snapset_json):
200200

201201
snapset_name = snapset_json["name"]
202202
volume_list = snapset_json["volumes"]
203+
if "bootable" in snapset_json:
204+
bootable = snapset_json["bootable"]
205+
else:
206+
bootable = False
203207

204208
source_list = mgr_get_source_list_for_create(volume_list)
205209

@@ -210,7 +214,10 @@ def mgr_snapshot_cmd(module, module_args, snapset_json):
210214

211215
try:
212216
manager.create_snapshot_set(
213-
snapset_name, source_list, SNAPM_DEFAULT_SIZE_POLICY
217+
snapset_name,
218+
source_list,
219+
SNAPM_DEFAULT_SIZE_POLICY,
220+
boot=bootable,
214221
)
215222
changed = True
216223
except snapm.SnapmError as snap_err:

‎module_utils/snapshot_lsr/validate.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ def get_json_from_args(module, module_args, vg_include):
3333
if module_args["snapshot_lvm_snapset_name"]:
3434
args_dict["name"] = module_args["snapshot_lvm_snapset_name"]
3535

36+
if module_args["snapshot_lvm_bootable"]:
37+
args_dict["bootable"] = module_args["snapshot_lvm_bootable"]
38+
3639
for vg, lv_list in vgs_lvs_iterator(
3740
module,
3841
module_args["snapshot_lvm_vg"],

‎tasks/enable_copr.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
# Primarily for testing unreleased versions
3+
- name: Enable snapm copr on Fedora
4+
command: dnf -y copr enable packit/snapshotmanager-snapm-357
5+
when: ansible_facts['distribution'] == 'Fedora'
6+
changed_when: true

‎tasks/main.yml‎

Lines changed: 55 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,64 @@
33
- name: Set platform/version specific variables
44
include_tasks: tasks/set_vars.yml
55

6+
- name: Enable copr if requested
7+
include_tasks: enable_copr.yml
8+
when: snapshot_use_copr | d(false)
9+
610
- name: Ensure required packages are installed
711
package:
812
name: "{{ __snapshot_packages }}"
913
state: present
1014
use: "{{ (__snapshot_is_ostree | d(false)) |
1115
ternary('ansible.posix.rhel_rpm_ostree', omit) }}"
1216

17+
- name: Get snapm version
18+
check_mode: false
19+
command: snapm --version
20+
changed_when: false
21+
register: __snapshot_snapm_version_output
22+
# Ignore errors as snapm may not be available
23+
ignore_errors: true
24+
25+
- name: Set snapm availability fact
26+
set_fact:
27+
__snapshot_snapm_available: "{{ __snapshot_snapm_version_output is success }}"
28+
29+
- name: Set snapm version
30+
set_fact:
31+
__snapshot_snapm_version: "{{ (__snapshot_snapm_version_output.stdout) }}"
32+
when:
33+
- __snapshot_snapm_available
34+
35+
- name: Package snapm version must be 0.4 or later
36+
fail:
37+
msg: >
38+
Package snapm version {{ __snapshot_snapm_version }} is too old -
39+
must be 0.4 or later
40+
when:
41+
- __snapshot_snapm_available
42+
- __snapshot_snapm_version is version("0.4", "<")
43+
44+
- name: Package snapm required for bootable snapsets
45+
fail:
46+
msg: >
47+
Package snapm is required for bootable snapsets
48+
when:
49+
- not __snapshot_snapm_available
50+
- snapshot_lvm_bootable | d(false)
51+
52+
- name: Package snapm version must be 0.5 or later bootable snapsets
53+
fail:
54+
msg: >
55+
Package snapm version {{ __snapshot_snapm_version }} is too old -
56+
must be 0.5 or later to use bootable snapsets
57+
when:
58+
- __snapshot_snapm_available
59+
- __snapshot_snapm_version is version("0.5", "<")
60+
- snapshot_lvm_bootable | d(false)
61+
1362
- name: Run snapshot module and handle errors
63+
when: snapshot_lvm_action is defined
1464
block:
1565
- name: Run snapshot module {{ snapshot_lvm_action }}
1666
snapshot:
@@ -19,6 +69,7 @@
1969
snapshot_lvm_all_vgs: "{{ snapshot_lvm_all_vgs | d(false) }}"
2070
snapshot_lvm_verify_only: "{{ snapshot_lvm_verify_only | d(false) }}"
2171
snapshot_lvm_mount_origin: "{{ snapshot_lvm_mount_origin | d(false) }}"
72+
snapshot_lvm_bootable: "{{ snapshot_lvm_bootable | d(false) }}"
2273
snapshot_lvm_mountpoint_create: "{{
2374
snapshot_lvm_mountpoint_create | d(false) }}"
2475
snapshot_lvm_unmount_all: "{{ snapshot_lvm_unmount_all | d(false) }}"
@@ -41,20 +92,22 @@
4192

4293
always:
4394
- name: Print out response
95+
when: snapshot_cmd is defined
4496
debug:
4597
var: snapshot_cmd
4698
verbosity: 2
4799

48100
- name: Set result
101+
when: snapshot_cmd is defined
49102
set_fact:
50103
snapshot_cmd: "{{ snapshot_cmd }}"
51104

52105
- name: Set snapshot_facts to the JSON results
53106
set_fact:
54107
snapshot_facts: "{{ snapshot_cmd['data'] }}"
55-
when: snapshot_lvm_action == "list"
108+
when: snapshot_cmd is defined and snapshot_lvm_action == "list"
56109

57110
- name: Show errors
58111
debug:
59112
var: snapshot_cmd["errors"]
60-
when: snapshot_cmd["return_code"] != 0
113+
when: snapshot_cmd is defined and snapshot_cmd["return_code"] != 0

‎tests/tests_set_bootable.yml‎

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
---
2+
- name: Snapshot a set of volumes with snapshot_lvm_bootable set to true
3+
hosts: all
4+
vars:
5+
test_disk_min_size: "1g"
6+
test_disk_count: 10
7+
test_storage_pools:
8+
- name: test_vg1
9+
disks: "{{ range(0, 3) | map('extract', unused_disks) | list }}"
10+
volumes:
11+
- name: lv1
12+
size: "15%"
13+
- name: lv2
14+
size: "50%"
15+
- name: test_vg2
16+
disks: "{{ range(3, 6) | map('extract', unused_disks) | list }}"
17+
volumes:
18+
- name: lv3
19+
size: "10%"
20+
- name: lv4
21+
size: "20%"
22+
- name: test_vg3
23+
disks: "{{ range(6, 10) | map('extract', unused_disks) | list }}"
24+
volumes:
25+
- name: lv5
26+
size: "30%"
27+
- name: lv6
28+
size: "25%"
29+
- name: lv7
30+
size: "10%"
31+
- name: lv8
32+
size: "10%"
33+
snapshot_test_set:
34+
name: snapset1
35+
volumes:
36+
- name: snapshot VG1 LV1
37+
vg: test_vg1
38+
lv: lv1
39+
percent_space_required: 20
40+
- name: snapshot VG2 LV3
41+
vg: test_vg2
42+
lv: lv3
43+
percent_space_required: 15
44+
- name: snapshot VG2 LV4
45+
vg: test_vg2
46+
lv: lv4
47+
percent_space_required: 15
48+
- name: snapshot VG3 LV7
49+
vg: test_vg3
50+
lv: lv7
51+
percent_space_required: 15
52+
tasks:
53+
- name: Load test variables
54+
include_vars:
55+
file: vars/rh_distros_vars.yml
56+
when: __snapshot_is_ostree is not defined
57+
58+
- name: Run the snapshot role to define __snapshot_snapm_available
59+
include_role:
60+
name: linux-system-roles.snapshot
61+
62+
- name: Test is only supported on platforms with snapm support
63+
debug:
64+
msg: >
65+
This test is only supported on platforms with snapm support.
66+
when:
67+
- not __snapshot_snapm_available | d(false)
68+
69+
- name: End test
70+
meta: end_play
71+
when:
72+
- not __snapshot_snapm_available | d(false)
73+
74+
- name: Run tests
75+
block:
76+
- name: Setup
77+
include_tasks: tasks/setup.yml
78+
79+
- name: Run the snapshot role to create snapshot set of LVs
80+
include_role:
81+
name: linux-system-roles.snapshot
82+
vars:
83+
snapshot_lvm_action: snapshot
84+
snapshot_lvm_bootable: true
85+
snapshot_lvm_set: "{{ snapshot_test_set }}"
86+
87+
- name: Assert changes for create snapset
88+
assert:
89+
that: snapshot_cmd["changed"]
90+
91+
- name: Run the snapshot role to verify the set of snapshots for the LVs
92+
include_role:
93+
name: linux-system-roles.snapshot
94+
vars:
95+
snapshot_lvm_action: check
96+
snapshot_lvm_set: "{{ snapshot_test_set }}"
97+
snapshot_lvm_verify_only: true
98+
99+
- name: Create snapset again for idempotence
100+
include_role:
101+
name: linux-system-roles.snapshot
102+
vars:
103+
snapshot_lvm_action: snapshot
104+
snapshot_lvm_set: "{{ snapshot_test_set }}"
105+
106+
- name: Assert no changes for create snapset
107+
assert:
108+
that: not snapshot_cmd["changed"]
109+
110+
- name: Run the snapshot role remove the set
111+
include_role:
112+
name: linux-system-roles.snapshot
113+
vars:
114+
snapshot_lvm_action: remove
115+
snapshot_lvm_set: "{{ snapshot_test_set }}"
116+
117+
- name: Assert changes for remove snapset
118+
assert:
119+
that: snapshot_cmd["changed"]
120+
121+
- name: Run the snapshot role to verify the set is removed
122+
include_role:
123+
name: linux-system-roles.snapshot
124+
vars:
125+
snapshot_lvm_action: remove
126+
snapshot_lvm_set: "{{ snapshot_test_set }}"
127+
snapshot_lvm_verify_only: true
128+
129+
- name: Remove again to check idempotence
130+
include_role:
131+
name: linux-system-roles.snapshot
132+
vars:
133+
snapshot_lvm_action: remove
134+
snapshot_lvm_set: "{{ snapshot_test_set }}"
135+
136+
- name: Assert no changes for remove snapset
137+
assert:
138+
that: not snapshot_cmd["changed"]
139+
always:
140+
- name: Cleanup
141+
include_tasks: tasks/cleanup.yml
142+
tags: tests::cleanup

0 commit comments

Comments
 (0)