9f255a9b49
H306 - module imports should be in alphabetical order Change-Id: I1f8fc25b0e6ca23c21c90bda420f42a45141c2e2
530 lines
21 KiB
Python
530 lines
21 KiB
Python
# Copyright 2012 OpenStack Foundation
|
|
# 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 Images API.
|
|
"""
|
|
|
|
from __future__ import print_function
|
|
|
|
import argparse
|
|
import json
|
|
import logging
|
|
import os
|
|
from os.path import expanduser
|
|
import re
|
|
import sys
|
|
|
|
from keystoneclient.v2_0 import client as ksclient
|
|
import netaddr
|
|
|
|
import glanceclient
|
|
from glanceclient.common import utils
|
|
from glanceclient import exc
|
|
from glanceclient.openstack.common import strutils
|
|
|
|
|
|
class OpenStackImagesShell(object):
|
|
|
|
def get_base_parser(self):
|
|
parser = argparse.ArgumentParser(
|
|
prog='glance',
|
|
description=__doc__.strip(),
|
|
epilog='See "glance help COMMAND" '
|
|
'for help on a specific command.',
|
|
add_help=False,
|
|
formatter_class=HelpFormatter,
|
|
)
|
|
|
|
# Global arguments
|
|
parser.add_argument('-h', '--help',
|
|
action='store_true',
|
|
help=argparse.SUPPRESS,
|
|
)
|
|
|
|
parser.add_argument('--version',
|
|
action='version',
|
|
version=glanceclient.__version__)
|
|
|
|
parser.add_argument('-d', '--debug',
|
|
default=bool(utils.env('GLANCECLIENT_DEBUG')),
|
|
action='store_true',
|
|
help='Defaults to env[GLANCECLIENT_DEBUG]')
|
|
|
|
parser.add_argument('-v', '--verbose',
|
|
default=False, action="store_true",
|
|
help="Print more verbose output")
|
|
|
|
parser.add_argument('--get-schema',
|
|
default=False, action="store_true",
|
|
dest='get_schema',
|
|
help='Force retrieving the schema used to generate'
|
|
' portions of the help text rather than using'
|
|
' a cached copy. Ignored with api version 1')
|
|
|
|
parser.add_argument('-k', '--insecure',
|
|
default=False,
|
|
action='store_true',
|
|
help='Explicitly allow glanceclient to perform '
|
|
'\"insecure SSL\" (https) requests. The server\'s '
|
|
'certificate will not be verified against any '
|
|
'certificate authorities. This option should '
|
|
'be used with caution.')
|
|
|
|
parser.add_argument('--cert-file',
|
|
help='Path of certificate file to use in SSL '
|
|
'connection. This file can optionally be '
|
|
'prepended with the private key.')
|
|
|
|
parser.add_argument('--key-file',
|
|
help='Path of client key to use in SSL '
|
|
'connection. This option is not necessary '
|
|
'if your key is prepended to your cert file.')
|
|
|
|
parser.add_argument('--os-cacert',
|
|
metavar='<ca-certificate-file>',
|
|
dest='os_cacert',
|
|
default=utils.env('OS_CACERT'),
|
|
help='Path of CA TLS certificate(s) used to '
|
|
'verify the remote server\'s certificate. '
|
|
'Without this option glance looks for the '
|
|
'default system CA certificates.')
|
|
|
|
parser.add_argument('--ca-file',
|
|
dest='os_cacert',
|
|
help='DEPRECATED! Use --os-cacert.')
|
|
|
|
parser.add_argument('--timeout',
|
|
default=600,
|
|
help='Number of seconds to wait for a response')
|
|
|
|
parser.add_argument('--no-ssl-compression',
|
|
dest='ssl_compression',
|
|
default=True, action='store_false',
|
|
help='Disable SSL compression when using https.')
|
|
|
|
parser.add_argument('-f', '--force',
|
|
dest='force',
|
|
default=False, action='store_true',
|
|
help='Prevent select actions from requesting '
|
|
'user confirmation.')
|
|
|
|
#NOTE(bcwaldon): DEPRECATED
|
|
parser.add_argument('--dry-run',
|
|
default=False,
|
|
action='store_true',
|
|
help='DEPRECATED! Only used for deprecated '
|
|
'legacy commands.')
|
|
|
|
#NOTE(bcwaldon): DEPRECATED
|
|
parser.add_argument('--ssl',
|
|
dest='use_ssl',
|
|
default=False,
|
|
action='store_true',
|
|
help='DEPRECATED! Send a fully-formed endpoint '
|
|
'using --os-image-url instead.')
|
|
|
|
#NOTE(bcwaldon): DEPRECATED
|
|
parser.add_argument('-H', '--host',
|
|
metavar='ADDRESS',
|
|
help='DEPRECATED! Send a fully-formed endpoint '
|
|
'using --os-image-url instead.')
|
|
|
|
#NOTE(bcwaldon): DEPRECATED
|
|
parser.add_argument('-p', '--port',
|
|
dest='port',
|
|
metavar='PORT',
|
|
type=int,
|
|
default=9292,
|
|
help='DEPRECATED! Send a fully-formed endpoint '
|
|
'using --os-image-url instead.')
|
|
|
|
parser.add_argument('--os-username',
|
|
default=utils.env('OS_USERNAME'),
|
|
help='Defaults to env[OS_USERNAME]')
|
|
|
|
parser.add_argument('--os_username',
|
|
help=argparse.SUPPRESS)
|
|
|
|
#NOTE(bcwaldon): DEPRECATED
|
|
parser.add_argument('-I',
|
|
dest='os_username',
|
|
help='DEPRECATED! Use --os-username.')
|
|
|
|
parser.add_argument('--os-password',
|
|
default=utils.env('OS_PASSWORD'),
|
|
help='Defaults to env[OS_PASSWORD]')
|
|
|
|
parser.add_argument('--os_password',
|
|
help=argparse.SUPPRESS)
|
|
|
|
#NOTE(bcwaldon): DEPRECATED
|
|
parser.add_argument('-K',
|
|
dest='os_password',
|
|
help='DEPRECATED! Use --os-password.')
|
|
|
|
parser.add_argument('--os-tenant-id',
|
|
default=utils.env('OS_TENANT_ID'),
|
|
help='Defaults to env[OS_TENANT_ID]')
|
|
|
|
parser.add_argument('--os_tenant_id',
|
|
help=argparse.SUPPRESS)
|
|
|
|
parser.add_argument('--os-tenant-name',
|
|
default=utils.env('OS_TENANT_NAME'),
|
|
help='Defaults to env[OS_TENANT_NAME]')
|
|
|
|
parser.add_argument('--os_tenant_name',
|
|
help=argparse.SUPPRESS)
|
|
|
|
#NOTE(bcwaldon): DEPRECATED
|
|
parser.add_argument('-T',
|
|
dest='os_tenant_name',
|
|
help='DEPRECATED! Use --os-tenant-name.')
|
|
|
|
parser.add_argument('--os-auth-url',
|
|
default=utils.env('OS_AUTH_URL'),
|
|
help='Defaults to env[OS_AUTH_URL]')
|
|
|
|
parser.add_argument('--os_auth_url',
|
|
help=argparse.SUPPRESS)
|
|
|
|
#NOTE(bcwaldon): DEPRECATED
|
|
parser.add_argument('-N',
|
|
dest='os_auth_url',
|
|
help='DEPRECATED! Use --os-auth-url.')
|
|
|
|
parser.add_argument('--os-region-name',
|
|
default=utils.env('OS_REGION_NAME'),
|
|
help='Defaults to env[OS_REGION_NAME]')
|
|
|
|
parser.add_argument('--os_region_name',
|
|
help=argparse.SUPPRESS)
|
|
|
|
#NOTE(bcwaldon): DEPRECATED
|
|
parser.add_argument('-R',
|
|
dest='os_region_name',
|
|
help='DEPRECATED! Use --os-region-name.')
|
|
|
|
parser.add_argument('--os-auth-token',
|
|
default=utils.env('OS_AUTH_TOKEN'),
|
|
help='Defaults to env[OS_AUTH_TOKEN]')
|
|
|
|
parser.add_argument('--os_auth_token',
|
|
help=argparse.SUPPRESS)
|
|
|
|
#NOTE(bcwaldon): DEPRECATED
|
|
parser.add_argument('-A', '--auth_token',
|
|
dest='os_auth_token',
|
|
help='DEPRECATED! Use --os-auth-token.')
|
|
|
|
parser.add_argument('--os-image-url',
|
|
default=utils.env('OS_IMAGE_URL'),
|
|
help='Defaults to env[OS_IMAGE_URL]')
|
|
|
|
parser.add_argument('--os_image_url',
|
|
help=argparse.SUPPRESS)
|
|
|
|
#NOTE(bcwaldon): DEPRECATED
|
|
parser.add_argument('-U', '--url',
|
|
dest='os_image_url',
|
|
help='DEPRECATED! Use --os-image-url.')
|
|
|
|
parser.add_argument('--os-image-api-version',
|
|
default=utils.env('OS_IMAGE_API_VERSION',
|
|
default='1'),
|
|
help='Defaults to env[OS_IMAGE_API_VERSION] or 1')
|
|
|
|
parser.add_argument('--os_image_api_version',
|
|
help=argparse.SUPPRESS)
|
|
|
|
parser.add_argument('--os-service-type',
|
|
default=utils.env('OS_SERVICE_TYPE'),
|
|
help='Defaults to env[OS_SERVICE_TYPE]')
|
|
|
|
parser.add_argument('--os_service_type',
|
|
help=argparse.SUPPRESS)
|
|
|
|
parser.add_argument('--os-endpoint-type',
|
|
default=utils.env('OS_ENDPOINT_TYPE'),
|
|
help='Defaults to env[OS_ENDPOINT_TYPE]')
|
|
|
|
parser.add_argument('--os_endpoint_type',
|
|
help=argparse.SUPPRESS)
|
|
|
|
#NOTE(bcwaldon): DEPRECATED
|
|
parser.add_argument('-S', '--os_auth_strategy',
|
|
help='DEPRECATED! This option is '
|
|
'completely ignored.')
|
|
|
|
return parser
|
|
|
|
def get_subcommand_parser(self, version):
|
|
parser = self.get_base_parser()
|
|
|
|
self.subcommands = {}
|
|
subparsers = parser.add_subparsers(metavar='<subcommand>')
|
|
submodule = utils.import_versioned_module(version, 'shell')
|
|
self._find_actions(subparsers, submodule)
|
|
self._find_actions(subparsers, self)
|
|
|
|
return parser
|
|
|
|
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=HelpFormatter
|
|
)
|
|
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)
|
|
|
|
# TODO(dtroyer): move this into the common client support?
|
|
# Compatibility check to remove API version as the trailing component
|
|
# in a service endpoint; also removes a trailing '/'
|
|
def _strip_version(self, endpoint):
|
|
"""Strip version from the last component of endpoint if present."""
|
|
|
|
# Get rid of trailing '/' if present
|
|
if endpoint.endswith('/'):
|
|
endpoint = endpoint[:-1]
|
|
url_bits = endpoint.split('/')
|
|
# regex to match 'v1' or 'v2.0' etc
|
|
if re.match('v\d+\.?\d*', url_bits[-1]):
|
|
endpoint = '/'.join(url_bits[:-1])
|
|
return endpoint
|
|
|
|
def _get_ksclient(self, **kwargs):
|
|
"""Get an endpoint and auth token from Keystone.
|
|
|
|
:param username: name of user
|
|
:param password: user's password
|
|
:param tenant_id: unique identifier of tenant
|
|
:param tenant_name: name of tenant
|
|
:param auth_url: endpoint to authenticate against
|
|
"""
|
|
return ksclient.Client(username=kwargs.get('username'),
|
|
password=kwargs.get('password'),
|
|
tenant_id=kwargs.get('tenant_id'),
|
|
tenant_name=kwargs.get('tenant_name'),
|
|
auth_url=kwargs.get('auth_url'),
|
|
cacert=kwargs.get('cacert'),
|
|
insecure=kwargs.get('insecure'))
|
|
|
|
def _get_endpoint(self, client, **kwargs):
|
|
"""Get an endpoint using the provided keystone client."""
|
|
endpoint_kwargs = {
|
|
'service_type': kwargs.get('service_type') or 'image',
|
|
'endpoint_type': kwargs.get('endpoint_type') or 'publicURL',
|
|
}
|
|
|
|
if kwargs.get('region_name'):
|
|
endpoint_kwargs['attr'] = 'region'
|
|
endpoint_kwargs['filter_value'] = kwargs.get('region_name')
|
|
|
|
endpoint = client.service_catalog.url_for(**endpoint_kwargs)
|
|
return self._strip_version(endpoint)
|
|
|
|
def _get_image_url(self, args):
|
|
"""Translate the available url-related options into a single string.
|
|
|
|
Return the endpoint that should be used to talk to Glance if a
|
|
clear decision can be made. Otherwise, return None.
|
|
"""
|
|
if args.os_image_url:
|
|
return args.os_image_url
|
|
elif args.host:
|
|
# Check if it is legal ipv6 address, if so, need wrap it with '[]'
|
|
if netaddr.valid_ipv6(args.host):
|
|
args.host = '[%s]' % args.host
|
|
scheme = 'https' if args.use_ssl else 'http'
|
|
return '%s://%s:%s/' % (scheme, args.host, args.port)
|
|
else:
|
|
return None
|
|
|
|
def _get_endpoint_and_token(self, args, force_auth=False):
|
|
image_url = self._get_image_url(args)
|
|
auth_token = args.os_auth_token
|
|
|
|
auth_reqd = force_auth or (utils.is_authentication_required(args.func)
|
|
and not (auth_token and image_url))
|
|
|
|
if not auth_reqd:
|
|
endpoint = image_url
|
|
token = args.os_auth_token
|
|
else:
|
|
if not args.os_username:
|
|
raise exc.CommandError("You must provide a username via"
|
|
" either --os-username or "
|
|
"env[OS_USERNAME]")
|
|
|
|
if not args.os_password:
|
|
raise exc.CommandError("You must provide a password via"
|
|
" either --os-password or "
|
|
"env[OS_PASSWORD]")
|
|
|
|
if not (args.os_tenant_id or args.os_tenant_name):
|
|
raise exc.CommandError("You must provide a tenant_id via"
|
|
" either --os-tenant-id or "
|
|
"via env[OS_TENANT_ID]")
|
|
|
|
if not args.os_auth_url:
|
|
raise exc.CommandError("You must provide an auth url via"
|
|
" either --os-auth-url or "
|
|
"via env[OS_AUTH_URL]")
|
|
kwargs = {
|
|
'username': args.os_username,
|
|
'password': args.os_password,
|
|
'tenant_id': args.os_tenant_id,
|
|
'tenant_name': args.os_tenant_name,
|
|
'auth_url': args.os_auth_url,
|
|
'service_type': args.os_service_type,
|
|
'endpoint_type': args.os_endpoint_type,
|
|
'cacert': args.os_cacert,
|
|
'insecure': args.insecure,
|
|
'region_name': args.os_region_name,
|
|
}
|
|
_ksclient = self._get_ksclient(**kwargs)
|
|
token = args.os_auth_token or _ksclient.auth_token
|
|
|
|
endpoint = args.os_image_url or self._get_endpoint(_ksclient,
|
|
**kwargs)
|
|
|
|
return endpoint, token
|
|
|
|
def _get_versioned_client(self, api_version, args, force_auth=False):
|
|
endpoint, token = self._get_endpoint_and_token(args,
|
|
force_auth=force_auth)
|
|
|
|
kwargs = {
|
|
'token': token,
|
|
'insecure': args.insecure,
|
|
'timeout': args.timeout,
|
|
'cacert': args.os_cacert,
|
|
'cert_file': args.cert_file,
|
|
'key_file': args.key_file,
|
|
'ssl_compression': args.ssl_compression
|
|
}
|
|
client = glanceclient.Client(api_version, endpoint, **kwargs)
|
|
return client
|
|
|
|
def _cache_schema(self, options, home_dir='~/.glanceclient'):
|
|
homedir = expanduser(home_dir)
|
|
if not os.path.exists(homedir):
|
|
os.makedirs(homedir)
|
|
|
|
schema_file_path = homedir + os.sep + "image_schema.json"
|
|
|
|
if (not os.path.exists(schema_file_path)) or options.get_schema:
|
|
try:
|
|
client = self._get_versioned_client('2', options,
|
|
force_auth=True)
|
|
schema = client.schemas.get("image")
|
|
|
|
with file(schema_file_path, 'w') as f:
|
|
f.write(json.dumps(schema.raw()))
|
|
except Exception as e:
|
|
#NOTE(esheffield) do nothing here, we'll get a message later
|
|
#if the schema is missing
|
|
pass
|
|
|
|
def main(self, argv):
|
|
# Parse args once to find version
|
|
parser = self.get_base_parser()
|
|
(options, args) = parser.parse_known_args(argv)
|
|
|
|
# build available subcommands based on version
|
|
api_version = options.os_image_api_version
|
|
|
|
if api_version == '2':
|
|
self._cache_schema(options)
|
|
|
|
subcommand_parser = self.get_subcommand_parser(api_version)
|
|
self.parser = subcommand_parser
|
|
|
|
# Handle top-level --help/-h before attempting to parse
|
|
# a command off the command line
|
|
if options.help or not argv:
|
|
self.do_help(options)
|
|
return 0
|
|
|
|
# Parse args again and call whatever callback was selected
|
|
args = subcommand_parser.parse_args(argv)
|
|
|
|
# Short-circuit and deal with help command right away.
|
|
if args.func == self.do_help:
|
|
self.do_help(args)
|
|
return 0
|
|
|
|
LOG = logging.getLogger('glanceclient')
|
|
LOG.addHandler(logging.StreamHandler())
|
|
LOG.setLevel(logging.DEBUG if args.debug else logging.INFO)
|
|
|
|
client = self._get_versioned_client(api_version, args,
|
|
force_auth=False)
|
|
|
|
try:
|
|
args.func(client, args)
|
|
except exc.Unauthorized:
|
|
raise exc.CommandError("Invalid OpenStack Identity credentials.")
|
|
|
|
@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 getattr(args, 'command', None):
|
|
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()
|
|
|
|
|
|
class HelpFormatter(argparse.HelpFormatter):
|
|
def start_section(self, heading):
|
|
# Title-case the headings
|
|
heading = '%s%s' % (heading[0].upper(), heading[1:])
|
|
super(HelpFormatter, self).start_section(heading)
|
|
|
|
|
|
def main():
|
|
try:
|
|
OpenStackImagesShell().main(map(strutils.safe_decode, sys.argv[1:]))
|
|
except KeyboardInterrupt:
|
|
print('... terminating glance client', file=sys.stderr)
|
|
sys.exit(1)
|
|
except Exception as e:
|
|
print(utils.exception_to_str(e), file=sys.stderr)
|
|
sys.exit(1)
|