523 lines
20 KiB
Python
523 lines
20 KiB
Python
# Copyright (c) 2015 EMC Corporation.
|
|
# 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.
|
|
|
|
import ast
|
|
|
|
from oslo_log import log as logging
|
|
import six
|
|
|
|
from cinder.i18n import _LW
|
|
from cinder import interface
|
|
from cinder.volume import driver
|
|
from cinder.volume.drivers.emc import emc_vmax_common
|
|
from cinder.zonemanager import utils as fczm_utils
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
@interface.volumedriver
|
|
class EMCVMAXFCDriver(driver.FibreChannelDriver):
|
|
"""EMC FC Drivers for VMAX using SMI-S.
|
|
|
|
Version history:
|
|
|
|
.. code-block:: none
|
|
|
|
1.0.0 - Initial driver
|
|
1.1.0 - Multiple pools and thick/thin provisioning,
|
|
performance enhancement.
|
|
2.0.0 - Add driver requirement functions
|
|
2.1.0 - Add consistency group functions
|
|
2.1.1 - Fixed issue with mismatched config (bug #1442376)
|
|
2.1.2 - Clean up failed clones (bug #1440154)
|
|
2.1.3 - Fixed a problem with FAST support (bug #1435069)
|
|
2.2.0 - Add manage/unmanage
|
|
2.2.1 - Support for SE 8.0.3
|
|
2.2.2 - Update Consistency Group
|
|
2.2.3 - Pool aware scheduler(multi-pool) support
|
|
2.2.4 - Create CG from CG snapshot
|
|
2.3.0 - Name change for MV and SG for FAST (bug #1515181)
|
|
- Fix for randomly choosing port group. (bug #1501919)
|
|
- get_short_host_name needs to be called in find_device_number
|
|
(bug #1520635)
|
|
- Proper error handling for invalid SLOs (bug #1512795)
|
|
- Extend Volume for VMAX3, SE8.1.0.3
|
|
https://blueprints.launchpad.net/cinder/+spec/vmax3-extend-volume
|
|
- Incorrect SG selected on an attach (#1515176)
|
|
- Cleanup Zoning (bug #1501938) NOTE: FC only
|
|
- Last volume in SG fix
|
|
- _remove_last_vol_and_delete_sg is not being called
|
|
for VMAX3 (bug #1520549)
|
|
- necessary updates for CG changes (#1534616)
|
|
- Changing PercentSynced to CopyState (bug #1517103)
|
|
- Getting iscsi ip from port in existing masking view
|
|
- Replacement of EMCGetTargetEndpoints api (bug #1512791)
|
|
- VMAX3 snapvx improvements (bug #1522821)
|
|
- Operations and timeout issues (bug #1538214)
|
|
2.4.0 - EMC VMAX - locking SG for concurrent threads (bug #1554634)
|
|
- SnapVX licensing checks for VMAX3 (bug #1587017)
|
|
- VMAX oversubscription Support (blueprint vmax-oversubscription)
|
|
- QoS support (blueprint vmax-qos)
|
|
2.5.0 - Attach and detach snapshot (blueprint vmax-attach-snapshot)
|
|
|
|
"""
|
|
|
|
VERSION = "2.5.0"
|
|
|
|
# ThirdPartySystems wiki
|
|
CI_WIKI_NAME = "EMC_VMAX_CI"
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
|
|
super(EMCVMAXFCDriver, self).__init__(*args, **kwargs)
|
|
self.common = emc_vmax_common.EMCVMAXCommon(
|
|
'FC',
|
|
self.VERSION,
|
|
configuration=self.configuration)
|
|
self.zonemanager_lookup_service = fczm_utils.create_lookup_service()
|
|
|
|
def check_for_setup_error(self):
|
|
pass
|
|
|
|
def create_volume(self, volume):
|
|
"""Creates a EMC(VMAX/VNX) volume."""
|
|
volpath = self.common.create_volume(volume)
|
|
|
|
model_update = {}
|
|
volume['provider_location'] = six.text_type(volpath)
|
|
model_update['provider_location'] = volume['provider_location']
|
|
return model_update
|
|
|
|
def create_volume_from_snapshot(self, volume, snapshot):
|
|
"""Creates a volume from a snapshot."""
|
|
volpath = self.common.create_volume_from_snapshot(volume, snapshot)
|
|
|
|
model_update = {}
|
|
volume['provider_location'] = six.text_type(volpath)
|
|
model_update['provider_location'] = volume['provider_location']
|
|
return model_update
|
|
|
|
def create_cloned_volume(self, volume, src_vref):
|
|
"""Creates a cloned volume."""
|
|
volpath = self.common.create_cloned_volume(volume, src_vref)
|
|
|
|
model_update = {}
|
|
volume['provider_location'] = six.text_type(volpath)
|
|
model_update['provider_location'] = volume['provider_location']
|
|
return model_update
|
|
|
|
def delete_volume(self, volume):
|
|
"""Deletes an EMC volume."""
|
|
self.common.delete_volume(volume)
|
|
|
|
def create_snapshot(self, snapshot):
|
|
"""Creates a snapshot."""
|
|
src_volume = snapshot['volume']
|
|
volpath = self.common.create_snapshot(snapshot, src_volume)
|
|
|
|
model_update = {}
|
|
snapshot['provider_location'] = six.text_type(volpath)
|
|
model_update['provider_location'] = snapshot['provider_location']
|
|
return model_update
|
|
|
|
def delete_snapshot(self, snapshot):
|
|
"""Deletes a snapshot."""
|
|
src_volume = snapshot['volume']
|
|
|
|
self.common.delete_snapshot(snapshot, src_volume)
|
|
|
|
def ensure_export(self, context, volume):
|
|
"""Driver entry point to get the export info for an existing volume."""
|
|
pass
|
|
|
|
def create_export(self, context, volume, connector):
|
|
"""Driver entry point to get the export info for a new volume."""
|
|
pass
|
|
|
|
def remove_export(self, context, volume):
|
|
"""Driver entry point to remove an export for a volume."""
|
|
pass
|
|
|
|
def check_for_export(self, context, volume_id):
|
|
"""Make sure volume is exported."""
|
|
pass
|
|
|
|
@fczm_utils.AddFCZone
|
|
def initialize_connection(self, volume, connector):
|
|
"""Initializes the connection and returns connection info.
|
|
|
|
Assign any created volume to a compute node/host so that it can be
|
|
used from that host.
|
|
|
|
The driver returns a driver_volume_type of 'fibre_channel'.
|
|
The target_wwn can be a single entry or a list of wwns that
|
|
correspond to the list of remote wwn(s) that will export the volume.
|
|
Example return values:
|
|
{
|
|
'driver_volume_type': 'fibre_channel'
|
|
'data': {
|
|
'target_discovered': True,
|
|
'target_lun': 1,
|
|
'target_wwn': '1234567890123',
|
|
}
|
|
}
|
|
|
|
or
|
|
|
|
{
|
|
'driver_volume_type': 'fibre_channel'
|
|
'data': {
|
|
'target_discovered': True,
|
|
'target_lun': 1,
|
|
'target_wwn': ['1234567890123', '0987654321321'],
|
|
}
|
|
}
|
|
"""
|
|
device_info = self.common.initialize_connection(
|
|
volume, connector)
|
|
return self.populate_data(device_info, volume, connector)
|
|
|
|
def populate_data(self, device_info, volume, connector):
|
|
"""Populate data dict.
|
|
|
|
Add relevant data to data dict, target_lun, target_wwn and
|
|
initiator_target_map.
|
|
|
|
:param device_info: device_info
|
|
:param volume: the volume object
|
|
:param connector: the connector object
|
|
:returns: dict -- the target_wwns and initiator_target_map
|
|
"""
|
|
device_number = device_info['hostlunid']
|
|
storage_system = device_info['storagesystem']
|
|
target_wwns, init_targ_map = self._build_initiator_target_map(
|
|
storage_system, volume, connector)
|
|
|
|
data = {'driver_volume_type': 'fibre_channel',
|
|
'data': {'target_lun': device_number,
|
|
'target_discovered': True,
|
|
'target_wwn': target_wwns,
|
|
'initiator_target_map': init_targ_map}}
|
|
|
|
LOG.debug("Return FC data for zone addition: %(data)s.",
|
|
{'data': data})
|
|
|
|
return data
|
|
|
|
@fczm_utils.RemoveFCZone
|
|
def terminate_connection(self, volume, connector, **kwargs):
|
|
"""Disallow connection from connector.
|
|
|
|
Return empty data if other volumes are in the same zone.
|
|
The FibreChannel ZoneManager doesn't remove zones
|
|
if there isn't an initiator_target_map in the
|
|
return of terminate_connection.
|
|
|
|
:param volume: the volume object
|
|
:param connector: the connector object
|
|
:returns: dict -- the target_wwns and initiator_target_map if the
|
|
zone is to be removed, otherwise empty
|
|
"""
|
|
data = {'driver_volume_type': 'fibre_channel',
|
|
'data': {}}
|
|
zoning_mappings = (
|
|
self._get_zoning_mappings(volume, connector))
|
|
|
|
if zoning_mappings:
|
|
self.common.terminate_connection(volume, connector)
|
|
data = self._cleanup_zones(zoning_mappings)
|
|
return data
|
|
|
|
def _get_zoning_mappings(self, volume, connector):
|
|
"""Get zoning mappings by building up initiator/target map.
|
|
|
|
:param volume: the volume object
|
|
:param connector: the connector object
|
|
:returns: dict -- the target_wwns and initiator_target_map if the
|
|
zone is to be removed, otherwise empty
|
|
"""
|
|
zoning_mappings = {'port_group': None,
|
|
'initiator_group': None,
|
|
'target_wwns': None,
|
|
'init_targ_map': None}
|
|
loc = volume['provider_location']
|
|
name = ast.literal_eval(loc)
|
|
storage_system = name['keybindings']['SystemName']
|
|
LOG.debug("Start FC detach process for volume: %(volume)s.",
|
|
{'volume': volume['name']})
|
|
|
|
mvInstanceName = self.common.get_masking_view_by_volume(
|
|
volume, connector)
|
|
if mvInstanceName:
|
|
portGroupInstanceName = (
|
|
self.common.get_port_group_from_masking_view(
|
|
mvInstanceName))
|
|
initiatorGroupInstanceName = (
|
|
self.common.get_initiator_group_from_masking_view(
|
|
mvInstanceName))
|
|
|
|
LOG.debug("Found port group: %(portGroup)s "
|
|
"in masking view %(maskingView)s.",
|
|
{'portGroup': portGroupInstanceName,
|
|
'maskingView': mvInstanceName})
|
|
# Map must be populated before the terminate_connection
|
|
target_wwns, init_targ_map = self._build_initiator_target_map(
|
|
storage_system, volume, connector)
|
|
zoning_mappings = {'port_group': portGroupInstanceName,
|
|
'initiator_group': initiatorGroupInstanceName,
|
|
'target_wwns': target_wwns,
|
|
'init_targ_map': init_targ_map}
|
|
else:
|
|
LOG.warning(_LW("Volume %(volume)s is not in any masking view."),
|
|
{'volume': volume['name']})
|
|
return zoning_mappings
|
|
|
|
def _cleanup_zones(self, zoning_mappings):
|
|
"""Cleanup zones after terminate connection.
|
|
|
|
:param zoning_mappings: zoning mapping dict
|
|
:returns: data - dict
|
|
"""
|
|
LOG.debug("Looking for masking views still associated with "
|
|
"Port Group %s.", zoning_mappings['port_group'])
|
|
if zoning_mappings['initiator_group']:
|
|
checkIgInstanceName = (
|
|
self.common.check_ig_instance_name(
|
|
zoning_mappings['initiator_group']))
|
|
else:
|
|
checkIgInstanceName = None
|
|
|
|
# if it has not been deleted, check for remaining masking views
|
|
if checkIgInstanceName:
|
|
mvInstances = self._get_common_masking_views(
|
|
zoning_mappings['port_group'],
|
|
zoning_mappings['initiator_group'])
|
|
|
|
if len(mvInstances) > 0:
|
|
LOG.debug("Found %(numViews)lu MaskingViews.",
|
|
{'numViews': len(mvInstances)})
|
|
data = {'driver_volume_type': 'fibre_channel',
|
|
'data': {}}
|
|
else: # no masking views found
|
|
LOG.debug("No MaskingViews were found. Deleting zone.")
|
|
data = {'driver_volume_type': 'fibre_channel',
|
|
'data': {'target_wwn': zoning_mappings['target_wwns'],
|
|
'initiator_target_map':
|
|
zoning_mappings['init_targ_map']}}
|
|
|
|
LOG.debug("Return FC data for zone removal: %(data)s.",
|
|
{'data': data})
|
|
|
|
else: # The initiator group has been deleted
|
|
LOG.debug("Initiator Group has been deleted. Deleting zone.")
|
|
data = {'driver_volume_type': 'fibre_channel',
|
|
'data': {'target_wwn': zoning_mappings['target_wwns'],
|
|
'initiator_target_map':
|
|
zoning_mappings['init_targ_map']}}
|
|
|
|
LOG.debug("Return FC data for zone removal: %(data)s.",
|
|
{'data': data})
|
|
return data
|
|
|
|
def _get_common_masking_views(
|
|
self, portGroupInstanceName, initiatorGroupInstanceName):
|
|
"""Check to see the existence of mv in list"""
|
|
mvInstances = []
|
|
mvInstancesByPG = self.common.get_masking_views_by_port_group(
|
|
portGroupInstanceName)
|
|
|
|
mvInstancesByIG = self.common.get_masking_views_by_initiator_group(
|
|
initiatorGroupInstanceName)
|
|
|
|
for mvInstanceByPG in mvInstancesByPG:
|
|
if mvInstanceByPG in mvInstancesByIG:
|
|
mvInstances.append(mvInstanceByPG)
|
|
return mvInstances
|
|
|
|
def _build_initiator_target_map(self, storage_system, volume, connector):
|
|
"""Build the target_wwns and the initiator target map."""
|
|
target_wwns = []
|
|
init_targ_map = {}
|
|
initiator_wwns = connector['wwpns']
|
|
|
|
if self.zonemanager_lookup_service:
|
|
fc_targets = self.common.get_target_wwns_from_masking_view(
|
|
storage_system, volume, connector)
|
|
mapping = (
|
|
self.zonemanager_lookup_service.
|
|
get_device_mapping_from_network(initiator_wwns, fc_targets))
|
|
for entry in mapping:
|
|
map_d = mapping[entry]
|
|
target_wwns.extend(map_d['target_port_wwn_list'])
|
|
for initiator in map_d['initiator_port_wwn_list']:
|
|
init_targ_map[initiator] = map_d['target_port_wwn_list']
|
|
else: # No lookup service, pre-zoned case.
|
|
target_wwns = self.common.get_target_wwns(storage_system,
|
|
connector)
|
|
for initiator in initiator_wwns:
|
|
init_targ_map[initiator] = target_wwns
|
|
|
|
return list(set(target_wwns)), init_targ_map
|
|
|
|
def extend_volume(self, volume, new_size):
|
|
"""Extend an existing volume."""
|
|
self.common.extend_volume(volume, new_size)
|
|
|
|
def get_volume_stats(self, refresh=False):
|
|
"""Get volume stats.
|
|
|
|
:param refresh: boolean -- If True, run update the stats first.
|
|
:returns: dict -- the stats dict
|
|
"""
|
|
if refresh:
|
|
self.update_volume_stats()
|
|
|
|
return self._stats
|
|
|
|
def update_volume_stats(self):
|
|
"""Retrieve stats info from volume group."""
|
|
LOG.debug("Updating volume stats")
|
|
data = self.common.update_volume_stats()
|
|
data['storage_protocol'] = 'FC'
|
|
data['driver_version'] = self.VERSION
|
|
self._stats = data
|
|
|
|
def migrate_volume(self, ctxt, volume, host):
|
|
"""Migrate a volume from one Volume Backend to another.
|
|
|
|
:param ctxt: context
|
|
:param volume: the volume object including the volume_type_id
|
|
:param host: the host dict holding the relevant target(destination)
|
|
information
|
|
:returns: boolean -- Always returns True
|
|
:returns: dict -- Empty dict {}
|
|
"""
|
|
return self.common.migrate_volume(ctxt, volume, host)
|
|
|
|
def retype(self, ctxt, volume, new_type, diff, host):
|
|
"""Migrate volume to another host using retype.
|
|
|
|
:param ctxt: context
|
|
:param volume: the volume object including the volume_type_id
|
|
:param new_type: the new volume type.
|
|
:param diff: Unused parameter.
|
|
:param host: the host dict holding the relevant
|
|
target(destination) information
|
|
:returns: boolean -- True if retype succeeded, False if error
|
|
"""
|
|
return self.common.retype(ctxt, volume, new_type, diff, host)
|
|
|
|
def create_consistencygroup(self, context, group):
|
|
"""Creates a consistencygroup."""
|
|
self.common.create_consistencygroup(context, group)
|
|
|
|
def delete_consistencygroup(self, context, group, volumes):
|
|
"""Deletes a consistency group."""
|
|
return self.common.delete_consistencygroup(
|
|
context, group, volumes)
|
|
|
|
def create_cgsnapshot(self, context, cgsnapshot, snapshots):
|
|
"""Creates a cgsnapshot."""
|
|
return self.common.create_cgsnapshot(context, cgsnapshot, snapshots)
|
|
|
|
def delete_cgsnapshot(self, context, cgsnapshot, snapshots):
|
|
"""Deletes a cgsnapshot."""
|
|
return self.common.delete_cgsnapshot(context, cgsnapshot, snapshots)
|
|
|
|
def manage_existing(self, volume, external_ref):
|
|
"""Manages an existing VMAX Volume (import to Cinder).
|
|
|
|
Renames the Volume to match the expected name for the volume.
|
|
Also need to consider things like QoS, Emulation, account/tenant.
|
|
"""
|
|
return self.common.manage_existing(volume, external_ref)
|
|
|
|
def manage_existing_get_size(self, volume, external_ref):
|
|
"""Return size of an existing VMAX volume to manage_existing.
|
|
|
|
:param self: reference to class
|
|
:param volume: the volume object including the volume_type_id
|
|
:param external_ref: reference to the existing volume
|
|
:returns: size of the volume in GB
|
|
"""
|
|
return self.common.manage_existing_get_size(volume, external_ref)
|
|
|
|
def unmanage(self, volume):
|
|
"""Export VMAX volume from Cinder.
|
|
|
|
Leave the volume intact on the backend array.
|
|
"""
|
|
return self.common.unmanage(volume)
|
|
|
|
def update_consistencygroup(self, context, group,
|
|
add_volumes, remove_volumes):
|
|
"""Updates LUNs in consistency group."""
|
|
return self.common.update_consistencygroup(group, add_volumes,
|
|
remove_volumes)
|
|
|
|
def create_consistencygroup_from_src(self, context, group, volumes,
|
|
cgsnapshot=None, snapshots=None,
|
|
source_cg=None, source_vols=None):
|
|
"""Creates the consistency group from source.
|
|
|
|
Currently the source can only be a cgsnapshot.
|
|
|
|
:param context: the context
|
|
:param group: the consistency group object to be created
|
|
:param volumes: volumes in the consistency group
|
|
:param cgsnapshot: the source consistency group snapshot
|
|
:param snapshots: snapshots of the source volumes
|
|
:param source_cg: the dictionary of a consistency group as source.
|
|
:param source_vols: a list of volume dictionaries in the source_cg.
|
|
"""
|
|
return self.common.create_consistencygroup_from_src(
|
|
context, group, volumes, cgsnapshot, snapshots, source_cg,
|
|
source_vols)
|
|
|
|
def create_export_snapshot(self, context, snapshot, connector):
|
|
"""Driver entry point to get the export info for a new snapshot."""
|
|
pass
|
|
|
|
def remove_export_snapshot(self, context, snapshot):
|
|
"""Driver entry point to remove an export for a snapshot."""
|
|
pass
|
|
|
|
def initialize_connection_snapshot(self, snapshot, connector, **kwargs):
|
|
"""Allows connection to snapshot.
|
|
|
|
:param snapshot: the snapshot object
|
|
:param connector: the connector object
|
|
:param kwargs: additional parameters
|
|
:returns: data dict
|
|
"""
|
|
src_volume = snapshot['volume']
|
|
snapshot['host'] = src_volume['host']
|
|
|
|
return self.initialize_connection(snapshot, connector)
|
|
|
|
def terminate_connection_snapshot(self, snapshot, connector, **kwargs):
|
|
"""Disallows connection to snapshot.
|
|
|
|
:param snapshot: the snapshot object
|
|
:param connector: the connector object
|
|
:param kwargs: additional parameters
|
|
"""
|
|
src_volume = snapshot['volume']
|
|
snapshot['host'] = src_volume['host']
|
|
return self.terminate_connection(snapshot, connector, **kwargs)
|
|
|
|
def backup_use_temp_snapshot(self):
|
|
return True
|