-
Notifications
You must be signed in to change notification settings - Fork 2
/
volume_cloudinit.py
345 lines (287 loc) · 10.7 KB
/
volume_cloudinit.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
#!/usr/bin/python
# -*- coding: utf-8 -*-
# vim:set fileformat=unix shiftwidth=4 softtabstop=4 expandtab:
# kate: end-of-line unix; space-indent on; indent-width 4; remove-trailing-spaces modified;
# Copyright: (c) 2020, Jakob Meng <jakobmeng@web.de>
# Based on community.libvirt.virt_pool module written by Maciej Delmanowski <drybjed@gmail.com>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import absolute_import, division, print_function
__metaclass__ = type
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'supported_by': 'community'}
DOCUMENTATION = r'''
---
module: volume_cloudinit
short_description: Create cloud-init config drives as new volumes in libvirt storage pools.
description:
- "This module allows one to create cloud-init config drives with Meta-Data, User-Data and Network Configuration as
new volumes in libvirt storage pools. It is inspired by Ansible module openstack.cloud.os_volume."
requirements:
- cloud-localds (e.g. in debian package cloud-image-utils)
- virsh (e.g. in debian package libvirt-clients)
options:
pool:
description:
- "Name or UUID of the storage pool to create the config drive volume in."
required: true
type: str
name:
description:
- "Name of the config drive volume."
required: true
type: str
format:
default: raw
description:
- "Disk image format (see manpage of qemu-img for allowed image file formats), defaulting to raw."
required: false
type: str
filesystem:
default: iso
description:
- "Filesystem format (vfat or iso), defaulting to iso9660."
required: false
type: str
metadata:
description:
- "cloud-init Meta-Data."
required: false
type: str
userdata:
description:
- "cloud-init User-Data. Required if C(state) is C(present)."
type: str
networkconfig:
description:
- "cloud-init Network Configuration."
required: false
type: str
state:
choices: [present, absent]
default: present
description:
- "Should the config drive be present or absent."
type: str
notes:
- "No modifications are applied to existing config drive volumes; module is skipped if volume exists already."
extends_documentation_fragment:
- jm1.libvirt.libvirt
author: "Jakob Meng (@jm1)"
'''
EXAMPLES = r'''
- jm1.libvirt.volume_cloudinit:
pool: 'default'
name: 'cloud-init_config-drive.qcow2'
userdata: |
#cloud-config
# user-data configuration file for cloud-init
# Ref.: https://cloudinit.readthedocs.io/
hostname: inf.h-brs.de
'''
RETURN = r'''
'''
# NOTE: Synchronize imports with DOCUMENTATION string above and chapter Requirements in roles/server/README.md
from ansible_collections.jm1.libvirt.plugins.module_utils import libvirt as libvirt_utils
from ansible.module_utils._text import to_native
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
import ansible.module_utils.six as six
import os
import traceback
if six.PY2:
try:
from backports import tempfile
except ImportError:
BACKPORTS_TEMPFILE_IMPORT_ERROR = traceback.format_exc()
HAS_BACKPORTS_TEMPFILE = False
else:
BACKPORTS_TEMPFILE_IMPORT_ERROR = None
HAS_BACKPORTS_TEMPFILE = True
elif six.PY3:
import tempfile
def cloud_localds(volume_format,
volume_filesystem,
ci_metadata_path,
ci_userdata_path,
ci_networkconfig_path,
configdrive_path,
module):
# TODO: Reimplement cloud-localds in Python and drop dependency on cloud-localds,
# because it is not available on Red Hat Enterprise Linux 8 / 9 and CentOS 8 / 9.
# Ref.: https://salsa.debian.org/cloud-team/cloud-utils/-/blob/master/bin/cloud-localds
cmd = 'cloud-localds'
if volume_format:
cmd += ' --disk-format "%s"' % volume_format
if volume_filesystem:
cmd += ' --filesystem "%s"' % volume_filesystem
if ci_networkconfig_path:
cmd += ' --network-config "%s"' % ci_networkconfig_path
cmd += ' %s' % configdrive_path
cmd += ' %s' % ci_userdata_path
if ci_metadata_path:
cmd += ' %s' % ci_metadata_path
module.run_command(cmd, check_rc=True)
def create(uri,
pool_name,
volume_name,
volume_format,
volume_filesystem,
ci_metadata,
ci_userdata,
ci_networkconfig,
module):
with libvirt_utils.Connection(uri, module) as conn:
pool = conn.storagePoolLookupByName(pool_name)
if volume_name in pool.listVolumes():
# volume exists already
return False
with tempfile.TemporaryDirectory() as dir:
ci_metadata_path = os.path.join(dir, 'meta-data')
ci_userdata_path = os.path.join(dir, 'user-data')
ci_networkconfig_path = os.path.join(dir, 'network-config')
if ci_metadata:
with open(ci_metadata_path, 'w') as f:
f.write(ci_metadata)
if ci_userdata:
with open(ci_userdata_path, 'w') as f:
f.write(ci_userdata)
if ci_networkconfig:
with open(ci_networkconfig_path, 'w') as f:
f.write(ci_networkconfig)
# Create cloud-init config drive image
configdrive_path = os.path.join(dir, 'cloud-init_config-drive.img')
cloud_localds(
volume_format,
volume_filesystem,
ci_metadata_path if ci_metadata else None,
ci_userdata_path,
ci_networkconfig_path if ci_networkconfig else None,
configdrive_path,
module)
configdrive_size = os.path.getsize(configdrive_path)
# Create cloud-init config volume
cmd = """
virsh
--connect '{uri}'
vol-create-as
'{pool_name}'
'{volume_name}'
'{configdrive_size}'
--format '{volume_format}'
""".replace('\n', ' ').format(uri=uri,
pool_name=pool_name,
volume_name=volume_name,
configdrive_size=configdrive_size,
volume_format=volume_format)
module.run_command(cmd, check_rc=True)
# Upload cloud-init config drive to libvirt storage volume
cmd = """
virsh
--connect '{uri}'
vol-upload
--pool '{pool_name}'
'{volume_name}'
'{configdrive_path}'
""".replace('\n', ' ').format(uri=uri,
pool_name=pool_name,
volume_name=volume_name,
configdrive_path=configdrive_path)
module.run_command(cmd, check_rc=True)
return True
def delete(uri,
pool_name,
volume_name,
volume_format,
volume_filesystem,
ci_metadata,
ci_userdata,
ci_networkconfig,
module):
with libvirt_utils.Connection(uri, module) as conn:
pools = conn.listAllStoragePools()
pool = next((pool for pool in pools if pool.name() == pool_name), None)
if not pool:
# pool absent already and hence volume as well
return False
if volume_name not in pool.listVolumes():
# volume absent already
return False
volume = pool.storageVolLookupByName(volume_name)
volume.delete()
return True
def core(module):
state = module.params['state']
uri = module.params['uri']
pool_name = module.params['pool']
volume_name = module.params['name']
volume_format = module.params['format']
volume_filesystem = module.params['filesystem']
ci_metadata = module.params['metadata']
ci_userdata = module.params['userdata']
ci_networkconfig = module.params['networkconfig']
if module.check_mode:
return dict(
changed=False,
state=state,
uri=uri,
pool=pool_name,
name=volume_name,
format=volume_format,
filesystem=volume_filesystem,
metadata=ci_metadata,
userdata=ci_userdata,
networkconfig=ci_networkconfig)
if state == 'present':
changed = create(
uri,
pool_name,
volume_name, volume_format, volume_filesystem,
ci_metadata, ci_userdata, ci_networkconfig,
module)
elif state == 'absent':
changed = delete(
uri,
pool_name,
volume_name, volume_format, volume_filesystem,
ci_metadata, ci_userdata, ci_networkconfig,
module)
return dict(
changed=changed,
state=state,
uri=uri,
pool=pool_name,
name=volume_name,
format=volume_format,
filesystem=volume_filesystem,
metadata=ci_metadata,
userdata=ci_userdata,
networkconfig=ci_networkconfig)
def main():
module = AnsibleModule(
argument_spec=dict(
state=dict(type='str', choices=['present', 'absent'], default='present'),
uri=dict(default='qemu:///system'),
pool=dict(required=True, type='str'),
name=dict(required=True, type='str'),
format=dict(type='str', default='raw'),
filesystem=dict(type='str', choices=['vfat', 'iso'], default='iso'),
metadata=dict(type='str'),
userdata=dict(type='str'),
networkconfig=dict(type='str')
),
supports_check_mode=True,
required_if=[
['state', 'present', ['userdata']]
]
)
libvirt_utils.try_import(module)
if six.PY2 and not HAS_BACKPORTS_TEMPFILE:
module.fail_json(msg=missing_required_lib("backports.tempfile"), exception=BACKPORTS_TEMPFILE_IMPORT_ERROR)
try:
result = core(module)
except Exception as e:
module.fail_json(msg=to_native(e), exception=traceback.format_exc())
else:
module.exit_json(**result)
if __name__ == '__main__':
main()