5b01c8f2ba
In order to provide insight into the remote API verison, we need the ability to negotiate upon the latest API version available, and then report what that version is. In order to understand if this has occured, we also need to provide insight into if version negotiation has occured. Adds logic to the session/http clients to faciltate version negotiation on the latest available version, and provide user insight into that verison. Change-Id: I813237eee4b122211f95558f677b25e0675569d5 Related-Bug: #1739440 Related-Bug: #1671145
135 lines
4.9 KiB
Python
135 lines
4.9 KiB
Python
#
|
|
# Copyright 2015 Red Hat, Inc.
|
|
#
|
|
# 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.
|
|
#
|
|
|
|
"""OpenStackClient plugin for Bare Metal service."""
|
|
|
|
import argparse
|
|
import logging
|
|
|
|
from ironicclient.common import http
|
|
from osc_lib import utils
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
CLIENT_CLASS = 'ironicclient.v1.client.Client'
|
|
API_VERSION_OPTION = 'os_baremetal_api_version'
|
|
API_NAME = 'baremetal'
|
|
# NOTE(TheJulia) Latest known version tracking has been moved
|
|
# to the ironicclient/common/http.py file as the OSC committment
|
|
# is latest known, and we should only store it in one location.
|
|
LAST_KNOWN_API_VERSION = http.LAST_KNOWN_API_VERSION
|
|
LATEST_VERSION = http.LATEST_VERSION
|
|
|
|
|
|
API_VERSIONS = {
|
|
'1.%d' % i: CLIENT_CLASS
|
|
for i in range(1, LAST_KNOWN_API_VERSION + 1)
|
|
}
|
|
API_VERSIONS['1'] = CLIENT_CLASS
|
|
# NOTE(dtantsur): flag to indicate that the requested version was "latest".
|
|
# Due to how OSC works we cannot just add "latest" to the list of supported
|
|
# versions - it breaks the major version detection.
|
|
OS_BAREMETAL_API_LATEST = True
|
|
|
|
|
|
def make_client(instance):
|
|
"""Returns a baremetal service client."""
|
|
requested_api_version = instance._api_version[API_NAME]
|
|
|
|
baremetal_client_class = utils.get_client_class(
|
|
API_NAME,
|
|
requested_api_version,
|
|
API_VERSIONS)
|
|
LOG.debug('Instantiating baremetal client: %s', baremetal_client_class)
|
|
LOG.debug('Baremetal API version: %s',
|
|
requested_api_version if not OS_BAREMETAL_API_LATEST
|
|
else "latest")
|
|
|
|
if requested_api_version == '1':
|
|
# NOTE(dtantsur): '1' means 'the latest v1 API version'. Since we don't
|
|
# have other major versions, it's identical to 'latest'.
|
|
requested_api_version = LATEST_VERSION
|
|
allow_api_version_downgrade = True
|
|
else:
|
|
allow_api_version_downgrade = OS_BAREMETAL_API_LATEST
|
|
|
|
client = baremetal_client_class(
|
|
os_ironic_api_version=requested_api_version,
|
|
# NOTE(dtantsur): enable re-negotiation of the latest version, if CLI
|
|
# latest is too high for the server we're talking to.
|
|
allow_api_version_downgrade=allow_api_version_downgrade,
|
|
session=instance.session,
|
|
region_name=instance._region_name,
|
|
# NOTE(vdrok): This will be set as endpoint_override, and the Client
|
|
# class will be able to do the version stripping if needed
|
|
endpoint=instance.get_endpoint_for_service_type(
|
|
API_NAME, interface=instance.interface,
|
|
region_name=instance._region_name
|
|
)
|
|
)
|
|
return client
|
|
|
|
|
|
def build_option_parser(parser):
|
|
"""Hook to add global options."""
|
|
parser.add_argument(
|
|
'--os-baremetal-api-version',
|
|
metavar='<baremetal-api-version>',
|
|
default=_get_environment_version("latest"),
|
|
choices=sorted(
|
|
API_VERSIONS,
|
|
key=lambda k: [int(x) for x in k.split('.')]) + ['latest'],
|
|
action=ReplaceLatestVersion,
|
|
help='Bare metal API version, default="latest" (the maximum version '
|
|
'supported by both the client and the server). '
|
|
'(Env: OS_BAREMETAL_API_VERSION)',
|
|
)
|
|
return parser
|
|
|
|
|
|
def _get_environment_version(default):
|
|
global OS_BAREMETAL_API_LATEST
|
|
env_value = utils.env('OS_BAREMETAL_API_VERSION')
|
|
if not env_value:
|
|
env_value = default
|
|
if env_value == 'latest':
|
|
env_value = LATEST_VERSION
|
|
else:
|
|
OS_BAREMETAL_API_LATEST = False
|
|
return env_value
|
|
|
|
|
|
class ReplaceLatestVersion(argparse.Action):
|
|
"""Replaces `latest` keyword by last known version.
|
|
|
|
OSC cannot accept the literal "latest" as a supported API version as it
|
|
breaks the major version detection (OSC tries to load configuration options
|
|
from setuptools entrypoint openstack.baremetal.vlatest). This action
|
|
replaces "latest" with the latest known version, and sets the global
|
|
OS_BAREMETAL_API_LATEST flag appropriately.
|
|
"""
|
|
def __call__(self, parser, namespace, values, option_string=None):
|
|
global OS_BAREMETAL_API_LATEST
|
|
if values == 'latest':
|
|
values = LATEST_VERSION
|
|
# The default value of "True" may have been overriden due to
|
|
# non-empty OS_BAREMETAL_API_VERSION env variable. If a user
|
|
# explicitly requests "latest", we need to correct it.
|
|
OS_BAREMETAL_API_LATEST = True
|
|
else:
|
|
OS_BAREMETAL_API_LATEST = False
|
|
setattr(namespace, self.dest, values)
|