Rename specific driver option with synology prefix

To produce tables from autogenerate_config_docs tool, we need to
rename Synology specific option to avoid confusion in flagmappings
file in openstack-manuals.

DocImpact
Closes-Bug: #1619234

Change-Id: I79c676adcb5e2e2bbcaf9b71771b60c4501ae49c
This commit is contained in:
taylorh 2016-08-30 16:39:17 +08:00
parent c2cb32beff
commit 4e164f1573
3 changed files with 36 additions and 34 deletions

View File

@ -359,14 +359,14 @@ class SynoCommonTestCase(test.TestCase):
config.iscsi_protocol = 'iscsi'
config.iscsi_ip_address = IP
config.iscsi_port = 3260
config.admin_port = 5000
config.username = 'admin'
config.password = 'admin'
config.ssl_verify = True
config.one_time_pass = '123456'
config.synology_admin_port = 5000
config.synology_username = 'admin'
config.synology_password = 'admin'
config.synology_ssl_verify = True
config.synology_one_time_pass = '123456'
config.synology_pool_name = POOL_NAME
config.volume_dd_blocksize = 1
config.iscsi_target_prefix = 'iqn.2000-01.com.synology:'
config.pool_name = POOL_NAME
config.chap_username = 'abcd'
config.chap_password = 'qwerty'
config.reserved_percentage = 0
@ -450,7 +450,7 @@ class SynoCommonTestCase(test.TestCase):
self.assertRaises(exception.SynoAuthError,
self.common._get_pool_info)
self.conf.pool_name = ''
self.conf.synology_pool_name = ''
self.assertRaises(exception.InvalidConfigurationValue,
self.common._get_pool_info)
@ -509,7 +509,7 @@ class SynoCommonTestCase(test.TestCase):
self.assertRaises(exception.MalformedResponse,
self.common._get_pool_lun_provisioned_size)
self.conf.pool_name = ''
self.conf.synology_pool_name = ''
self.assertRaises(exception.InvalidConfigurationValue,
self.common._get_pool_lun_provisioned_size)
@ -1275,7 +1275,7 @@ class SynoCommonTestCase(test.TestCase):
mock.ANY,
name=VOLUME['name'],
type=self.common.CINDER_LUN,
location='/' + self.conf.pool_name,
location='/' + self.conf.synology_pool_name,
size=VOLUME['size'] * units.Gi))
self.assertIsNone(result)

View File

@ -99,11 +99,11 @@ class SynoISCSIDriverTestCase(test.TestCase):
config.use_chap_auth = False
config.iscsi_protocol = 'iscsi'
config.iscsi_ip_address = IP
config.admin_port = 5000
config.username = 'admin'
config.password = 'admin'
config.ssl_verify = True
config.one_time_pass = '123456'
config.synology_admin_port = 5000
config.synology_username = 'admin'
config.synology_password = 'admin'
config.synology_ssl_verify = True
config.synology_one_time_pass = '123456'
config.volume_dd_blocksize = 1
return config

View File

@ -43,30 +43,30 @@ from cinder.volume import utils as volutils
cinder_opts = [
cfg.StrOpt('pool_name',
cfg.StrOpt('synology_pool_name',
default='',
help='Volume on Synology storage to be used for creating lun.'),
cfg.PortOpt('admin_port',
cfg.PortOpt('synology_admin_port',
default=5000,
help='Management port for Synology storage.'),
cfg.StrOpt('username',
cfg.StrOpt('synology_username',
default='admin',
help='Administrator of Synology storage.'),
cfg.StrOpt('password',
cfg.StrOpt('synology_password',
default='',
help='Password of administrator for logging in '
'Synology storage.',
secret=True),
cfg.BoolOpt('ssl_verify',
cfg.BoolOpt('synology_ssl_verify',
default=True,
help='Do certificate validation or not if '
'$driver_use_ssl is True'),
cfg.StrOpt('one_time_pass',
cfg.StrOpt('synology_one_time_pass',
default=None,
help='One time password of administrator for logging in '
'Synology storage if OTP is enabled.',
secret=True),
cfg.StrOpt('device_id',
cfg.StrOpt('synology_device_id',
default=None,
help='Device id for skip one time password check for '
'logging in Synology storage if OTP is enabled.'),
@ -388,9 +388,9 @@ class SynoCommon(object):
raise exception.InvalidConfigurationValue(
option='iscsi_ip_address',
value='')
if not config.safe_get('pool_name'):
if not config.safe_get('synology_pool_name'):
raise exception.InvalidConfigurationValue(
option='pool_name',
option='synology_pool_name',
value='')
self.config = config
@ -400,13 +400,13 @@ class SynoCommon(object):
self.iscsi_port = self.config.safe_get('iscsi_port')
api = APIRequest(self.config.iscsi_ip_address,
self.config.admin_port,
self.config.username,
self.config.password,
self.config.synology_admin_port,
self.config.synology_username,
self.config.synology_password,
self.config.safe_get('driver_use_ssl'),
self.config.safe_get('ssl_verify'),
self.config.safe_get('one_time_pass'),
self.config.safe_get('device_id'),)
self.config.safe_get('synology_ssl_verify'),
self.config.safe_get('synology_one_time_pass'),
self.config.safe_get('synology_device_id'),)
self.synoexec = api.request
self.host_uuid = self._get_node_uuid()
@ -433,7 +433,7 @@ class SynoCommon(object):
return out['data']['nodes'][0]['uuid']
def _get_pool_info(self):
pool_name = self.config.pool_name
pool_name = self.config.synology_pool_name
if not pool_name:
raise exception.InvalidConfigurationValue(option='pool_name',
value='')
@ -472,7 +472,7 @@ class SynoCommon(object):
return free_capacity_gb, total_capacity_gb, other_user_data_gb
def _get_pool_lun_provisioned_size(self):
pool_name = self.config.pool_name
pool_name = self.config.synology_pool_name
if not pool_name:
raise exception.InvalidConfigurationValue(option='pool_name',
value=pool_name)
@ -822,7 +822,8 @@ class SynoCommon(object):
reason=_('no readonly found'))
if pool_info['readonly']:
message = _('pool [%s] is not writable') % self.config.pool_name
message = (_('pool [%s] is not writable') %
self.config.synology_pool_name)
raise exception.VolumeDriverException(message=message)
def _check_ds_version(self):
@ -1023,7 +1024,7 @@ class SynoCommon(object):
max_over_subscription_ratio)
data['iscsi_ip_address'] = self.config.iscsi_ip_address
data['pool_name'] = self.config.pool_name
data['pool_name'] = self.config.synology_pool_name
data['backend_info'] = ('%s:%s:%s' %
(self.vendor_name,
self.driver_type,
@ -1038,7 +1039,8 @@ class SynoCommon(object):
1,
name=volume['name'],
type=self.CINDER_LUN,
location='/' + self.config.pool_name,
location=('/' +
self.config.synology_pool_name),
size=volume['size'] * units.Gi)
self.check_response(out)