-
Notifications
You must be signed in to change notification settings - Fork 909
/
vmdk.py
2404 lines (2084 loc) · 106 KB
/
vmdk.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
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright (c) 2013 VMware, Inc.
# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
"""
Volume driver for VMware vCenter managed datastores.
The volumes created by this driver are backed by VMDK (Virtual Machine
Disk) files stored in datastores. For ease of managing the VMDKs, the
driver creates a virtual machine for each of the volumes. This virtual
machine is never powered on and is often referred as the shadow VM.
"""
import math
import re
from oslo_config import cfg
from oslo_log import log as logging
from oslo_utils import excutils
from oslo_utils import units
from oslo_utils import uuidutils
from oslo_utils import versionutils
from oslo_vmware import api
from oslo_vmware import exceptions
from oslo_vmware import image_transfer
from oslo_vmware import pbm
from oslo_vmware import vim_util
from cinder.common import constants
from cinder import exception
from cinder.i18n import _
from cinder.image import image_utils
from cinder import interface
from cinder.volume import configuration
from cinder.volume import driver
from cinder.volume.drivers.vmware import datastore as hub
from cinder.volume.drivers.vmware import exceptions as vmdk_exceptions
from cinder.volume.drivers.vmware import volumeops
from cinder.volume import volume_types
from cinder.volume import volume_utils
LOG = logging.getLogger(__name__)
THIN_VMDK_TYPE = 'thin'
THICK_VMDK_TYPE = 'thick'
EAGER_ZEROED_THICK_VMDK_TYPE = 'eagerZeroedThick'
CREATE_PARAM_ADAPTER_TYPE = 'adapter_type'
CREATE_PARAM_DISK_LESS = 'disk_less'
CREATE_PARAM_BACKING_NAME = 'name'
CREATE_PARAM_DISK_SIZE = 'disk_size'
CREATE_PARAM_TEMP_BACKING = 'temp_backing'
TMP_IMAGES_DATASTORE_FOLDER_PATH = "cinder_temp/"
EXTRA_CONFIG_VOLUME_ID_KEY = "cinder.volume.id"
EXTENSION_KEY = 'org.openstack.storage'
EXTENSION_TYPE = 'volume'
vmdk_opts = [
cfg.StrOpt('vmware_host_ip',
help='IP address for connecting to VMware vCenter server.'),
cfg.PortOpt('vmware_host_port',
default=443,
help='Port number for connecting to VMware vCenter server.'),
cfg.StrOpt('vmware_host_username',
help='Username for authenticating with VMware vCenter '
'server.'),
cfg.StrOpt('vmware_host_password',
help='Password for authenticating with VMware vCenter '
'server.',
secret=True),
cfg.StrOpt('vmware_wsdl_location',
help='Optional VIM service WSDL Location '
'e.g http://<server>/vimService.wsdl. Optional over-ride '
'to default location for bug work-arounds.'),
cfg.IntOpt('vmware_api_retry_count',
default=10,
help='Number of times VMware vCenter server API must be '
'retried upon connection related issues.'),
cfg.FloatOpt('vmware_task_poll_interval',
default=2.0,
help='The interval (in seconds) for polling remote tasks '
'invoked on VMware vCenter server.'),
cfg.StrOpt('vmware_volume_folder',
default='Volumes',
help='Name of the vCenter inventory folder that will '
'contain Cinder volumes. This folder will be created '
'under "OpenStack/<project_folder>", where project_folder '
'is of format "Project (<volume_project_id>)".'),
cfg.IntOpt('vmware_image_transfer_timeout_secs',
default=7200,
help='Timeout in seconds for VMDK volume transfer between '
'Cinder and Glance.'),
cfg.IntOpt('vmware_max_objects_retrieval',
default=100,
help='Max number of objects to be retrieved per batch. '
'Query results will be obtained in batches from the '
'server and not in one shot. Server may still limit the '
'count to something less than the configured value.'),
cfg.StrOpt('vmware_host_version',
help='Optional string specifying the VMware vCenter server '
'version. '
'The driver attempts to retrieve the version from VMware '
'vCenter server. Set this configuration only if you want '
'to override the vCenter server version.'),
cfg.StrOpt('vmware_tmp_dir',
default='/tmp',
help='Directory where virtual disks are stored during volume '
'backup and restore.'),
cfg.StrOpt('vmware_ca_file',
help='CA bundle file to use in verifying the vCenter server '
'certificate.'),
cfg.BoolOpt('vmware_insecure',
default=False,
help='If true, the vCenter server certificate is not '
'verified. If false, then the default CA truststore is '
'used for verification. This option is ignored if '
'"vmware_ca_file" is set.'),
cfg.MultiStrOpt('vmware_cluster_name',
help='Name of a vCenter compute cluster where volumes '
'should be created.'),
cfg.MultiStrOpt('vmware_storage_profile',
help='Names of storage profiles to be monitored. Only '
'used when vmware_enable_volume_stats is True.'),
cfg.IntOpt('vmware_connection_pool_size',
default=10,
help='Maximum number of connections in http connection pool.'),
cfg.StrOpt('vmware_adapter_type',
choices=[volumeops.VirtualDiskAdapterType.LSI_LOGIC,
volumeops.VirtualDiskAdapterType.BUS_LOGIC,
volumeops.VirtualDiskAdapterType.LSI_LOGIC_SAS,
volumeops.VirtualDiskAdapterType.PARA_VIRTUAL,
volumeops.VirtualDiskAdapterType.IDE],
default=volumeops.VirtualDiskAdapterType.LSI_LOGIC,
help='Default adapter type to be used for attaching volumes.'),
cfg.StrOpt('vmware_snapshot_format',
choices=['template', 'COW'],
default='template',
help='Volume snapshot format in vCenter server.'),
cfg.BoolOpt('vmware_lazy_create',
default=True,
help='If true, the backend volume in vCenter server is created'
' lazily when the volume is created without any source. '
'The backend volume is created when the volume is '
'attached, uploaded to image service or during backup.'),
cfg.StrOpt('vmware_datastore_regex',
help='Regular expression pattern to match the name of '
'datastores where backend volumes are created.'),
cfg.BoolOpt('vmware_enable_volume_stats',
default=False,
help='If true, this enables the fetching of the volume stats '
'from the backend. This has potential performance '
'issues at scale. When False, the driver will not '
'collect ANY stats about the backend.')
]
CONF = cfg.CONF
CONF.register_opts(vmdk_opts, group=configuration.SHARED_CONF_GROUP)
def _get_volume_type_extra_spec(type_id, spec_key, possible_values=None,
default_value=None):
"""Get extra spec value.
If the spec value is not present in the input possible_values, then
default_value will be returned.
If the type_id is None, then default_value is returned.
The caller must not consider scope and the implementation adds/removes
scope. The scope used here is 'vmware' e.g. key 'vmware:vmdk_type' and
so the caller must pass vmdk_type as an input ignoring the scope.
:param type_id: Volume type ID
:param spec_key: Extra spec key
:param possible_values: Permitted values for the extra spec if known
:param default_value: Default value for the extra spec incase of an
invalid value or if the entry does not exist
:return: extra spec value
"""
if not type_id:
return default_value
spec_key = ('vmware:%s') % spec_key
spec_value = volume_types.get_volume_type_extra_specs(type_id).get(
spec_key, False)
if not spec_value:
LOG.debug("Returning default spec value: %s.", default_value)
return default_value
if possible_values is None:
return spec_value
if spec_value in possible_values:
LOG.debug("Returning spec value %s", spec_value)
return spec_value
LOG.debug("Invalid spec value: %s specified.", spec_value)
class ImageDiskType(object):
"""Supported disk types in images."""
PREALLOCATED = "preallocated"
SPARSE = "sparse"
STREAM_OPTIMIZED = "streamOptimized"
THIN = "thin"
@staticmethod
def is_valid(extra_spec_disk_type):
"""Check if the given disk type in extra_spec is valid.
:param extra_spec_disk_type: disk type to check
:return: True if valid
"""
return extra_spec_disk_type in [ImageDiskType.PREALLOCATED,
ImageDiskType.SPARSE,
ImageDiskType.STREAM_OPTIMIZED,
ImageDiskType.THIN]
@staticmethod
def validate(extra_spec_disk_type):
"""Validate the given disk type in extra_spec.
This method throws ImageUnacceptable if the disk type is not a
supported one.
:param extra_spec_disk_type: disk type
:raises: ImageUnacceptable
"""
if not ImageDiskType.is_valid(extra_spec_disk_type):
raise exception.ImageUnacceptable(_("Invalid disk type: %s.") %
extra_spec_disk_type)
@interface.volumedriver
class VMwareVcVmdkDriver(driver.VolumeDriver):
"""Manage volumes on VMware vCenter server."""
# 1.0 - initial version of driver
# 1.1.0 - selection of datastore based on number of host mounts
# 1.2.0 - storage profile volume types based placement of volumes
# 1.3.0 - support for volume backup/restore
# 1.4.0 - support for volume retype
# 1.5.0 - restrict volume placement to specific vCenter clusters
# 1.6.0 - support for manage existing
# 1.7.0 - new config option 'vmware_connection_pool_size'
# 1.7.1 - enforce vCenter server version 5.5
# 2.0.0 - performance enhancements
# - new config option 'vmware_adapter_type'
# - new extra-spec option 'vmware:adapter_type'
# 3.0.0 - vCenter storage profile ID caching
# support for cloning attached volume
# optimize volume creation from image for vCenter datastore based
# glance backend
# add 'managed by OpenStack Cinder' info to volumes in the backend
# support for vSphere template as volume snapshot format
# support for snapshot of attached volumes
# add storage profile ID to connection info
# support for revert-to-snapshot
# improve scalability of querying volumes in backend (bug 1600754)
# 3.1.0 - support adapter type change using retype
# 3.2.0 - config option to disable lazy creation of backend volume
# 3.3.0 - config option to specify datastore name regex
# 3.4.0 - added NFS41 as a supported datastore type
# 3.4.1 - volume capacity stats implemented
# 3.4.2 - deprecated option vmware_storage_profile
# 3.4.3 - un-deprecated option vmware_storage_profile and added new
# option vmware_enable_volume_stats to optionally enable
# real get_volume_stats for proper scheduling of this driver.
# 3.4.4 - Ensure datastores exist for storage profiles during
# get_volume_stats()
VERSION = '3.4.4'
# ThirdPartySystems wiki page
CI_WIKI_NAME = "VMware_CI"
# Minimum supported vCenter version.
MIN_SUPPORTED_VC_VERSION = '5.5'
NEXT_MIN_SUPPORTED_VC_VERSION = '5.5'
# PBM is enabled only for vCenter versions 5.5 and above
PBM_ENABLED_VC_VERSION = '5.5'
def __init__(self, *args, **kwargs):
super(VMwareVcVmdkDriver, self).__init__(*args, **kwargs)
self.configuration.append_config_values(vmdk_opts)
self._session = None
self._stats = None
self._volumeops = None
self._storage_policy_enabled = False
self._ds_sel = None
self._clusters = None
self._dc_cache = {}
self._ds_regex = None
@staticmethod
def get_driver_options():
return vmdk_opts
@property
def volumeops(self):
return self._volumeops
@property
def ds_sel(self):
return self._ds_sel
def _validate_params(self):
# Throw error if required parameters are not set.
required_params = ['vmware_host_ip',
'vmware_host_username',
'vmware_host_password']
for param in required_params:
if not getattr(self.configuration, param, None):
reason = _("%s not set.") % param
raise exception.InvalidInput(reason=reason)
def check_for_setup_error(self):
pass
def _update_volume_stats(self):
if self.configuration.safe_get('vmware_enable_volume_stats'):
self._stats = self._get_volume_stats()
else:
self._stats = self._get_fake_stats()
def _get_fake_stats(self):
"""Provide fake stats to the scheduler.
:param refresh: Whether to get refreshed information
"""
if not self._stats:
backend_name = self.configuration.safe_get('volume_backend_name')
if not backend_name:
backend_name = self.__class__.__name__
data = {'volume_backend_name': backend_name,
'vendor_name': 'VMware',
'driver_version': self.VERSION,
'storage_protocol': 'vmdk',
'reserved_percentage': 0,
'total_capacity_gb': 'unknown',
'free_capacity_gb': 'unknown',
'shared_targets': False}
self._stats = data
return self._stats
def _get_volume_stats(self):
"""Fetch the stats about the backend.
This can be slow at scale, but allows
properly provisioning scheduling.
"""
backend_name = self.configuration.safe_get('volume_backend_name')
if not backend_name:
backend_name = self.__class__.__name__
data = {'volume_backend_name': backend_name,
'vendor_name': 'VMware',
'driver_version': self.VERSION,
'storage_protocol': constants.VMDK,
'reserved_percentage': self.configuration.reserved_percentage,
'shared_targets': False}
ds_summaries = self._get_datastore_summaries()
available_hosts = self._get_hosts(self._clusters)
global_capacity = 0
global_free = 0
if ds_summaries:
while True:
for ds in ds_summaries.objects:
ds_props = self._get_object_properties(ds)
summary = ds_props['summary']
if self._is_datastore_accessible(summary,
ds_props['host'],
available_hosts):
global_capacity += summary.capacity
global_free += summary.freeSpace
if getattr(ds_summaries, 'token', None):
ds_summaries = self.volumeops.continue_retrieval(
ds_summaries)
else:
break
data['total_capacity_gb'] = round(global_capacity / units.Gi)
data['free_capacity_gb'] = round(global_free / units.Gi)
self._stats = data
return data
def _get_datastore_summaries(self):
client_factory = self.session.vim.client.factory
object_specs = []
if (self._storage_policy_enabled
and self.configuration.vmware_storage_profile):
# Get all available storage profiles on the vCenter and extract the
# IDs of those that we want to observe
profiles_ids = []
for profile in pbm.get_all_profiles(self.session):
if profile.name in self.configuration.vmware_storage_profile:
profiles_ids.append(profile.profileId)
# Get all matching Datastores for each profile
datastores = {}
for profile_id in profiles_ids:
for pbm_hub in pbm.filter_hubs_by_profile(self.session,
None,
profile_id):
if pbm_hub.hubType != "Datastore":
# We are not interested in Datastore Clusters for now
continue
if pbm_hub.hubId not in datastores:
# Reconstruct a managed object reference to datastore
datastores[pbm_hub.hubId] = vim_util.get_moref(
pbm_hub.hubId, "Datastore")
# Build property collector object specs out of them
for datastore_ref in datastores.values():
object_specs.append(
vim_util.build_object_spec(client_factory,
datastore_ref,
[]))
if not datastores:
LOG.warning("No Datastores found for storage profile(s) "
"''%s'",
', '.join(
self.configuration.safe_get(
'vmware_storage_profile')))
else:
# Build a catch-all object spec that would reach all datastores
object_specs.append(
vim_util.build_object_spec(
client_factory,
self.session.vim.service_content.rootFolder,
[vim_util.build_recursive_traversal_spec(client_factory)]))
# If there are no datastores, we won't have object_specs and will
# fail when trying to get stats
if not object_specs:
return
prop_spec = vim_util.build_property_spec(client_factory, 'Datastore',
['summary', 'host'])
filter_spec = vim_util.build_property_filter_spec(client_factory,
prop_spec,
object_specs)
options = client_factory.create('ns0:RetrieveOptions')
options.maxObjects = self.configuration.vmware_max_objects_retrieval
result = self.session.vim.RetrievePropertiesEx(
self.session.vim.service_content.propertyCollector,
specSet=[filter_spec],
options=options)
return result
def _get_object_properties(self, obj_content):
props = {}
if hasattr(obj_content, 'propSet'):
prop_set = obj_content.propSet
if prop_set:
props = {prop.name: prop.val for prop in prop_set}
return props
def _is_datastore_accessible(self, ds_summary, ds_host_mounts,
available_hosts):
# available_hosts empty => vmware_cluster_name not specified => don't
# filter by hosts
cluster_access_to_ds = not available_hosts
for host_mount in ds_host_mounts.DatastoreHostMount:
for avlbl_host in available_hosts:
avlbl_host_value = vim_util.get_moref_value(avlbl_host)
host_mount_key_value = vim_util.get_moref_value(host_mount.key)
if avlbl_host_value == host_mount_key_value:
cluster_access_to_ds = True
return (ds_summary.accessible
and not self.volumeops._in_maintenance(ds_summary)
and cluster_access_to_ds)
def _verify_volume_creation(self, volume):
"""Verify that the volume can be created.
Verify the vmdk type and storage profile if the volume is associated
with a volume type.
:param volume: Volume object
"""
# validate disk type
self._get_disk_type(volume)
# validate storage profile
profile_name = self._get_storage_profile(volume)
if profile_name:
self.ds_sel.get_profile_id(profile_name)
# validate adapter type
self._get_adapter_type(volume)
LOG.debug("Verified disk type, adapter type and storage profile "
"of volume: %s.", volume.name)
def create_volume(self, volume):
"""Creates a volume.
We do not create any backing. We do it only the first time
it is being attached to a virtual machine.
:param volume: Volume object
"""
if self.configuration.vmware_lazy_create:
self._verify_volume_creation(volume)
else:
self._create_backing(volume)
def _delete_volume(self, volume):
"""Delete the volume backing if it is present.
:param volume: Volume object
"""
backing = self.volumeops.get_backing(volume['name'], volume['id'])
if not backing:
LOG.info("Backing not available, no operation "
"to be performed.")
return
self.volumeops.delete_backing(backing)
def delete_volume(self, volume):
"""Deletes volume backing.
:param volume: Volume object
"""
self._delete_volume(volume)
def _get_extra_spec_adapter_type(self, type_id):
adapter_type = _get_volume_type_extra_spec(
type_id,
'adapter_type',
default_value=self.configuration.vmware_adapter_type)
volumeops.VirtualDiskAdapterType.validate(adapter_type)
return adapter_type
def _get_adapter_type(self, volume):
return self._get_extra_spec_adapter_type(volume['volume_type_id'])
def _get_extra_spec_storage_profile(self, type_id):
"""Get storage profile name in the given volume type's extra spec.
If there is no storage profile in the extra spec, default is None.
"""
return _get_volume_type_extra_spec(type_id, 'storage_profile')
def _get_storage_profile(self, volume):
"""Get storage profile associated with the given volume's volume_type.
:param volume: Volume whose storage profile should be queried
:return: String value of storage profile if volume type is associated
and contains storage_profile extra_spec option; None otherwise
"""
return self._get_extra_spec_storage_profile(volume['volume_type_id'])
@staticmethod
def _get_extra_spec_disk_type(type_id):
"""Get disk type from the given volume type's extra spec.
If there is no disk type option, default is THIN_VMDK_TYPE.
"""
disk_type = _get_volume_type_extra_spec(type_id,
'vmdk_type',
default_value=THIN_VMDK_TYPE)
volumeops.VirtualDiskType.validate(disk_type)
return disk_type
@staticmethod
def _get_disk_type(volume):
"""Get disk type from the given volume's volume type.
:param volume: Volume object
:return: Disk type
"""
return VMwareVcVmdkDriver._get_extra_spec_disk_type(
volume['volume_type_id'])
def _get_storage_profile_id(self, volume):
storage_profile = self._get_storage_profile(volume)
profile_id = None
if self._storage_policy_enabled and storage_profile:
profile = pbm.get_profile_id_by_name(self.session, storage_profile)
if profile:
profile_id = profile.uniqueId
return profile_id
def _get_extra_config(self, volume):
return {EXTRA_CONFIG_VOLUME_ID_KEY: volume['id'],
volumeops.BACKING_UUID_KEY: volume['id']}
def _create_backing(self, volume, host=None, create_params=None):
"""Create volume backing under the given host.
If host is unspecified, any suitable host is selected.
:param volume: Volume object
:param host: Reference of the host
:param create_params: Dictionary specifying optional parameters for
backing VM creation
:return: Reference to the created backing
"""
create_params = create_params or {}
(host_ref, resource_pool, folder,
summary) = self._select_ds_for_volume(volume, host)
# check if a storage profile needs to be associated with the backing VM
profile_id = self._get_storage_profile_id(volume)
# Use volume name as the default backing name.
backing_name = create_params.get(CREATE_PARAM_BACKING_NAME,
volume['name'])
extra_config = self._get_extra_config(volume)
# We shoudln't set backing UUID to volume UUID for temporary backing.
if create_params.get(CREATE_PARAM_TEMP_BACKING):
del extra_config[volumeops.BACKING_UUID_KEY]
# default is a backing with single disk
disk_less = create_params.get(CREATE_PARAM_DISK_LESS, False)
if disk_less:
# create a disk-less backing-- disk can be added later; for e.g.,
# by copying an image
return self.volumeops.create_backing_disk_less(
backing_name,
folder,
resource_pool,
host_ref,
summary.name,
profileId=profile_id,
extra_config=extra_config)
# create a backing with single disk
disk_type = VMwareVcVmdkDriver._get_disk_type(volume)
size_kb = volume['size'] * units.Mi
adapter_type = create_params.get(CREATE_PARAM_ADAPTER_TYPE,
self._get_adapter_type(volume))
backing = self.volumeops.create_backing(backing_name,
size_kb,
disk_type,
folder,
resource_pool,
host_ref,
summary.name,
profileId=profile_id,
adapter_type=adapter_type,
extra_config=extra_config)
self.volumeops.update_backing_disk_uuid(backing, volume['id'])
return backing
def _get_hosts(self, clusters):
hosts = []
if clusters:
for cluster in clusters:
cluster_hosts = self.volumeops.get_cluster_hosts(cluster)
hosts.extend(cluster_hosts)
return hosts
def _select_datastore(self, req, host=None):
"""Selects datastore satisfying the given requirements.
:return: (host, resource_pool, summary)
"""
hosts = None
if host:
hosts = [host]
elif self._clusters:
hosts = self._get_hosts(self._clusters)
if not hosts:
LOG.error("There are no valid hosts available in "
"configured cluster(s): %s.", self._clusters)
raise vmdk_exceptions.NoValidHostException()
best_candidate = self.ds_sel.select_datastore(req, hosts=hosts)
if not best_candidate:
LOG.error("There is no valid datastore satisfying "
"requirements: %s.", req)
raise vmdk_exceptions.NoValidDatastoreException()
return best_candidate
def _get_dc(self, resource_pool):
dc = self._dc_cache.get(vim_util.get_moref_value(resource_pool))
if not dc:
dc = self.volumeops.get_dc(resource_pool)
self._dc_cache[vim_util.get_moref_value(resource_pool)] = dc
return dc
def _select_ds_for_volume(self, volume, host=None, create_params=None):
"""Select datastore that can accommodate the given volume's backing.
Returns the selected datastore summary along with a compute host and
its resource pool and folder where the volume can be created
:return: (host, resource_pool, folder, summary)
"""
# Form requirements for datastore selection.
create_params = create_params or {}
size = create_params.get(CREATE_PARAM_DISK_SIZE, volume['size'])
req = {}
req[hub.DatastoreSelector.SIZE_BYTES] = size * units.Gi
req[hub.DatastoreSelector.PROFILE_NAME] = self._get_storage_profile(
volume)
(host_ref, resource_pool, summary) = self._select_datastore(req, host)
dc = self._get_dc(resource_pool)
folder = self._get_volume_group_folder(dc, volume['project_id'])
return (host_ref, resource_pool, folder, summary)
def _get_connection_info(self, volume, backing, connector):
connection_info = {'driver_volume_type': 'vmdk'}
connection_info['data'] = {
'volume': vim_util.get_moref_value(backing),
'volume_id': volume.id,
'name': volume.name,
'profile_id': self._get_storage_profile_id(volume)
}
# vmdk connector in os-brick needs additional connection info.
if 'platform' in connector and 'os_type' in connector:
connection_info['data']['vmdk_size'] = volume['size'] * units.Gi
vmdk_path = self.volumeops.get_vmdk_path(backing)
connection_info['data']['vmdk_path'] = vmdk_path
datastore = self.volumeops.get_datastore(backing)
connection_info['data']['datastore'] = \
vim_util.get_moref_value(datastore)
datacenter = self.volumeops.get_dc(backing)
connection_info['data']['datacenter'] = \
vim_util.get_moref_value(datacenter)
config = self.configuration
vmdk_connector_config = {
'vmware_host_ip': config.vmware_host_ip,
'vmware_host_port': config.vmware_host_port,
'vmware_host_username': config.vmware_host_username,
'vmware_host_password': config.vmware_host_password,
'vmware_api_retry_count': config.vmware_api_retry_count,
'vmware_task_poll_interval': config.vmware_task_poll_interval,
'vmware_ca_file': config.vmware_ca_file,
'vmware_insecure': config.vmware_insecure,
'vmware_tmp_dir': config.vmware_tmp_dir,
'vmware_image_transfer_timeout_secs':
config.vmware_image_transfer_timeout_secs,
}
connection_info['data']['config'] = vmdk_connector_config
LOG.debug("Returning connection_info (volume: '%(volume)s', volume_id:"
" '%(volume_id)s'), profile_id: '%(profile_id)s' for "
"connector: %(connector)s.",
{'volume': connection_info['data']['volume'],
'volume_id': volume.id,
'profile_id': connection_info['data']['profile_id'],
'connector': connector})
return connection_info
def _initialize_connection(self, volume, connector):
"""Get information of volume's backing.
If the volume does not have a backing yet. It will be created.
:param volume: Volume object
:param connector: Connector information
:return: Return connection information
"""
backing = self.volumeops.get_backing(volume.name, volume.id)
if 'instance' in connector:
# The instance exists
instance = vim_util.get_moref(connector['instance'],
'VirtualMachine')
LOG.debug("The instance: %s for which initialize connection "
"is called, exists.", instance)
# Get host managing the instance
host = self.volumeops.get_host(instance)
if not backing:
# Create a backing in case it does not exist under the
# host managing the instance.
LOG.info("There is no backing for the volume: %s. "
"Need to create one.", volume.name)
backing = self._create_backing(volume, host)
else:
# Relocate volume is necessary
self._relocate_backing(volume, backing, host)
else:
# The instance does not exist
LOG.debug("The instance for which initialize connection "
"is called, does not exist.")
if not backing:
# Create a backing in case it does not exist. It is a bad use
# case to boot from an empty volume.
LOG.warning("Trying to boot from an empty volume: %s.",
volume.name)
# Create backing
backing = self._create_backing(volume)
return self._get_connection_info(volume, backing, connector)
def initialize_connection(self, volume, connector):
"""Allow connection to connector and return connection info.
The implementation returns the following information:
.. code-block:: default
{
'driver_volume_type': 'vmdk',
'data': {'volume': $VOLUME_MOREF_VALUE,
'volume_id': $VOLUME_ID
}
}
:param volume: Volume object
:param connector: Connector information
:return: Return connection information
"""
return self._initialize_connection(volume, connector)
def terminate_connection(self, volume, connector, force=False, **kwargs):
pass
def create_export(self, context, volume, connector):
pass
def ensure_export(self, context, volume):
pass
def remove_export(self, context, volume):
pass
def _get_snapshot_group_folder(self, volume, backing):
dc = self.volumeops.get_dc(backing)
return self._get_volume_group_folder(
dc, volume.project_id, snapshot=True)
def _create_snapshot_template_format(self, snapshot, backing):
volume = snapshot.volume
folder = self._get_snapshot_group_folder(volume, backing)
datastore = self.volumeops.get_datastore(backing)
if self._in_use(volume):
tmp_backing = self._create_temp_backing_from_attached_vmdk(
volume, None, None, folder, datastore, tmp_name=snapshot.name)
else:
tmp_backing = self.volumeops.clone_backing(
snapshot.name, backing, None, volumeops.FULL_CLONE_TYPE,
datastore, folder=folder)
try:
self.volumeops.mark_backing_as_template(tmp_backing)
except exceptions.VimException:
with excutils.save_and_reraise_exception():
LOG.error("Error marking temporary backing as template.")
self._delete_temp_backing(tmp_backing)
return {'provider_location':
self.volumeops.get_inventory_path(tmp_backing)}
def _create_snapshot(self, snapshot):
"""Creates a snapshot.
If the volume does not have a backing then simply pass, else create
a snapshot.
Snapshot of only available volume is supported.
:param snapshot: Snapshot object
"""
volume = snapshot['volume']
snapshot_format = self.configuration.vmware_snapshot_format
if self._in_use(volume) and snapshot_format == 'COW':
msg = _("Snapshot of volume not supported in "
"state: %s.") % volume['status']
LOG.error(msg)
raise exception.InvalidVolume(msg)
backing = self.volumeops.get_backing(snapshot['volume_name'],
volume['id'])
if not backing:
LOG.info("There is no backing, so will not create "
"snapshot: %s.", snapshot['name'])
return
model_update = None
if snapshot_format == 'COW':
self.volumeops.create_snapshot(backing, snapshot['name'],
snapshot['display_description'])
else:
model_update = self._create_snapshot_template_format(
snapshot, backing)
LOG.info("Successfully created snapshot: %s.", snapshot['name'])
return model_update
def create_snapshot(self, snapshot):
"""Creates a snapshot.
:param snapshot: Snapshot object
"""
return self._create_snapshot(snapshot)
def _get_template_by_inv_path(self, inv_path):
template = self.volumeops.get_entity_by_inventory_path(inv_path)
if template is None:
LOG.error("Template not found at path: %s.", inv_path)
raise vmdk_exceptions.TemplateNotFoundException(path=inv_path)
else:
return template
def _delete_snapshot_template_format(self, snapshot):
template = self._get_template_by_inv_path(snapshot.provider_location)
self.volumeops.delete_backing(template)
def _delete_snapshot(self, snapshot):
"""Delete snapshot.
If the volume does not have a backing or the snapshot does not exist
then simply pass, else delete the snapshot. The volume must not be
attached for deletion of snapshot in COW format.
:param snapshot: Snapshot object
"""
inv_path = snapshot.provider_location
is_template = inv_path is not None
backing = self.volumeops.get_backing(snapshot.volume_name,
snapshot.volume.id)
if not backing:
LOG.debug("Backing does not exist for volume.",
resource=snapshot.volume)
elif (not is_template and
not self.volumeops.get_snapshot(backing, snapshot.name)):
LOG.debug("Snapshot does not exist in backend.", resource=snapshot)
elif self._in_use(snapshot.volume) and not is_template:
msg = _("Delete snapshot of volume not supported in "
"state: %s.") % snapshot.volume.status
LOG.error(msg)
raise exception.InvalidSnapshot(reason=msg)
else:
if is_template:
self._delete_snapshot_template_format(snapshot)
else:
self.volumeops.delete_snapshot(backing, snapshot.name)
def delete_snapshot(self, snapshot):
"""Delete snapshot.
:param snapshot: Snapshot object
"""
self._delete_snapshot(snapshot)
def _get_ds_name_folder_path(self, backing):
"""Get datastore name and folder path of the given backing.
:param backing: Reference to the backing entity
:return: datastore name and folder path of the backing
"""
vmdk_ds_file_path = self.volumeops.get_path_name(backing)
(datastore_name,
folder_path, _) = volumeops.split_datastore_path(vmdk_ds_file_path)
return (datastore_name, folder_path)
@staticmethod
def _validate_disk_format(disk_format):
"""Verify vmdk as disk format.
:param disk_format: Disk format of the image
"""
if disk_format and disk_format.lower() != 'vmdk':
msg = _("Cannot create image of disk format: %s. Only vmdk "
"disk format is accepted.") % disk_format
LOG.error(msg)
raise exception.ImageUnacceptable(msg)
def _copy_image(self, context, dc_ref, image_service, image_id,
image_size_in_bytes, ds_name, upload_file_path):
"""Copy image (flat extent or sparse vmdk) to datastore."""
timeout = self.configuration.vmware_image_transfer_timeout_secs
host_ip = self.configuration.vmware_host_ip
port = self.configuration.vmware_host_port
ca_file = self.configuration.vmware_ca_file
insecure = self.configuration.vmware_insecure
cookies = self.session.vim.client.cookiejar
dc_name = self.volumeops.get_entity_name(dc_ref)