194 lines
7.3 KiB
Python
194 lines
7.3 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.
|
|
|
|
# Mostly copied from ironic/common/swift.py
|
|
|
|
import json
|
|
|
|
from oslo_config import cfg
|
|
from oslo_log import log
|
|
from swiftclient import client as swift_client
|
|
from swiftclient import exceptions as swift_exceptions
|
|
|
|
from ironic_inspector.common.i18n import _
|
|
from ironic_inspector import utils
|
|
|
|
CONF = cfg.CONF
|
|
|
|
|
|
LOG = log.getLogger('ironic_inspector.common.swift')
|
|
|
|
|
|
SWIFT_OPTS = [
|
|
cfg.IntOpt('max_retries',
|
|
default=2,
|
|
help='Maximum number of times to retry a Swift request, '
|
|
'before failing.'),
|
|
cfg.IntOpt('delete_after',
|
|
default=0,
|
|
help='Number of seconds that the Swift object will last before '
|
|
'being deleted. (set to 0 to never delete the object).'),
|
|
cfg.StrOpt('container',
|
|
default='ironic-inspector',
|
|
help='Default Swift container to use when creating objects.'),
|
|
cfg.StrOpt('username',
|
|
default='',
|
|
help='User name for accessing Swift API.'),
|
|
cfg.StrOpt('password',
|
|
default='',
|
|
help='Password for accessing Swift API.',
|
|
secret=True),
|
|
cfg.StrOpt('tenant_name',
|
|
default='',
|
|
help='Tenant name for accessing Swift API.'),
|
|
cfg.StrOpt('os_auth_version',
|
|
default='2',
|
|
help='Keystone authentication API version'),
|
|
cfg.StrOpt('os_auth_url',
|
|
default='',
|
|
help='Keystone authentication URL'),
|
|
cfg.StrOpt('os_service_type',
|
|
default='object-store',
|
|
help='Swift service type.'),
|
|
cfg.StrOpt('os_endpoint_type',
|
|
default='internalURL',
|
|
help='Swift endpoint type.'),
|
|
]
|
|
|
|
|
|
def list_opts():
|
|
return [
|
|
('swift', SWIFT_OPTS)
|
|
]
|
|
|
|
CONF.register_opts(SWIFT_OPTS, group='swift')
|
|
|
|
OBJECT_NAME_PREFIX = 'inspector_data'
|
|
|
|
|
|
class SwiftAPI(object):
|
|
"""API for communicating with Swift."""
|
|
|
|
def __init__(self,
|
|
user=CONF.swift.username,
|
|
tenant_name=CONF.swift.tenant_name,
|
|
key=CONF.swift.password,
|
|
auth_url=CONF.swift.os_auth_url,
|
|
auth_version=CONF.swift.os_auth_version,
|
|
service_type=CONF.swift.os_service_type,
|
|
endpoint_type=CONF.swift.os_endpoint_type):
|
|
"""Constructor for creating a SwiftAPI object.
|
|
|
|
:param user: the name of the user for Swift account
|
|
:param tenant_name: the name of the tenant for Swift account
|
|
:param key: the 'password' or key to authenticate with
|
|
:param auth_url: the url for authentication
|
|
:param auth_version: the version of api to use for authentication
|
|
"""
|
|
params = {'retries': CONF.swift.max_retries,
|
|
'user': user,
|
|
'tenant_name': tenant_name,
|
|
'key': key,
|
|
'authurl': auth_url,
|
|
'auth_version': auth_version,
|
|
'os_options': {'service_type': service_type,
|
|
'endpoint_type': endpoint_type}}
|
|
|
|
self.connection = swift_client.Connection(**params)
|
|
|
|
def create_object(self, object, data, container=CONF.swift.container,
|
|
headers=None):
|
|
"""Uploads a given string to Swift.
|
|
|
|
:param object: The name of the object in Swift
|
|
:param data: string data to put in the object
|
|
:param container: The name of the container for the object.
|
|
:param headers: the headers for the object to pass to Swift
|
|
:returns: The Swift UUID of the object
|
|
:raises: utils.Error, if any operation with Swift fails.
|
|
"""
|
|
try:
|
|
self.connection.put_container(container)
|
|
except swift_exceptions.ClientException as e:
|
|
err_msg = (_('Swift failed to create container %(container)s. '
|
|
'Error was: %(error)s') %
|
|
{'container': container, 'error': e})
|
|
raise utils.Error(err_msg)
|
|
|
|
if CONF.swift.delete_after > 0:
|
|
headers = headers or {}
|
|
headers['X-Delete-After'] = CONF.swift.delete_after
|
|
|
|
try:
|
|
obj_uuid = self.connection.put_object(container,
|
|
object,
|
|
data,
|
|
headers=headers)
|
|
except swift_exceptions.ClientException as e:
|
|
err_msg = (_('Swift failed to create object %(object)s in '
|
|
'container %(container)s. Error was: %(error)s') %
|
|
{'object': object, 'container': container, 'error': e})
|
|
raise utils.Error(err_msg)
|
|
|
|
return obj_uuid
|
|
|
|
def get_object(self, object, container=CONF.swift.container):
|
|
"""Downloads a given object from Swift.
|
|
|
|
:param object: The name of the object in Swift
|
|
:param container: The name of the container for the object.
|
|
:returns: Swift object
|
|
:raises: utils.Error, if the Swift operation fails.
|
|
"""
|
|
try:
|
|
headers, obj = self.connection.get_object(container, object)
|
|
except swift_exceptions.ClientException as e:
|
|
err_msg = (_('Swift failed to get object %(object)s in '
|
|
'container %(container)s. Error was: %(error)s') %
|
|
{'object': object, 'container': container, 'error': e})
|
|
raise utils.Error(err_msg)
|
|
|
|
return obj
|
|
|
|
|
|
def store_introspection_data(data, uuid):
|
|
"""Uploads introspection data to Swift.
|
|
|
|
:param data: data to store in Swift
|
|
:param uuid: UUID of the Ironic node that the data came from
|
|
:returns: name of the Swift object that the data is stored in
|
|
"""
|
|
swift_api = SwiftAPI(user=CONF.swift.username,
|
|
tenant_name=CONF.swift.tenant_name,
|
|
key=CONF.swift.password,
|
|
auth_url=CONF.swift.os_auth_url,
|
|
auth_version=CONF.swift.os_auth_version)
|
|
swift_object_name = '%s-%s' % (OBJECT_NAME_PREFIX, uuid)
|
|
swift_api.create_object(swift_object_name, json.dumps(data))
|
|
return swift_object_name
|
|
|
|
|
|
def get_introspection_data(uuid):
|
|
"""Downloads introspection data from Swift.
|
|
|
|
:param uuid: UUID of the Ironic node that the data came from
|
|
:returns: Swift object with the introspection data
|
|
"""
|
|
swift_api = SwiftAPI(user=CONF.swift.username,
|
|
tenant_name=CONF.swift.tenant_name,
|
|
key=CONF.swift.password,
|
|
auth_url=CONF.swift.os_auth_url,
|
|
auth_version=CONF.swift.os_auth_version)
|
|
swift_object_name = '%s-%s' % (OBJECT_NAME_PREFIX, uuid)
|
|
return swift_api.get_object(swift_object_name)
|