Matt Riedemann
b562790fc4
The 2.3 microversion used the OS-EXT-SRV-ATTR prefix for compat with v2.0 for the ec2 API split out of nova. The 2.16 microversion added the 'host_status' extended server attribute and doesn't use the prefix. This adds a note that nothing after the 2.3 microversion should be using the OS-EXT-SRV-ATTR prefix since it's an artifact of v2.0 and extensions which are deprecated in v2.1. Similar notes are added for other extensions that add extended attribute names to other resources like AZs, volumes and images. Change-Id: I60a53e13121b7280a41c3889ba86edcd2ae7bf83
120 lines
5.0 KiB
Python
120 lines
5.0 KiB
Python
# Copyright 2012 OpenStack Foundation
|
|
#
|
|
# 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.
|
|
|
|
"""The Extended Server Attributes API extension."""
|
|
|
|
from nova.api.openstack import api_version_request
|
|
from nova.api.openstack import extensions
|
|
from nova.api.openstack import wsgi
|
|
from nova import compute
|
|
|
|
ALIAS = "os-extended-server-attributes"
|
|
authorize = extensions.os_compute_soft_authorizer(ALIAS)
|
|
soft_authorize = extensions.os_compute_soft_authorizer('servers')
|
|
|
|
|
|
class ExtendedServerAttributesController(wsgi.Controller):
|
|
def __init__(self, *args, **kwargs):
|
|
super(ExtendedServerAttributesController, self).__init__(*args,
|
|
**kwargs)
|
|
self.compute_api = compute.API(skip_policy_check=True)
|
|
|
|
def _extend_server(self, context, server, instance, req):
|
|
key = "OS-EXT-SRV-ATTR:hypervisor_hostname"
|
|
server[key] = instance.node
|
|
|
|
properties = ['host', 'name']
|
|
if api_version_request.is_supported(req, min_version='2.3'):
|
|
# NOTE(mriedem): These will use the OS-EXT-SRV-ATTR prefix below
|
|
# and that's OK for microversion 2.3 which is being compatible
|
|
# with v2.0 for the ec2 API split out from Nova. After this,
|
|
# however, new microversoins should not be using the
|
|
# OS-EXT-SRV-ATTR prefix.
|
|
properties += ['reservation_id', 'launch_index',
|
|
'hostname', 'kernel_id', 'ramdisk_id',
|
|
'root_device_name', 'user_data']
|
|
for attr in properties:
|
|
if attr == 'name':
|
|
key = "OS-EXT-SRV-ATTR:instance_%s" % attr
|
|
else:
|
|
# NOTE(mriedem): Nothing after microversion 2.3 should use the
|
|
# OS-EXT-SRV-ATTR prefix for the attribute key name.
|
|
key = "OS-EXT-SRV-ATTR:%s" % attr
|
|
server[key] = instance[attr]
|
|
|
|
def _server_host_status(self, context, server, instance, req):
|
|
host_status = self.compute_api.get_instance_host_status(instance)
|
|
server['host_status'] = host_status
|
|
|
|
@wsgi.extends
|
|
def show(self, req, resp_obj, id):
|
|
context = req.environ['nova.context']
|
|
authorize_extend = False
|
|
authorize_host_status = False
|
|
if authorize(context):
|
|
authorize_extend = True
|
|
if (api_version_request.is_supported(req, min_version='2.16') and
|
|
soft_authorize(context, action='show:host_status')):
|
|
authorize_host_status = True
|
|
if authorize_extend or authorize_host_status:
|
|
server = resp_obj.obj['server']
|
|
db_instance = req.get_db_instance(server['id'])
|
|
# server['id'] is guaranteed to be in the cache due to
|
|
# the core API adding it in its 'show' method.
|
|
if authorize_extend:
|
|
self._extend_server(context, server, db_instance, req)
|
|
if authorize_host_status:
|
|
self._server_host_status(context, server, db_instance, req)
|
|
|
|
@wsgi.extends
|
|
def detail(self, req, resp_obj):
|
|
context = req.environ['nova.context']
|
|
authorize_extend = False
|
|
authorize_host_status = False
|
|
if authorize(context):
|
|
authorize_extend = True
|
|
if (api_version_request.is_supported(req, min_version='2.16') and
|
|
soft_authorize(context, action='show:host_status')):
|
|
authorize_host_status = True
|
|
if authorize_extend or authorize_host_status:
|
|
servers = list(resp_obj.obj['servers'])
|
|
instances = req.get_db_instances()
|
|
# Instances is guaranteed to be in the cache due to
|
|
# the core API adding it in its 'detail' method.
|
|
if authorize_host_status:
|
|
host_statuses = self.compute_api.get_instances_host_statuses(
|
|
instances.values())
|
|
for server in servers:
|
|
if authorize_extend:
|
|
instance = instances[server['id']]
|
|
self._extend_server(context, server, instance, req)
|
|
if authorize_host_status:
|
|
server['host_status'] = host_statuses[server['id']]
|
|
|
|
|
|
class ExtendedServerAttributes(extensions.V21APIExtensionBase):
|
|
"""Extended Server Attributes support."""
|
|
|
|
name = "ExtendedServerAttributes"
|
|
alias = ALIAS
|
|
version = 1
|
|
|
|
def get_controller_extensions(self):
|
|
controller = ExtendedServerAttributesController()
|
|
extension = extensions.ControllerExtension(self, 'servers', controller)
|
|
return [extension]
|
|
|
|
def get_resources(self):
|
|
return []
|