tacker/tacker/vm/vim_client.py

129 lines
4.8 KiB
Python

# Copyright 2015-2016 Brocade Communications Systems Ine 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 os
from cryptography.fernet import Fernet
from oslo_config import cfg
from oslo_log import log as logging
from oslo_log import versionutils
from tacker.extensions import nfvo
from tacker import manager
from tacker.plugins.common import constants
LOG = logging.getLogger(__name__)
CONF = cfg.CONF
OPTS = [
cfg.StrOpt(
'default_vim', help=_('Default VIM for launching VNFs. '
'This option is deprecated and will be removed in Ocata release.'),
deprecated_for_removal=True)
]
cfg.CONF.register_opts(OPTS, 'nfvo_vim')
def config_opts():
return [('nfvo_vim', OPTS)]
class VimClient(object):
def get_vim(self, context, vim_id=None, region_name=None):
"""Get Vim information for provided VIM id
Initiate the NFVO plugin, request VIM information for the provided
VIM id and validate region
"""
nfvo_plugin = manager.TackerManager.get_service_plugins().get(
constants.NFVO)
if not vim_id:
LOG.debug(_('VIM id not provided. Attempting to find default '
'VIM id'))
try:
vim_info = nfvo_plugin.get_default_vim(context)
except Exception:
LOG.debug(_('Default vim not set in db.'
'Attempting to find default vim from tacker.conf'))
vim_name = cfg.CONF.nfvo_vim.default_vim
if not vim_name:
raise nfvo.VimDefaultNameNotDefined()
versionutils.report_deprecated_feature(LOG, 'Configuration of '
'default-vim in tacker.conf is deprecated and will be '
'removed in Newton cycle')
vim_info = self._get_default_vim_by_name(context,
nfvo_plugin,
vim_name)
else:
try:
vim_info = nfvo_plugin.get_vim(context, vim_id,
mask_password=False)
except Exception:
raise nfvo.VimNotFoundException(vim_id=vim_id)
LOG.debug(_('VIM info found for vim id %s'), vim_id)
if region_name and not self.region_valid(vim_info['placement_attr']
['regions'], region_name):
raise nfvo.VimRegionNotFoundException(region_name=region_name)
vim_auth = self._build_vim_auth(vim_info)
vim_res = {'vim_auth': vim_auth, 'vim_id': vim_info['id'],
'vim_name': vim_info.get('name', vim_info['id'])}
return vim_res
@staticmethod
def region_valid(vim_regions, region_name):
return region_name in vim_regions
# Deprecated. Will be removed in Ocata release
def _get_default_vim_by_name(self, context, plugin, vim_name):
try:
vim_info = plugin.get_vim_by_name(context, vim_name,
mask_password=False)
except Exception:
raise nfvo.VimDefaultIdException(vim_name=vim_name)
return vim_info
def _build_vim_auth(self, vim_info):
LOG.debug('VIM id is %s', vim_info['id'])
vim_auth = vim_info['auth_cred']
vim_auth['password'] = self._decode_vim_auth(vim_info['id'],
vim_auth[
'password'].encode(
'utf-8'))
vim_auth['auth_url'] = vim_info['auth_url']
return vim_auth
def _decode_vim_auth(self, vim_id, cred):
"""Decode Vim credentials
Decrypt VIM cred. using Fernet Key
"""
vim_key = self._find_vim_key(vim_id)
f = Fernet(vim_key)
if not f:
LOG.warn(_('Unable to decode VIM auth'))
raise nfvo.VimNotFoundException('Unable to decode VIM auth key')
return f.decrypt(cred)
@staticmethod
def _find_vim_key(vim_id):
key_file = os.path.join(CONF.vim_keys.openstack, vim_id)
LOG.debug(_('Attempting to open key file for vim id %s'), vim_id)
with open(key_file, 'r') as f:
return f.read()
LOG.warn(_('VIM id invalid or key not found for %s'), vim_id)