84ea630be0
get_volume_api_version_from_endpoint currently assumes that the management_url will always be in the format of http://<ip>:<port>/vX/<tenant_id>. Customers using a gateway, however, can get a mangement_url in a different form like https://<ip>:<port>/<resource>/vX/<tenant_id>. This causes the get_volume_api_version_from_endpoint to find the resource portion of the url when looking for the Volume API version which makes the cinder client unusable. To resolve this I have implemented an exception handler in the case that get_volume_api_version_from_endpoint fails. If the exception is thrown, I check for OS_VOLUME_API_VERSION in the environment and use the value of that environment variable, if it is set, to determine the API version to use. There are proposals to fix this via changes to keystone in future releases, but this provides a way for IaaS Gateway users to proceed with Havana. Change-Id: I8b978a6ecd87b81c6ae34938e37623ad1cc33994 Closes-Bug: 1233311
556 lines
22 KiB
Python
556 lines
22 KiB
Python
|
|
# Copyright 2011 OpenStack LLC.
|
|
# 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.
|
|
|
|
"""
|
|
Command-line interface to the OpenStack Cinder API.
|
|
"""
|
|
|
|
from __future__ import print_function
|
|
|
|
import argparse
|
|
import glob
|
|
import imp
|
|
import itertools
|
|
import os
|
|
import pkgutil
|
|
import sys
|
|
import logging
|
|
|
|
from cinderclient import client
|
|
from cinderclient import exceptions as exc
|
|
import cinderclient.extension
|
|
from cinderclient.openstack.common import strutils
|
|
from cinderclient import utils
|
|
from cinderclient.v1 import shell as shell_v1
|
|
from cinderclient.v2 import shell as shell_v2
|
|
|
|
DEFAULT_OS_VOLUME_API_VERSION = "1"
|
|
DEFAULT_CINDER_ENDPOINT_TYPE = 'publicURL'
|
|
DEFAULT_CINDER_SERVICE_TYPE = 'volume'
|
|
|
|
logging.basicConfig()
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class CinderClientArgumentParser(argparse.ArgumentParser):
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
super(CinderClientArgumentParser, self).__init__(*args, **kwargs)
|
|
|
|
def error(self, message):
|
|
"""error(message: string)
|
|
|
|
Prints a usage message incorporating the message to stderr and
|
|
exits.
|
|
"""
|
|
self.print_usage(sys.stderr)
|
|
#FIXME(lzyeval): if changes occur in argparse.ArgParser._check_value
|
|
choose_from = ' (choose from'
|
|
progparts = self.prog.partition(' ')
|
|
self.exit(2, "error: %(errmsg)s\nTry '%(mainp)s help %(subp)s'"
|
|
" for more information.\n" %
|
|
{'errmsg': message.split(choose_from)[0],
|
|
'mainp': progparts[0],
|
|
'subp': progparts[2]})
|
|
|
|
|
|
class OpenStackCinderShell(object):
|
|
|
|
def get_base_parser(self):
|
|
parser = CinderClientArgumentParser(
|
|
prog='cinder',
|
|
description=__doc__.strip(),
|
|
epilog='See "cinder help COMMAND" '
|
|
'for help on a specific command.',
|
|
add_help=False,
|
|
formatter_class=OpenStackHelpFormatter,
|
|
)
|
|
|
|
# Global arguments
|
|
parser.add_argument('-h', '--help',
|
|
action='store_true',
|
|
help=argparse.SUPPRESS)
|
|
|
|
parser.add_argument('--version',
|
|
action='version',
|
|
version=cinderclient.__version__)
|
|
|
|
parser.add_argument('--debug',
|
|
action='store_true',
|
|
default=utils.env('CINDERCLIENT_DEBUG',
|
|
default=False),
|
|
help="Print debugging output")
|
|
|
|
parser.add_argument('--os-username',
|
|
metavar='<auth-user-name>',
|
|
default=utils.env('OS_USERNAME',
|
|
'CINDER_USERNAME'),
|
|
help='Defaults to env[OS_USERNAME].')
|
|
parser.add_argument('--os_username',
|
|
help=argparse.SUPPRESS)
|
|
|
|
parser.add_argument('--os-password',
|
|
metavar='<auth-password>',
|
|
default=utils.env('OS_PASSWORD',
|
|
'CINDER_PASSWORD'),
|
|
help='Defaults to env[OS_PASSWORD].')
|
|
parser.add_argument('--os_password',
|
|
help=argparse.SUPPRESS)
|
|
|
|
parser.add_argument('--os-tenant-name',
|
|
metavar='<auth-tenant-name>',
|
|
default=utils.env('OS_TENANT_NAME',
|
|
'CINDER_PROJECT_ID'),
|
|
help='Defaults to env[OS_TENANT_NAME].')
|
|
parser.add_argument('--os_tenant_name',
|
|
help=argparse.SUPPRESS)
|
|
|
|
parser.add_argument('--os-tenant-id',
|
|
metavar='<auth-tenant-id>',
|
|
default=utils.env('OS_TENANT_ID',
|
|
'CINDER_TENANT_ID'),
|
|
help='Defaults to env[OS_TENANT_ID].')
|
|
parser.add_argument('--os_tenant_id',
|
|
help=argparse.SUPPRESS)
|
|
|
|
parser.add_argument('--os-auth-url',
|
|
metavar='<auth-url>',
|
|
default=utils.env('OS_AUTH_URL',
|
|
'CINDER_URL'),
|
|
help='Defaults to env[OS_AUTH_URL].')
|
|
parser.add_argument('--os_auth_url',
|
|
help=argparse.SUPPRESS)
|
|
|
|
parser.add_argument('--os-region-name',
|
|
metavar='<region-name>',
|
|
default=utils.env('OS_REGION_NAME',
|
|
'CINDER_REGION_NAME'),
|
|
help='Defaults to env[OS_REGION_NAME].')
|
|
parser.add_argument('--os_region_name',
|
|
help=argparse.SUPPRESS)
|
|
|
|
parser.add_argument('--service-type',
|
|
metavar='<service-type>',
|
|
help='Defaults to volume for most actions')
|
|
parser.add_argument('--service_type',
|
|
help=argparse.SUPPRESS)
|
|
|
|
parser.add_argument('--service-name',
|
|
metavar='<service-name>',
|
|
default=utils.env('CINDER_SERVICE_NAME'),
|
|
help='Defaults to env[CINDER_SERVICE_NAME]')
|
|
parser.add_argument('--service_name',
|
|
help=argparse.SUPPRESS)
|
|
|
|
parser.add_argument('--volume-service-name',
|
|
metavar='<volume-service-name>',
|
|
default=utils.env('CINDER_VOLUME_SERVICE_NAME'),
|
|
help='Defaults to env[CINDER_VOLUME_SERVICE_NAME]')
|
|
parser.add_argument('--volume_service_name',
|
|
help=argparse.SUPPRESS)
|
|
|
|
parser.add_argument('--endpoint-type',
|
|
metavar='<endpoint-type>',
|
|
default=utils.env('CINDER_ENDPOINT_TYPE',
|
|
default=DEFAULT_CINDER_ENDPOINT_TYPE),
|
|
help='Defaults to env[CINDER_ENDPOINT_TYPE] or '
|
|
+ DEFAULT_CINDER_ENDPOINT_TYPE + '.')
|
|
parser.add_argument('--endpoint_type',
|
|
help=argparse.SUPPRESS)
|
|
|
|
parser.add_argument('--os-volume-api-version',
|
|
metavar='<volume-api-ver>',
|
|
default=utils.env('OS_VOLUME_API_VERSION',
|
|
default=None),
|
|
help='Accepts 1 or 2,defaults '
|
|
'to env[OS_VOLUME_API_VERSION].')
|
|
parser.add_argument('--os_volume_api_version',
|
|
help=argparse.SUPPRESS)
|
|
|
|
parser.add_argument('--os-cacert',
|
|
metavar='<ca-certificate>',
|
|
default=utils.env('OS_CACERT', default=None),
|
|
help='Specify a CA bundle file to use in '
|
|
'verifying a TLS (https) server certificate. '
|
|
'Defaults to env[OS_CACERT]')
|
|
|
|
parser.add_argument('--insecure',
|
|
default=utils.env('CINDERCLIENT_INSECURE',
|
|
default=False),
|
|
action='store_true',
|
|
help=argparse.SUPPRESS)
|
|
|
|
parser.add_argument('--retries',
|
|
metavar='<retries>',
|
|
type=int,
|
|
default=0,
|
|
help='Number of retries.')
|
|
|
|
# FIXME(dtroyer): The args below are here for diablo compatibility,
|
|
# remove them in folsum cycle
|
|
|
|
# alias for --os-username, left in for backwards compatibility
|
|
parser.add_argument('--username',
|
|
help=argparse.SUPPRESS)
|
|
|
|
# alias for --os-region_name, left in for backwards compatibility
|
|
parser.add_argument('--region_name',
|
|
help=argparse.SUPPRESS)
|
|
|
|
# alias for --os-password, left in for backwards compatibility
|
|
parser.add_argument('--apikey', '--password', dest='apikey',
|
|
default=utils.env('CINDER_API_KEY'),
|
|
help=argparse.SUPPRESS)
|
|
|
|
# alias for --os-tenant-name, left in for backward compatibility
|
|
parser.add_argument('--projectid', '--tenant_name', dest='projectid',
|
|
default=utils.env('CINDER_PROJECT_ID'),
|
|
help=argparse.SUPPRESS)
|
|
|
|
# alias for --os-auth-url, left in for backward compatibility
|
|
parser.add_argument('--url', '--auth_url', dest='url',
|
|
default=utils.env('CINDER_URL'),
|
|
help=argparse.SUPPRESS)
|
|
|
|
return parser
|
|
|
|
def get_subcommand_parser(self, version):
|
|
parser = self.get_base_parser()
|
|
|
|
self.subcommands = {}
|
|
subparsers = parser.add_subparsers(metavar='<subcommand>')
|
|
|
|
try:
|
|
actions_module = {
|
|
'1.1': shell_v1,
|
|
'2': shell_v2,
|
|
}[version]
|
|
except KeyError:
|
|
actions_module = shell_v1
|
|
|
|
self._find_actions(subparsers, actions_module)
|
|
self._find_actions(subparsers, self)
|
|
|
|
for extension in self.extensions:
|
|
self._find_actions(subparsers, extension.module)
|
|
|
|
self._add_bash_completion_subparser(subparsers)
|
|
|
|
return parser
|
|
|
|
def _discover_extensions(self, version):
|
|
extensions = []
|
|
for name, module in itertools.chain(
|
|
self._discover_via_python_path(version),
|
|
self._discover_via_contrib_path(version)):
|
|
|
|
extension = cinderclient.extension.Extension(name, module)
|
|
extensions.append(extension)
|
|
|
|
return extensions
|
|
|
|
def _discover_via_python_path(self, version):
|
|
for (module_loader, name, ispkg) in pkgutil.iter_modules():
|
|
if name.endswith('python_cinderclient_ext'):
|
|
if not hasattr(module_loader, 'load_module'):
|
|
# Python 2.6 compat: actually get an ImpImporter obj
|
|
module_loader = module_loader.find_module(name)
|
|
|
|
module = module_loader.load_module(name)
|
|
yield name, module
|
|
|
|
def _discover_via_contrib_path(self, version):
|
|
module_path = os.path.dirname(os.path.abspath(__file__))
|
|
version_str = "v%s" % version.replace('.', '_')
|
|
ext_path = os.path.join(module_path, version_str, 'contrib')
|
|
ext_glob = os.path.join(ext_path, "*.py")
|
|
|
|
for ext_path in glob.iglob(ext_glob):
|
|
name = os.path.basename(ext_path)[:-3]
|
|
|
|
if name == "__init__":
|
|
continue
|
|
|
|
module = imp.load_source(name, ext_path)
|
|
yield name, module
|
|
|
|
def _add_bash_completion_subparser(self, subparsers):
|
|
subparser = subparsers.add_parser(
|
|
'bash_completion',
|
|
add_help=False,
|
|
formatter_class=OpenStackHelpFormatter)
|
|
|
|
self.subcommands['bash_completion'] = subparser
|
|
subparser.set_defaults(func=self.do_bash_completion)
|
|
|
|
def _find_actions(self, subparsers, actions_module):
|
|
for attr in (a for a in dir(actions_module) if a.startswith('do_')):
|
|
# I prefer to be hypen-separated instead of underscores.
|
|
command = attr[3:].replace('_', '-')
|
|
callback = getattr(actions_module, attr)
|
|
desc = callback.__doc__ or ''
|
|
help = desc.strip().split('\n')[0]
|
|
arguments = getattr(callback, 'arguments', [])
|
|
|
|
subparser = subparsers.add_parser(
|
|
command,
|
|
help=help,
|
|
description=desc,
|
|
add_help=False,
|
|
formatter_class=OpenStackHelpFormatter)
|
|
|
|
subparser.add_argument('-h', '--help',
|
|
action='help',
|
|
help=argparse.SUPPRESS,)
|
|
|
|
self.subcommands[command] = subparser
|
|
for (args, kwargs) in arguments:
|
|
subparser.add_argument(*args, **kwargs)
|
|
subparser.set_defaults(func=callback)
|
|
|
|
def setup_debugging(self, debug):
|
|
if not debug:
|
|
return
|
|
|
|
streamhandler = logging.StreamHandler()
|
|
streamformat = "%(levelname)s (%(module)s:%(lineno)d) %(message)s"
|
|
streamhandler.setFormatter(logging.Formatter(streamformat))
|
|
logger.setLevel(logging.WARNING)
|
|
logger.addHandler(streamhandler)
|
|
|
|
def main(self, argv):
|
|
# Parse args once to find version and debug settings
|
|
parser = self.get_base_parser()
|
|
(options, args) = parser.parse_known_args(argv)
|
|
self.setup_debugging(options.debug)
|
|
api_version_input = True
|
|
|
|
if not options.os_volume_api_version:
|
|
# Environment variable OS_VOLUME_API_VERSION was
|
|
# not set and '--os-volume-api-version' option doesn't
|
|
# specify a value. Fall back to default.
|
|
options.os_volume_api_version = DEFAULT_OS_VOLUME_API_VERSION
|
|
api_version_input = False
|
|
|
|
# build available subcommands based on version
|
|
self.extensions = self._discover_extensions(
|
|
options.os_volume_api_version)
|
|
self._run_extension_hooks('__pre_parse_args__')
|
|
|
|
subcommand_parser = self.get_subcommand_parser(
|
|
options.os_volume_api_version)
|
|
self.parser = subcommand_parser
|
|
|
|
if options.help or not argv:
|
|
subcommand_parser.print_help()
|
|
return 0
|
|
|
|
args = subcommand_parser.parse_args(argv)
|
|
self._run_extension_hooks('__post_parse_args__', args)
|
|
|
|
# Short-circuit and deal with help right away.
|
|
if args.func == self.do_help:
|
|
self.do_help(args)
|
|
return 0
|
|
elif args.func == self.do_bash_completion:
|
|
self.do_bash_completion(args)
|
|
return 0
|
|
|
|
(os_username, os_password, os_tenant_name, os_auth_url,
|
|
os_region_name, os_tenant_id, endpoint_type, insecure,
|
|
service_type, service_name, volume_service_name,
|
|
username, apikey, projectid, url, region_name, cacert) = (
|
|
args.os_username, args.os_password,
|
|
args.os_tenant_name, args.os_auth_url,
|
|
args.os_region_name, args.os_tenant_id,
|
|
args.endpoint_type, args.insecure,
|
|
args.service_type, args.service_name,
|
|
args.volume_service_name, args.username,
|
|
args.apikey, args.projectid,
|
|
args.url, args.region_name, args.os_cacert)
|
|
|
|
if not endpoint_type:
|
|
endpoint_type = DEFAULT_CINDER_ENDPOINT_TYPE
|
|
|
|
if not service_type:
|
|
service_type = DEFAULT_CINDER_SERVICE_TYPE
|
|
service_type = utils.get_service_type(args.func) or service_type
|
|
|
|
#FIXME(usrleon): Here should be restrict for project id same as
|
|
# for os_username or os_password but for compatibility it is not.
|
|
|
|
if not utils.isunauthenticated(args.func):
|
|
if not os_username:
|
|
if not username:
|
|
raise exc.CommandError(
|
|
"You must provide a username "
|
|
"via either --os-username or env[OS_USERNAME]")
|
|
else:
|
|
os_username = username
|
|
|
|
if not os_password:
|
|
if not apikey:
|
|
raise exc.CommandError("You must provide a password "
|
|
"via either --os-password or via "
|
|
"env[OS_PASSWORD]")
|
|
else:
|
|
os_password = apikey
|
|
|
|
if not (os_tenant_name or os_tenant_id):
|
|
if not projectid:
|
|
raise exc.CommandError("You must provide a tenant_id "
|
|
"via either --os-tenant-id or "
|
|
"env[OS_TENANT_ID]")
|
|
else:
|
|
os_tenant_name = projectid
|
|
|
|
if not os_auth_url:
|
|
if not url:
|
|
raise exc.CommandError(
|
|
"You must provide an auth url "
|
|
"via either --os-auth-url or env[OS_AUTH_URL]")
|
|
else:
|
|
os_auth_url = url
|
|
|
|
if not os_region_name and region_name:
|
|
os_region_name = region_name
|
|
|
|
if not (os_tenant_name or os_tenant_id):
|
|
raise exc.CommandError(
|
|
"You must provide a tenant_id "
|
|
"via either --os-tenant-id or env[OS_TENANT_ID]")
|
|
|
|
if not os_auth_url:
|
|
raise exc.CommandError(
|
|
"You must provide an auth url "
|
|
"via either --os-auth-url or env[OS_AUTH_URL]")
|
|
|
|
self.cs = client.Client(options.os_volume_api_version, os_username,
|
|
os_password, os_tenant_name, os_auth_url,
|
|
insecure, region_name=os_region_name,
|
|
tenant_id=os_tenant_id,
|
|
endpoint_type=endpoint_type,
|
|
extensions=self.extensions,
|
|
service_type=service_type,
|
|
service_name=service_name,
|
|
volume_service_name=volume_service_name,
|
|
retries=options.retries,
|
|
http_log_debug=args.debug,
|
|
cacert=cacert)
|
|
|
|
try:
|
|
if not utils.isunauthenticated(args.func):
|
|
self.cs.authenticate()
|
|
except exc.Unauthorized:
|
|
raise exc.CommandError("Invalid OpenStack Cinder credentials.")
|
|
except exc.AuthorizationFailure:
|
|
raise exc.CommandError("Unable to authorize user")
|
|
|
|
endpoint_api_version = None
|
|
# Try to get the API version from the endpoint URL. If that fails fall
|
|
# back to trying to use what the user specified via
|
|
# --os-volume-api-version or with the OS_VOLUME_API_VERSION environment
|
|
# variable. Fail safe is to use the default API setting.
|
|
try:
|
|
endpoint_api_version = \
|
|
self.cs.get_volume_api_version_from_endpoint()
|
|
if endpoint_api_version != options.os_volume_api_version:
|
|
msg = (("Volume API version is set to %s "
|
|
"but you are accessing a %s endpoint. "
|
|
"Change its value via either --os-volume-api-version "
|
|
"or env[OS_VOLUME_API_VERSION]")
|
|
% (options.os_volume_api_version, endpoint_api_version))
|
|
raise exc.InvalidAPIVersion(msg)
|
|
except exc.UnsupportedVersion:
|
|
endpoint_api_version = options.os_volume_api_version
|
|
if api_version_input:
|
|
logger.warning("Unable to determine the API version via "
|
|
"endpoint URL. Falling back to user "
|
|
"specified version: %s" %
|
|
endpoint_api_version)
|
|
else:
|
|
logger.warning("Unable to determine the API version from "
|
|
"endpoint URL or user input. Falling back to "
|
|
"default API version: %s" %
|
|
endpoint_api_version)
|
|
|
|
args.func(self.cs, args)
|
|
|
|
def _run_extension_hooks(self, hook_type, *args, **kwargs):
|
|
"""Run hooks for all registered extensions."""
|
|
for extension in self.extensions:
|
|
extension.run_hooks(hook_type, *args, **kwargs)
|
|
|
|
def do_bash_completion(self, args):
|
|
"""Print arguments for bash_completion.
|
|
|
|
Prints all of the commands and options to stdout so that the
|
|
cinder.bash_completion script doesn't have to hard code them.
|
|
"""
|
|
commands = set()
|
|
options = set()
|
|
for sc_str, sc in list(self.subcommands.items()):
|
|
commands.add(sc_str)
|
|
for option in sc._optionals._option_string_actions:
|
|
options.add(option)
|
|
|
|
commands.remove('bash-completion')
|
|
commands.remove('bash_completion')
|
|
print(' '.join(commands | options))
|
|
|
|
@utils.arg('command', metavar='<subcommand>', nargs='?',
|
|
help='Display help for <subcommand>')
|
|
def do_help(self, args):
|
|
"""
|
|
Display help about this program or one of its subcommands.
|
|
"""
|
|
if args.command:
|
|
if args.command in self.subcommands:
|
|
self.subcommands[args.command].print_help()
|
|
else:
|
|
raise exc.CommandError("'%s' is not a valid subcommand" %
|
|
args.command)
|
|
else:
|
|
self.parser.print_help()
|
|
|
|
|
|
# I'm picky about my shell help.
|
|
class OpenStackHelpFormatter(argparse.HelpFormatter):
|
|
def start_section(self, heading):
|
|
# Title-case the headings
|
|
heading = '%s%s' % (heading[0].upper(), heading[1:])
|
|
super(OpenStackHelpFormatter, self).start_section(heading)
|
|
|
|
|
|
def main():
|
|
try:
|
|
if sys.version_info >= (3, 0):
|
|
OpenStackCinderShell().main(sys.argv[1:])
|
|
else:
|
|
OpenStackCinderShell().main(map(strutils.safe_decode,
|
|
sys.argv[1:]))
|
|
except KeyboardInterrupt:
|
|
print("... terminating cinder client", file=sys.stderr)
|
|
sys.exit(130)
|
|
except Exception as e:
|
|
logger.debug(e, exc_info=1)
|
|
print("ERROR: %s" % strutils.six.text_type(e), file=sys.stderr)
|
|
sys.exit(1)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|