f5ec1be2d8
If server crash or reboot happened, LIO target configuration
will be initialized after boot up a server. Currently, Cinder
has a functionality to save LIO target configuration to save
file at several checkpoint.
If LIO target service is configured properly, LIO target
configuration is restored by this service during boot up
a server, but if not, existing in-use volumes would become
inconsistent status after c-vol service starts.
If there is no iSCSI target configuration during
ensure_export, LIO dirver should restore the saved
configuration file to avoid the problem.
Closes-Bug: #1536248
Change-Id: I74d300ba26a08b6f423f5ed3e13495b73cfbbd52
(cherry picked from commit 5cec4056eb)
344 lines
10 KiB
Python
344 lines
10 KiB
Python
#!/usr/bin/env python
|
|
|
|
# Copyright 2012 - 2013 Red Hat, 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.
|
|
|
|
import os
|
|
import sys
|
|
|
|
# We always use rtslib-fb, but until version 2.1.52 it didn't have its own
|
|
# namespace, so we must be backwards compatible.
|
|
try:
|
|
import rtslib_fb
|
|
except ImportError:
|
|
import rtslib as rtslib_fb
|
|
|
|
|
|
from cinder import i18n
|
|
from cinder.i18n import _
|
|
|
|
i18n.enable_lazy()
|
|
|
|
|
|
class RtstoolError(Exception):
|
|
pass
|
|
|
|
|
|
class RtstoolImportError(RtstoolError):
|
|
pass
|
|
|
|
|
|
def create(backing_device, name, userid, password, iser_enabled,
|
|
initiator_iqns=None, portals_ips=None, portals_port=3260):
|
|
# List of IPS that will not raise an error when they fail binding.
|
|
# Originally we will fail on all binding errors.
|
|
ips_allow_fail = ()
|
|
|
|
try:
|
|
rtsroot = rtslib_fb.root.RTSRoot()
|
|
except rtslib_fb.utils.RTSLibError:
|
|
print(_('Ensure that configfs is mounted at /sys/kernel/config.'))
|
|
raise
|
|
|
|
# Look to see if BlockStorageObject already exists
|
|
for x in rtsroot.storage_objects:
|
|
if x.name == name:
|
|
# Already exists, use this one
|
|
return
|
|
|
|
so_new = rtslib_fb.BlockStorageObject(name=name,
|
|
dev=backing_device)
|
|
|
|
target_new = rtslib_fb.Target(rtslib_fb.FabricModule('iscsi'), name,
|
|
'create')
|
|
|
|
tpg_new = rtslib_fb.TPG(target_new, mode='create')
|
|
tpg_new.set_attribute('authentication', '1')
|
|
|
|
lun_new = rtslib_fb.LUN(tpg_new, storage_object=so_new)
|
|
|
|
if initiator_iqns:
|
|
initiator_iqns = initiator_iqns.strip(' ')
|
|
for i in initiator_iqns.split(','):
|
|
acl_new = rtslib_fb.NodeACL(tpg_new, i, mode='create')
|
|
acl_new.chap_userid = userid
|
|
acl_new.chap_password = password
|
|
|
|
rtslib_fb.MappedLUN(acl_new, lun_new.lun, lun_new.lun)
|
|
|
|
tpg_new.enable = 1
|
|
|
|
# If no ips are given we'll bind to all IPv4 and v6
|
|
if not portals_ips:
|
|
portals_ips = ('0.0.0.0', '::0')
|
|
# TODO(emh): Binding to IPv6 fails sometimes -- let pass for now.
|
|
ips_allow_fail = ('::0',)
|
|
|
|
for ip in portals_ips:
|
|
try:
|
|
portal = rtslib_fb.NetworkPortal(tpg_new, ip, portals_port,
|
|
mode='any')
|
|
except rtslib_fb.utils.RTSLibError:
|
|
raise_exc = ip not in ips_allow_fail
|
|
msg_type = 'Error' if raise_exc else 'Warning'
|
|
print(_('%(msg_type)s: creating NetworkPortal: ensure port '
|
|
'%(port)d on ip %(ip)s is not in use by another service.')
|
|
% {'msg_type': msg_type, 'port': portals_port, 'ip': ip})
|
|
if raise_exc:
|
|
raise
|
|
else:
|
|
try:
|
|
if iser_enabled == 'True':
|
|
portal.iser = True
|
|
except rtslib_fb.utils.RTSLibError:
|
|
print(_('Error enabling iSER for NetworkPortal: please ensure '
|
|
'that RDMA is supported on your iSCSI port %(port)d '
|
|
'on ip %(ip)s.') % {'port': portals_port, 'ip': ip})
|
|
raise
|
|
|
|
|
|
def _lookup_target(target_iqn, initiator_iqn):
|
|
try:
|
|
rtsroot = rtslib_fb.root.RTSRoot()
|
|
except rtslib_fb.utils.RTSLibError:
|
|
print(_('Ensure that configfs is mounted at /sys/kernel/config.'))
|
|
raise
|
|
|
|
# Look for the target
|
|
for t in rtsroot.targets:
|
|
if t.wwn == target_iqn:
|
|
return t
|
|
raise RtstoolError(_('Could not find target %s') % target_iqn)
|
|
|
|
|
|
def add_initiator(target_iqn, initiator_iqn, userid, password):
|
|
target = _lookup_target(target_iqn, initiator_iqn)
|
|
tpg = next(target.tpgs) # get the first one
|
|
for acl in tpg.node_acls:
|
|
# See if this ACL configuration already exists
|
|
if acl.node_wwn.lower() == initiator_iqn.lower():
|
|
# No further action required
|
|
return
|
|
|
|
acl_new = rtslib_fb.NodeACL(tpg, initiator_iqn, mode='create')
|
|
acl_new.chap_userid = userid
|
|
acl_new.chap_password = password
|
|
|
|
rtslib_fb.MappedLUN(acl_new, 0, tpg_lun=0)
|
|
|
|
|
|
def delete_initiator(target_iqn, initiator_iqn):
|
|
target = _lookup_target(target_iqn, initiator_iqn)
|
|
tpg = next(target.tpgs) # get the first one
|
|
for acl in tpg.node_acls:
|
|
if acl.node_wwn.lower() == initiator_iqn.lower():
|
|
acl.delete()
|
|
return
|
|
raise RtstoolError(_('Could not find ACL %(acl)s in target %(target)s')
|
|
% {'target': target_iqn, 'acl': initiator_iqn})
|
|
|
|
|
|
def get_targets():
|
|
rtsroot = rtslib_fb.root.RTSRoot()
|
|
for x in rtsroot.targets:
|
|
print(x.wwn)
|
|
|
|
|
|
def delete(iqn):
|
|
rtsroot = rtslib_fb.root.RTSRoot()
|
|
for x in rtsroot.targets:
|
|
if x.wwn == iqn:
|
|
x.delete()
|
|
break
|
|
|
|
for x in rtsroot.storage_objects:
|
|
if x.name == iqn:
|
|
x.delete()
|
|
break
|
|
|
|
|
|
def verify_rtslib():
|
|
for member in ['BlockStorageObject', 'FabricModule', 'LUN',
|
|
'MappedLUN', 'NetworkPortal', 'NodeACL', 'root',
|
|
'Target', 'TPG']:
|
|
if not hasattr(rtslib_fb, member):
|
|
raise RtstoolImportError(_("rtslib_fb is missing member %s: You "
|
|
"may need a newer python-rtslib-fb.") %
|
|
member)
|
|
|
|
|
|
def usage():
|
|
print("Usage:")
|
|
print(sys.argv[0] +
|
|
" create [device] [name] [userid] [password] [iser_enabled]" +
|
|
" <initiator_iqn,iqn2,iqn3,...> [-a<IP1,IP2,...>] [-pPORT]")
|
|
print(sys.argv[0] +
|
|
" add-initiator [target_iqn] [userid] [password] [initiator_iqn]")
|
|
print(sys.argv[0] +
|
|
" delete-initiator [target_iqn] [initiator_iqn]")
|
|
print(sys.argv[0] + " get-targets")
|
|
print(sys.argv[0] + " delete [iqn]")
|
|
print(sys.argv[0] + " verify")
|
|
print(sys.argv[0] + " save [path_to_file]")
|
|
sys.exit(1)
|
|
|
|
|
|
def save_to_file(destination_file):
|
|
rtsroot = rtslib_fb.root.RTSRoot()
|
|
try:
|
|
# If default destination use rtslib default save file
|
|
if not destination_file:
|
|
destination_file = rtslib_fb.root.default_save_file
|
|
path_to_file = os.path.dirname(destination_file)
|
|
|
|
# NOTE(geguileo): With default file we ensure path exists and
|
|
# create it if doesn't.
|
|
# Cinder's LIO target helper runs this as root, so it will have no
|
|
# problem creating directory /etc/target.
|
|
# If run manually from the command line without being root you will
|
|
# get an error, same as when creating and removing targets.
|
|
if not os.path.exists(path_to_file):
|
|
os.makedirs(path_to_file, 0o755)
|
|
|
|
except OSError as exc:
|
|
raise RtstoolError(_('targetcli not installed and could not create '
|
|
'default directory (%(default_path)s): %(exc)s'),
|
|
{'default_path': path_to_file, 'exc': exc})
|
|
try:
|
|
rtsroot.save_to_file(destination_file)
|
|
except (OSError, IOError) as exc:
|
|
raise RtstoolError(_('Could not save configuration to %(file_path)s: '
|
|
'%(exc)s'),
|
|
{'file_path': destination_file, 'exc': exc})
|
|
|
|
|
|
def restore_from_file(configration_file):
|
|
rtsroot = rtslib_fb.root.RTSRoot()
|
|
# If configuration file is None, use rtslib default save file.
|
|
if not configration_file:
|
|
configration_file = rtslib_fb.root.default_save_file
|
|
|
|
try:
|
|
rtsroot.restore_from_file(configration_file)
|
|
except (OSError, IOError) as exc:
|
|
raise RtstoolError(_('Could not restore configuration file '
|
|
'%(file_path)s: %(exc)s'),
|
|
{'file_path': configration_file, 'exc': exc})
|
|
|
|
|
|
def parse_optional_create(argv):
|
|
optional_args = {}
|
|
|
|
for arg in argv:
|
|
if arg.startswith('-a'):
|
|
ips = [ip for ip in arg[2:].split(',') if ip]
|
|
if not ips:
|
|
usage()
|
|
optional_args['portals_ips'] = ips
|
|
elif arg.startswith('-p'):
|
|
try:
|
|
optional_args['portals_port'] = int(arg[2:])
|
|
except ValueError:
|
|
usage()
|
|
else:
|
|
optional_args['initiator_iqns'] = arg
|
|
return optional_args
|
|
|
|
|
|
def main(argv=None):
|
|
if argv is None:
|
|
argv = sys.argv
|
|
|
|
if len(argv) < 2:
|
|
usage()
|
|
|
|
if argv[1] == 'create':
|
|
if len(argv) < 7:
|
|
usage()
|
|
|
|
if len(argv) > 10:
|
|
usage()
|
|
|
|
backing_device = argv[2]
|
|
name = argv[3]
|
|
userid = argv[4]
|
|
password = argv[5]
|
|
iser_enabled = argv[6]
|
|
|
|
if len(argv) > 7:
|
|
optional_args = parse_optional_create(argv[7:])
|
|
else:
|
|
optional_args = {}
|
|
|
|
create(backing_device, name, userid, password, iser_enabled,
|
|
**optional_args)
|
|
|
|
elif argv[1] == 'add-initiator':
|
|
if len(argv) < 6:
|
|
usage()
|
|
|
|
target_iqn = argv[2]
|
|
userid = argv[3]
|
|
password = argv[4]
|
|
initiator_iqn = argv[5]
|
|
|
|
add_initiator(target_iqn, initiator_iqn, userid, password)
|
|
|
|
elif argv[1] == 'delete-initiator':
|
|
if len(argv) < 4:
|
|
usage()
|
|
|
|
target_iqn = argv[2]
|
|
initiator_iqn = argv[3]
|
|
|
|
delete_initiator(target_iqn, initiator_iqn)
|
|
|
|
elif argv[1] == 'get-targets':
|
|
get_targets()
|
|
|
|
elif argv[1] == 'delete':
|
|
if len(argv) < 3:
|
|
usage()
|
|
|
|
iqn = argv[2]
|
|
delete(iqn)
|
|
|
|
elif argv[1] == 'verify':
|
|
# This is used to verify that this script can be called by cinder,
|
|
# and that rtslib_fb is new enough to work.
|
|
verify_rtslib()
|
|
return 0
|
|
|
|
elif argv[1] == 'save':
|
|
if len(argv) > 3:
|
|
usage()
|
|
|
|
destination_file = argv[2] if len(argv) > 2 else None
|
|
save_to_file(destination_file)
|
|
return 0
|
|
|
|
elif argv[1] == 'restore':
|
|
if len(argv) > 3:
|
|
usage()
|
|
|
|
configuration_file = argv[2] if len(argv) > 2 else None
|
|
restore_from_file(configuration_file)
|
|
return 0
|
|
|
|
else:
|
|
usage()
|
|
|
|
return 0
|