651f0c38a1
The Cinder v1 API was deprecated several years ago and may be removed from python-cinderclient in the near future. To handle the case where v1 is no longer present, this updates cinderclient initialization to work without it and give an appropriate error if v1 is requested with a version where it is no longer available. Change-Id: I277d7b48b8ad4cce383ec3722f8117938378f615 Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
91 lines
2.7 KiB
Python
91 lines
2.7 KiB
Python
# Copyright 2012-2013 OpenStack Foundation
|
|
#
|
|
# 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 logging
|
|
|
|
from osc_lib import utils
|
|
|
|
from openstackclient.i18n import _
|
|
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
DEFAULT_API_VERSION = '2'
|
|
API_VERSION_OPTION = 'os_volume_api_version'
|
|
API_NAME = "volume"
|
|
API_VERSIONS = {
|
|
"1": "cinderclient.v1.client.Client",
|
|
"2": "cinderclient.v2.client.Client",
|
|
"3": "cinderclient.v3.client.Client",
|
|
}
|
|
|
|
|
|
def make_client(instance):
|
|
"""Returns a volume service client."""
|
|
|
|
# Defer client imports until we actually need them
|
|
from cinderclient import extension
|
|
from cinderclient.v3.contrib import list_extensions
|
|
from cinderclient.v3 import volume_snapshots
|
|
from cinderclient.v3 import volumes
|
|
|
|
# Try a small import to check if cinderclient v1 is supported
|
|
try:
|
|
from cinderclient.v1 import services # noqa
|
|
except Exception:
|
|
del API_VERSIONS['1']
|
|
|
|
if instance._api_version[API_NAME] == '1':
|
|
# Monkey patch for v1 cinderclient
|
|
volumes.Volume.NAME_ATTR = 'display_name'
|
|
volume_snapshots.Snapshot.NAME_ATTR = 'display_name'
|
|
|
|
volume_client = utils.get_client_class(
|
|
API_NAME,
|
|
instance._api_version[API_NAME],
|
|
API_VERSIONS
|
|
)
|
|
LOG.debug('Instantiating volume client: %s', volume_client)
|
|
|
|
# Set client http_log_debug to True if verbosity level is high enough
|
|
http_log_debug = utils.get_effective_log_level() <= logging.DEBUG
|
|
|
|
extensions = [extension.Extension('list_extensions', list_extensions)]
|
|
|
|
# Remember interface only if it is set
|
|
kwargs = utils.build_kwargs_dict('endpoint_type', instance.interface)
|
|
|
|
client = volume_client(
|
|
session=instance.session,
|
|
extensions=extensions,
|
|
http_log_debug=http_log_debug,
|
|
region_name=instance.region_name,
|
|
**kwargs
|
|
)
|
|
|
|
return client
|
|
|
|
|
|
def build_option_parser(parser):
|
|
"""Hook to add global options"""
|
|
parser.add_argument(
|
|
'--os-volume-api-version',
|
|
metavar='<volume-api-version>',
|
|
default=utils.env('OS_VOLUME_API_VERSION'),
|
|
help=_('Volume API version, default=%s '
|
|
'(Env: OS_VOLUME_API_VERSION)') % DEFAULT_API_VERSION
|
|
)
|
|
return parser
|