119 lines
4.6 KiB
Python
119 lines
4.6 KiB
Python
# Copyright 2016 Huawei Technologies Co.,LTD.
|
|
# 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.
|
|
|
|
import ironicclient as ironic
|
|
from ironicclient import exc as ironic_exc
|
|
from keystoneauth1 import loading as ks_loading
|
|
from oslo_config import cfg
|
|
from oslo_log import log as logging
|
|
|
|
from mogan.common import exception
|
|
from mogan.common.i18n import _
|
|
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
CONF = cfg.CONF
|
|
|
|
# The API version required by the Ironic driver
|
|
IRONIC_API_VERSION = (1, 29)
|
|
|
|
|
|
class IronicClientWrapper(object):
|
|
"""Ironic client wrapper class that encapsulates authentication logic."""
|
|
|
|
def __init__(self):
|
|
"""Initialise the IronicClientWrapper for use."""
|
|
self._cached_client = None
|
|
|
|
def _get_auth_plugin(self):
|
|
"""Load an auth plugin from CONF options."""
|
|
# If an auth plugin name is defined in `auth_type` option of [ironic]
|
|
# group, register its options and load it.
|
|
auth_plugin = ks_loading.load_auth_from_conf_options(CONF, 'ironic')
|
|
|
|
return auth_plugin
|
|
|
|
def _get_client(self, retry_on_conflict=True):
|
|
max_retries = CONF.ironic.api_max_retries if retry_on_conflict else 1
|
|
retry_interval = (CONF.ironic.api_retry_interval
|
|
if retry_on_conflict else 0)
|
|
|
|
# If we've already constructed a valid, authed client, just return
|
|
# that.
|
|
if retry_on_conflict and self._cached_client is not None:
|
|
return self._cached_client
|
|
|
|
auth_plugin = self._get_auth_plugin()
|
|
|
|
sess = ks_loading.load_session_from_conf_options(CONF,
|
|
'ironic',
|
|
auth=auth_plugin)
|
|
|
|
ironic_url = (CONF.ironic.api_endpoint
|
|
if CONF.ironic.api_endpoint else None)
|
|
# Retries for Conflict exception
|
|
kwargs = {}
|
|
kwargs['max_retries'] = max_retries
|
|
kwargs['retry_interval'] = retry_interval
|
|
kwargs['os_ironic_api_version'] = '%d.%d' % IRONIC_API_VERSION
|
|
try:
|
|
cli = ironic.client.get_client(IRONIC_API_VERSION[0],
|
|
ironic_url=ironic_url,
|
|
session=sess, **kwargs)
|
|
# Cache the client so we don't have to reconstruct and
|
|
# reauthenticate it every time we need it.
|
|
if retry_on_conflict:
|
|
self._cached_client = cli
|
|
|
|
except ironic_exc.Unauthorized:
|
|
msg = _("Unable to authenticate Ironic client.")
|
|
LOG.error(msg)
|
|
raise exception.MoganException(msg)
|
|
|
|
return cli
|
|
|
|
def _multi_getattr(self, obj, attr):
|
|
"""Support nested attribute path for getattr().
|
|
|
|
:param obj: Root object.
|
|
:param attr: Path of final attribute to get. E.g., "a.b.c.d"
|
|
|
|
:returns: The value of the final named attribute.
|
|
:raises AttributeError: will be raised if the path is invalid.
|
|
"""
|
|
for attribute in attr.split("."):
|
|
obj = getattr(obj, attribute)
|
|
return obj
|
|
|
|
def call(self, method, *args, **kwargs):
|
|
"""Call an Ironic client method and retry on stale token.
|
|
|
|
:param method: Name of the client method to call as a string.
|
|
:param args: Client method arguments.
|
|
:param kwargs: Client method keyword arguments.
|
|
:param retry_on_conflict: Boolean value. Whether the request should be
|
|
retried in case of a conflict error
|
|
(HTTP 409) or not. If retry_on_conflict is
|
|
False the cached server of the client
|
|
won't be used. Defaults to True.
|
|
"""
|
|
retry_on_conflict = kwargs.pop('retry_on_conflict', True)
|
|
|
|
# authentication retry for token expiration is handled in keystone
|
|
# session, other retries are handled by ironicclient starting with
|
|
# 0.8.0
|
|
client = self._get_client(retry_on_conflict=retry_on_conflict)
|
|
return self._multi_getattr(client, method)(*args, **kwargs)
|