120 lines
4.5 KiB
Python
120 lines
4.5 KiB
Python
# coding=utf-8
|
|
#
|
|
# Copyright 2014 Hewlett-Packard Development Company, L.P.
|
|
# 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 time
|
|
|
|
from nova import exception
|
|
from nova.openstack.common.gettextutils import _
|
|
from nova.openstack.common import importutils
|
|
from nova.openstack.common import log as logging
|
|
from oslo.config import cfg
|
|
|
|
|
|
ironic = None
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
CONF = cfg.CONF
|
|
|
|
|
|
class IronicClientWrapper(object):
|
|
"""Ironic client wrapper class that encapsulates retry logic."""
|
|
|
|
def __init__(self):
|
|
"""Initialise the IronicClientWrapper for use.
|
|
|
|
Initialise IronicClientWrapper by loading ironicclient
|
|
dynamically so that ironicclient is not a dependency for
|
|
Nova.
|
|
"""
|
|
global ironic
|
|
if ironic is None:
|
|
ironic = importutils.import_module('ironicclient')
|
|
# NOTE(deva): work around a lack of symbols in the current version.
|
|
if not hasattr(ironic, 'exc'):
|
|
ironic.exc = importutils.import_module('ironicclient.exc')
|
|
if not hasattr(ironic, 'client'):
|
|
ironic.client = importutils.import_module(
|
|
'ironicclient.client')
|
|
|
|
def _get_client(self):
|
|
# TODO(deva): save and reuse existing client & auth token
|
|
# until it expires or is no longer valid
|
|
auth_token = CONF.ironic.admin_auth_token
|
|
if auth_token is None:
|
|
kwargs = {'os_username': CONF.ironic.admin_username,
|
|
'os_password': CONF.ironic.admin_password,
|
|
'os_auth_url': CONF.ironic.admin_url,
|
|
'os_tenant_name': CONF.ironic.admin_tenant_name,
|
|
'os_service_type': 'baremetal',
|
|
'os_endpoint_type': 'public',
|
|
'ironic_url': CONF.ironic.api_endpoint}
|
|
else:
|
|
kwargs = {'os_auth_token': auth_token,
|
|
'ironic_url': CONF.ironic.api_endpoint}
|
|
|
|
try:
|
|
cli = ironic.client.get_client(CONF.ironic.api_version, **kwargs)
|
|
except ironic.exc.Unauthorized:
|
|
msg = _("Unable to authenticate Ironic client.")
|
|
LOG.error(msg)
|
|
raise exception.NovaException(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 errors.
|
|
|
|
:param method: Name of the client method to call as a string.
|
|
:param args: Client method arguments.
|
|
:param kwargs: Client method keyword arguments.
|
|
|
|
:raises: NovaException if all retries failed.
|
|
"""
|
|
retry_excs = (ironic.exc.ServiceUnavailable,
|
|
ironic.exc.ConnectionRefused,
|
|
ironic.exc.Conflict)
|
|
num_attempts = CONF.ironic.api_max_retries
|
|
|
|
for attempt in range(1, num_attempts + 1):
|
|
client = self._get_client()
|
|
try:
|
|
return self._multi_getattr(client, method)(*args, **kwargs)
|
|
except retry_excs:
|
|
msg = (_("Error contacting Ironic server for '%(method)s'. "
|
|
"Attempt %(attempt)d of %(total)d")
|
|
% {'method': method,
|
|
'attempt': attempt,
|
|
'total': num_attempts})
|
|
if attempt == num_attempts:
|
|
LOG.error(msg)
|
|
raise exception.NovaException(msg)
|
|
LOG.warning(msg)
|
|
time.sleep(CONF.ironic.api_retry_interval)
|