189 lines
7.1 KiB
Python
189 lines
7.1 KiB
Python
# 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.
|
|
|
|
|
|
from cinder import exception
|
|
from cinder.openstack.common.gettextutils import _
|
|
from cinder.openstack.common import log as logging
|
|
from cinder.openstack.common import processutils
|
|
from cinder.volume.targets import driver
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
class ISCSITarget(driver.Target):
|
|
"""Target object for block storage devices.
|
|
|
|
Base class for target object, where target
|
|
is data transport mechanism (target) specific calls.
|
|
This includes things like create targets, attach, detach
|
|
etc.
|
|
"""
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
super(ISCSITarget, self).__init__(*args, **kwargs)
|
|
self.iscsi_target_prefix = \
|
|
self.configuration.safe_get('iscsi_target_prefix')
|
|
self.protocol = 'iSCSI'
|
|
|
|
def _get_iscsi_properties(self, volume):
|
|
"""Gets iscsi configuration
|
|
|
|
We ideally get saved information in the volume entity, but fall back
|
|
to discovery if need be. Discovery may be completely removed in the
|
|
future.
|
|
|
|
The properties are:
|
|
|
|
:target_discovered: boolean indicating whether discovery was used
|
|
|
|
:target_iqn: the IQN of the iSCSI target
|
|
|
|
:target_portal: the portal of the iSCSI target
|
|
|
|
:target_lun: the lun of the iSCSI target
|
|
|
|
:volume_id: the uuid of the volume
|
|
|
|
:auth_method:, :auth_username:, :auth_password:
|
|
|
|
the authentication details. Right now, either auth_method is not
|
|
present meaning no authentication, or auth_method == `CHAP`
|
|
meaning use CHAP with the specified credentials.
|
|
|
|
:access_mode: the volume access mode allow client used
|
|
('rw' or 'ro' currently supported)
|
|
"""
|
|
|
|
properties = {}
|
|
|
|
location = volume['provider_location']
|
|
|
|
if location:
|
|
# provider_location is the same format as iSCSI discovery output
|
|
properties['target_discovered'] = False
|
|
else:
|
|
location = self._do_iscsi_discovery(volume)
|
|
|
|
if not location:
|
|
msg = (_("Could not find iSCSI export for volume %s") %
|
|
(volume['name']))
|
|
raise exception.InvalidVolume(reason=msg)
|
|
|
|
LOG.debug(("ISCSI Discovery: Found %s") % (location))
|
|
properties['target_discovered'] = True
|
|
|
|
results = location.split(" ")
|
|
properties['target_portal'] = results[0].split(",")[0]
|
|
properties['target_iqn'] = results[1]
|
|
try:
|
|
properties['target_lun'] = int(results[2])
|
|
except (IndexError, ValueError):
|
|
# NOTE(jdg): The following is carried over from the existing
|
|
# code. The trick here is that different targets use different
|
|
# default lun numbers, the base driver with tgtadm uses 1
|
|
# others like LIO use 0.
|
|
if (self.configuration.volume_driver in
|
|
['cinder.volume.drivers.lvm.LVMISCSIDriver',
|
|
'cinder.volume.drivers.lvm.ThinLVMVolumeDriver'] and
|
|
self.configuration.iscsi_helper == 'tgtadm'):
|
|
properties['target_lun'] = 1
|
|
else:
|
|
properties['target_lun'] = 0
|
|
|
|
properties['volume_id'] = volume['id']
|
|
|
|
auth = volume['provider_auth']
|
|
if auth:
|
|
(auth_method, auth_username, auth_secret) = auth.split()
|
|
|
|
properties['auth_method'] = auth_method
|
|
properties['auth_username'] = auth_username
|
|
properties['auth_password'] = auth_secret
|
|
|
|
geometry = volume.get('provider_geometry', None)
|
|
if geometry:
|
|
(physical_block_size, logical_block_size) = geometry.split()
|
|
properties['physical_block_size'] = physical_block_size
|
|
properties['logical_block_size'] = logical_block_size
|
|
|
|
encryption_key_id = volume.get('encryption_key_id', None)
|
|
properties['encrypted'] = encryption_key_id is not None
|
|
|
|
return properties
|
|
|
|
def _iscsi_authentication(self, chap, name, password):
|
|
return "%s %s %s" % (chap, name, password)
|
|
|
|
def _do_iscsi_discovery(self, volume):
|
|
# TODO(justinsb): Deprecate discovery and use stored info
|
|
# NOTE(justinsb): Discovery won't work with CHAP-secured targets (?)
|
|
LOG.warn(_("ISCSI provider_location not stored, using discovery"))
|
|
|
|
volume_name = volume['name']
|
|
|
|
try:
|
|
# NOTE(griff) We're doing the split straight away which should be
|
|
# safe since using '@' in hostname is considered invalid
|
|
|
|
(out, _err) = self._execute('iscsiadm', '-m', 'discovery',
|
|
'-t', 'sendtargets', '-p',
|
|
volume['host'].split('@')[0],
|
|
run_as_root=True)
|
|
except processutils.ProcessExecutionError as ex:
|
|
LOG.error(_("ISCSI discovery attempt failed for:%s") %
|
|
volume['host'].split('@')[0])
|
|
LOG.debug(("Error from iscsiadm -m discovery: %s") % ex.stderr)
|
|
return None
|
|
|
|
for target in out.splitlines():
|
|
if (self.configuration.safe_get('iscsi_ip_address') in target
|
|
and volume_name in target):
|
|
return target
|
|
return None
|
|
|
|
def detach_volume(self, context, volume):
|
|
self._get_iscsi_properties(volume)
|
|
|
|
def initialize_connection(self, volume, **kwargs):
|
|
"""Initializes the connection and returns connection info.
|
|
|
|
The iscsi driver returns a driver_volume_type of 'iscsi'.
|
|
The format of the driver data is defined in _get_iscsi_properties.
|
|
Example return value::
|
|
|
|
{
|
|
'driver_volume_type': 'iscsi'
|
|
'data': {
|
|
'target_discovered': True,
|
|
'target_iqn': 'iqn.2010-10.org.openstack:volume-00000001',
|
|
'target_portal': '127.0.0.0.1:3260',
|
|
'volume_id': '9a0d35d0-175a-11e4-8c21-0800200c9a66',
|
|
'access_mode': 'rw'
|
|
}
|
|
}
|
|
"""
|
|
|
|
iscsi_properties = self._get_iscsi_properties(volume)
|
|
return {
|
|
'driver_volume_type': 'iscsi',
|
|
'data': iscsi_properties
|
|
}
|
|
|
|
def validate_connector(self, connector):
|
|
# NOTE(jdg): api passes in connector which is initiator info
|
|
if 'initiator' not in connector:
|
|
err_msg = (_('The volume driver requires the iSCSI initiator '
|
|
'name in the connector.'))
|
|
LOG.error(err_msg)
|
|
raise exception.VolumeBackendAPIException(data=err_msg)
|