3af149cfef
The following patch syncs the volume object to match the ORM. More specifically, it adds metadata, admin_metdata, volume_attachment, and volume_type to the volume object. These fields are required to convert cinder internals to use volume versionedobject. It was originally part of a large patch, but is broken up to make reviews more bearable. Change-Id: I80c1734072cb26acbe207914e812a3b169b69dfb Partial-Implements: blueprint cinder-objects
311 lines
13 KiB
Python
311 lines
13 KiB
Python
# Copyright 2015 SimpliVity Corp.
|
|
#
|
|
# 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.
|
|
|
|
from oslo_config import cfg
|
|
from oslo_log import log as logging
|
|
from oslo_versionedobjects import fields
|
|
|
|
from cinder import db
|
|
from cinder import exception
|
|
from cinder.i18n import _
|
|
from cinder import objects
|
|
from cinder.objects import base
|
|
from cinder import utils
|
|
|
|
CONF = cfg.CONF
|
|
OPTIONAL_FIELDS = ['metadata', 'admin_metadata',
|
|
'volume_type', 'volume_attachment']
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
@base.CinderObjectRegistry.register
|
|
class Volume(base.CinderPersistentObject, base.CinderObject,
|
|
base.CinderObjectDictCompat, base.CinderComparableObject):
|
|
# Version 1.0: Initial version
|
|
# Version 1.1: Added metadata, admin_metadata, volume_attachment, and
|
|
# volume_type
|
|
VERSION = '1.1'
|
|
|
|
fields = {
|
|
'id': fields.UUIDField(),
|
|
'_name_id': fields.UUIDField(nullable=True),
|
|
'ec2_id': fields.UUIDField(nullable=True),
|
|
'user_id': fields.UUIDField(nullable=True),
|
|
'project_id': fields.UUIDField(nullable=True),
|
|
|
|
'snapshot_id': fields.UUIDField(nullable=True),
|
|
|
|
'host': fields.StringField(nullable=True),
|
|
'size': fields.IntegerField(),
|
|
'availability_zone': fields.StringField(),
|
|
'status': fields.StringField(),
|
|
'attach_status': fields.StringField(),
|
|
'migration_status': fields.StringField(nullable=True),
|
|
|
|
'scheduled_at': fields.DateTimeField(nullable=True),
|
|
'launched_at': fields.DateTimeField(nullable=True),
|
|
'terminated_at': fields.DateTimeField(nullable=True),
|
|
|
|
'display_name': fields.StringField(nullable=True),
|
|
'display_description': fields.StringField(nullable=True),
|
|
|
|
'provider_id': fields.UUIDField(nullable=True),
|
|
'provider_location': fields.StringField(nullable=True),
|
|
'provider_auth': fields.StringField(nullable=True),
|
|
'provider_geometry': fields.StringField(nullable=True),
|
|
|
|
'volume_type_id': fields.UUIDField(nullable=True),
|
|
'source_volid': fields.UUIDField(nullable=True),
|
|
'encryption_key_id': fields.UUIDField(nullable=True),
|
|
|
|
'consistencygroup_id': fields.UUIDField(nullable=True),
|
|
|
|
'deleted': fields.BooleanField(default=False),
|
|
'bootable': fields.BooleanField(default=False),
|
|
'multiattach': fields.BooleanField(default=False),
|
|
|
|
'replication_status': fields.StringField(nullable=True),
|
|
'replication_extended_status': fields.StringField(nullable=True),
|
|
'replication_driver_data': fields.StringField(nullable=True),
|
|
|
|
'previous_status': fields.StringField(nullable=True),
|
|
|
|
'metadata': fields.DictOfStringsField(nullable=True),
|
|
'admin_metadata': fields.DictOfStringsField(nullable=True),
|
|
'volume_type': fields.ObjectField('VolumeType', nullable=True),
|
|
'volume_attachment': fields.ListOfObjectsField('VolumeAttachment',
|
|
nullable=True),
|
|
}
|
|
|
|
# NOTE(thangp): obj_extra_fields is used to hold properties that are not
|
|
# usually part of the model
|
|
obj_extra_fields = ['name', 'name_id']
|
|
|
|
@property
|
|
def name_id(self):
|
|
return self.id if not self._name_id else self._name_id
|
|
|
|
@name_id.setter
|
|
def name_id(self, value):
|
|
self._name_id = value
|
|
|
|
@property
|
|
def name(self):
|
|
return CONF.volume_name_template % self.name_id
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
super(Volume, self).__init__(*args, **kwargs)
|
|
self._orig_metadata = {}
|
|
self._orig_admin_metadata = {}
|
|
|
|
self._reset_metadata_tracking()
|
|
|
|
def obj_reset_changes(self, fields=None):
|
|
super(Volume, self).obj_reset_changes(fields)
|
|
self._reset_metadata_tracking(fields=fields)
|
|
|
|
def _reset_metadata_tracking(self, fields=None):
|
|
if fields is None or 'metadata' in fields:
|
|
self._orig_metadata = (dict(self.metadata)
|
|
if 'metadata' in self else {})
|
|
if fields is None or 'admin_metadata' in fields:
|
|
self._orig_admin_metadata = (dict(self.admin_metadata)
|
|
if 'admin_metadata' in self
|
|
else {})
|
|
|
|
def obj_what_changed(self):
|
|
changes = super(Volume, self).obj_what_changed()
|
|
if 'metadata' in self and self.metadata != self._orig_metadata:
|
|
changes.add('metadata')
|
|
if ('admin_metadata' in self and
|
|
self.admin_metadata != self._orig_admin_metadata):
|
|
changes.add('admin_metadata')
|
|
|
|
return changes
|
|
|
|
def obj_make_compatible(self, primitive, target_version):
|
|
"""Make an object representation compatible with a target version."""
|
|
super(Volume, self).obj_make_compatible(primitive, target_version)
|
|
target_version = utils.convert_version_to_tuple(target_version)
|
|
|
|
@staticmethod
|
|
def _from_db_object(context, volume, db_volume, expected_attrs=None):
|
|
if expected_attrs is None:
|
|
expected_attrs = []
|
|
for name, field in volume.fields.items():
|
|
if name in OPTIONAL_FIELDS:
|
|
continue
|
|
value = db_volume.get(name)
|
|
if isinstance(field, fields.IntegerField):
|
|
value = value or 0
|
|
volume[name] = value
|
|
|
|
# Get data from db_volume object that was queried by joined query
|
|
# from DB
|
|
if 'metadata' in expected_attrs:
|
|
volume.metadata = {}
|
|
metadata = db_volume.get('volume_metadata', [])
|
|
if metadata:
|
|
volume.metadata = {item['key']: item['value']
|
|
for item in metadata}
|
|
if 'admin_metadata' in expected_attrs:
|
|
volume.admin_metadata = {}
|
|
metadata = db_volume.get('volume_admin_metadata', [])
|
|
if metadata:
|
|
volume.admin_metadata = {item['key']: item['value']
|
|
for item in metadata}
|
|
if 'volume_type' in expected_attrs:
|
|
db_volume_type = db_volume.get('volume_type')
|
|
if db_volume_type:
|
|
volume.volume_type = objects.VolumeType._from_db_object(
|
|
context, objects.VolumeType(), db_volume_type,
|
|
expected_attrs='extra_specs')
|
|
if 'volume_attachment' in expected_attrs:
|
|
attachments = base.obj_make_list(
|
|
context, objects.VolumeAttachmentList(context),
|
|
objects.VolumeAttachment,
|
|
db_volume.get('volume_attachment'))
|
|
volume.volume_attachment = attachments.objects
|
|
|
|
volume._context = context
|
|
volume.obj_reset_changes()
|
|
return volume
|
|
|
|
@base.remotable_classmethod
|
|
def get_by_id(cls, context, id):
|
|
db_volume = db.volume_get(context, id)
|
|
expected_attrs = ['admin_metadata', 'metadata']
|
|
return cls._from_db_object(context, cls(context), db_volume,
|
|
expected_attrs=expected_attrs)
|
|
|
|
@base.remotable
|
|
def create(self):
|
|
if self.obj_attr_is_set('id'):
|
|
raise exception.ObjectActionError(action='create',
|
|
reason=_('already created'))
|
|
updates = self.cinder_obj_get_changes()
|
|
db_volume = db.volume_create(self._context, updates)
|
|
self._from_db_object(self._context, self, db_volume)
|
|
|
|
@base.remotable
|
|
def save(self):
|
|
updates = self.cinder_obj_get_changes()
|
|
if updates:
|
|
if 'metadata' in updates:
|
|
# Metadata items that are not specified in the
|
|
# self.metadata will be deleted
|
|
metadata = updates.pop('metadata', None)
|
|
self.metadata = db.volume_metadata_update(self._context,
|
|
self.id, metadata,
|
|
True)
|
|
if self._context.is_admin and 'admin_metadata' in updates:
|
|
metadata = updates.pop('admin_metadata', None)
|
|
self.admin_metadata = db.volume_admin_metadata_update(
|
|
self._context, self.id, metadata, True)
|
|
|
|
db.volume_update(self._context, self.id, updates)
|
|
self.obj_reset_changes()
|
|
|
|
@base.remotable
|
|
def destroy(self):
|
|
with self.obj_as_admin():
|
|
db.volume_destroy(self._context, self.id)
|
|
|
|
def obj_load_attr(self, attrname):
|
|
if attrname not in OPTIONAL_FIELDS:
|
|
raise exception.ObjectActionError(
|
|
action='obj_load_attr',
|
|
reason=_('attribute %s not lazy-loadable') % attrname)
|
|
if not self._context:
|
|
raise exception.OrphanedObjectError(method='obj_load_attr',
|
|
objtype=self.obj_name())
|
|
|
|
if attrname == 'metadata':
|
|
self.metadata = db.volume_metadata_get(self._context, self.id)
|
|
elif attrname == 'admin_metadata':
|
|
self.admin_metadata = {}
|
|
if self._context.is_admin:
|
|
self.admin_metadata = db.volume_admin_metadata_get(
|
|
self._context, self.id)
|
|
elif attrname == 'volume_type':
|
|
self.volume_type = objects.VolumeType.get_by_id(
|
|
self._context, self.volume_type_id)
|
|
elif attrname == 'volume_attachment':
|
|
attachments = (
|
|
objects.VolumeAttachmentList.get_all_by_volume_id(
|
|
self._context, self.id))
|
|
self.volume_attachment = attachments.objects
|
|
|
|
self.obj_reset_changes(fields=[attrname])
|
|
|
|
def delete_metadata_key(self, key):
|
|
db.volume_metadata_delete(self._context, self.id, key)
|
|
md_was_changed = 'metadata' in self.obj_what_changed()
|
|
|
|
del self.metadata[key]
|
|
self._orig_metadata.pop(key, None)
|
|
|
|
if not md_was_changed:
|
|
self.obj_reset_changes(['metadata'])
|
|
|
|
|
|
@base.CinderObjectRegistry.register
|
|
class VolumeList(base.ObjectListBase, base.CinderObject):
|
|
VERSION = '1.1'
|
|
|
|
fields = {
|
|
'objects': fields.ListOfObjectsField('Volume'),
|
|
}
|
|
|
|
child_versions = {
|
|
'1.0': '1.0',
|
|
'1.1': '1.1',
|
|
}
|
|
|
|
@base.remotable_classmethod
|
|
def get_all(cls, context, marker, limit, sort_keys=None, sort_dirs=None,
|
|
filters=None, offset=None):
|
|
volumes = db.volume_get_all(context, marker, limit,
|
|
sort_keys=sort_keys, sort_dirs=sort_dirs,
|
|
filters=filters, offset=offset)
|
|
expected_attrs = ['admin_metadata', 'metadata']
|
|
return base.obj_make_list(context, cls(context), objects.Volume,
|
|
volumes, expected_attrs=expected_attrs)
|
|
|
|
@base.remotable_classmethod
|
|
def get_all_by_host(cls, context, host, filters=None):
|
|
volumes = db.volume_get_all_by_host(context, host, filters)
|
|
expected_attrs = ['admin_metadata', 'metadata']
|
|
return base.obj_make_list(context, cls(context), objects.Volume,
|
|
volumes, expected_attrs=expected_attrs)
|
|
|
|
@base.remotable_classmethod
|
|
def get_all_by_group(cls, context, group_id, filters=None):
|
|
volumes = db.volume_get_all_by_group(context, group_id, filters)
|
|
expected_attrs = ['admin_metadata', 'metadata']
|
|
return base.obj_make_list(context, cls(context), objects.Volume,
|
|
volumes, expected_attrs=expected_attrs)
|
|
|
|
@base.remotable_classmethod
|
|
def get_all_by_project(cls, context, project_id, marker, limit,
|
|
sort_keys=None, sort_dirs=None, filters=None,
|
|
offset=None):
|
|
volumes = db.volume_get_all_by_project(context, project_id, marker,
|
|
limit, sort_keys=sort_keys,
|
|
sort_dirs=sort_dirs,
|
|
filters=filters, offset=offset)
|
|
expected_attrs = ['admin_metadata', 'metadata']
|
|
return base.obj_make_list(context, cls(context), objects.Volume,
|
|
volumes, expected_attrs=expected_attrs)
|