0905c41f07
This commit adds version discovery when user doesn't explicitly request a version or request the latest version. The latest version means the most recently version between server and client. Change-Id: I17be26342add9e9f4e3c384cc4aad613902e04a9 Implements: blueprint api-version-negotiation
104 lines
3.6 KiB
Python
104 lines
3.6 KiB
Python
# 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 argparse
|
|
from oslo_log import log as logging
|
|
|
|
from osc_lib import utils
|
|
|
|
from zunclient import api_versions
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
DEFAULT_CONTAINER_API_VERSION = api_versions.DEFAULT_API_VERSION
|
|
API_VERSION_OPTION = "os_container_api_version"
|
|
API_NAME = "container"
|
|
CLIENT_CLASS = 'zunclient.v1.client.Client'
|
|
LAST_KNOWN_API_VERSION = int(api_versions.MAX_API_VERSION.split('.')[1])
|
|
API_VERSIONS = {
|
|
'1.%d' % i: CLIENT_CLASS
|
|
for i in range(1, LAST_KNOWN_API_VERSION + 1)
|
|
}
|
|
API_VERSIONS['1'] = CLIENT_CLASS
|
|
|
|
|
|
def make_client(instance):
|
|
"""Returns a zun service client"""
|
|
requested_api_version = instance._api_version[API_NAME]
|
|
|
|
zun_client = utils.get_client_class(
|
|
API_NAME,
|
|
requested_api_version,
|
|
API_VERSIONS)
|
|
LOG.debug("Instantiating zun client: {0}".format(
|
|
zun_client))
|
|
|
|
api_version = api_versions.get_api_version(requested_api_version)
|
|
if api_version.is_latest():
|
|
client = zun_client(
|
|
region_name=instance._region_name,
|
|
session=instance.session,
|
|
service_type='container',
|
|
api_version=api_versions.APIVersion("1.1"),
|
|
)
|
|
api_version = api_versions.discover_version(client, api_version)
|
|
|
|
client = zun_client(
|
|
region_name=instance._region_name,
|
|
session=instance.session,
|
|
service_type='container',
|
|
api_version=api_version,
|
|
)
|
|
return client
|
|
|
|
|
|
def build_option_parser(parser):
|
|
"""Hook to add global options"""
|
|
parser.add_argument(
|
|
'--os-container-api-version',
|
|
metavar='<container-api-version>',
|
|
default=_get_environment_version(DEFAULT_CONTAINER_API_VERSION),
|
|
action=ReplaceLatestVersion,
|
|
choices=sorted(
|
|
API_VERSIONS,
|
|
key=lambda k: [int(x) for x in k.split('.')]) + ['1.latest'],
|
|
help=("Container API version, default={0}"
|
|
"(Env:OS_CONTAINER_API_VERSION)").format(
|
|
DEFAULT_CONTAINER_API_VERSION))
|
|
return parser
|
|
|
|
|
|
def _get_environment_version(default):
|
|
env_value = utils.env('OS_CONTAINER_API_VERSION') or default
|
|
latest = env_value == '1.latest'
|
|
if latest:
|
|
# NOTE(hongbin): '1.latest' means enabling negotiation of the
|
|
# latest version between server and client but due to how OSC works
|
|
# we cannot just add "1.latest" to the list of supported versions.
|
|
# Use '1' in this case.
|
|
env_value = '1'
|
|
return env_value
|
|
|
|
|
|
class ReplaceLatestVersion(argparse.Action):
|
|
"""Replaces `latest` keyword by last known version."""
|
|
|
|
def __call__(self, parser, namespace, values, option_string=None):
|
|
latest = values == '1.latest'
|
|
if latest:
|
|
# NOTE(hongbin): '1.latest' means enabling negotiation of the
|
|
# latest version between server and client but due to how OSC works
|
|
# we cannot just add "1.latest" to the list of supported versions.
|
|
# Use '1' in this case.
|
|
values = '1'
|
|
setattr(namespace, self.dest, values)
|