# coding=utf-8 # # # 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_utils import strutils from oslo_utils import uuidutils from oslo_versionedobjects import fields from magnum.common import exception from magnum.db import api as dbapi from magnum.objects import base from magnum.objects import cluster_template from magnum.objects import fields as m_fields @base.MagnumObjectRegistry.register class Bay(base.MagnumPersistentObject, base.MagnumObject, base.MagnumObjectDictCompat): # Version 1.0: Initial version # Version 1.1: Added 'bay_create_timeout' field # Version 1.2: Add 'registry_trust_id' field # Version 1.3: Added 'baymodel' field # Version 1.4: Added more types of status to bay's status field # Version 1.5: Rename 'registry_trust_id' to 'trust_id' # Add 'trustee_user_name', 'trustee_password', # 'trustee_user_id' field # Version 1.6: Add rollback support for Bay # Version 1.7: Added 'coe_version' and 'container_version' fields # Version 1.8: Rename 'baymodel' to 'cluster_template' VERSION = '1.8' dbapi = dbapi.get_instance() fields = { 'id': fields.IntegerField(), 'uuid': fields.UUIDField(nullable=True), 'name': fields.StringField(nullable=True), 'project_id': fields.StringField(nullable=True), 'user_id': fields.StringField(nullable=True), 'baymodel_id': fields.StringField(nullable=True), 'stack_id': fields.StringField(nullable=True), 'status': m_fields.BayStatusField(nullable=True), 'status_reason': fields.StringField(nullable=True), 'bay_create_timeout': fields.IntegerField(nullable=True), 'api_address': fields.StringField(nullable=True), 'node_addresses': fields.ListOfStringsField(nullable=True), 'node_count': fields.IntegerField(nullable=True), 'master_count': fields.IntegerField(nullable=True), 'discovery_url': fields.StringField(nullable=True), 'master_addresses': fields.ListOfStringsField(nullable=True), 'ca_cert_ref': fields.StringField(nullable=True), 'magnum_cert_ref': fields.StringField(nullable=True), 'cluster_template': fields.ObjectField('ClusterTemplate'), 'trust_id': fields.StringField(nullable=True), 'trustee_username': fields.StringField(nullable=True), 'trustee_password': fields.StringField(nullable=True), 'trustee_user_id': fields.StringField(nullable=True), 'coe_version': fields.StringField(nullable=True), 'container_version': fields.StringField(nullable=True) } @staticmethod def _from_db_object(bay, db_bay): """Converts a database entity to a formal object.""" for field in bay.fields: if field != 'cluster_template': bay[field] = db_bay[field] # Note(eliqiao): The following line needs to be placed outside the # loop because there is a dependency from cluster_template to # baymodel_id. The baymodel_id must be populated first in the loop # before it can be used to find the cluster_template. bay['cluster_template'] = cluster_template.ClusterTemplate.get_by_uuid( bay._context, bay.baymodel_id) bay.obj_reset_changes() return bay @staticmethod def _from_db_object_list(db_objects, cls, context): """Converts a list of database entities to a list of formal objects.""" return [Bay._from_db_object(cls(context), obj) for obj in db_objects] @base.remotable_classmethod def get(cls, context, bay_id): """Find a bay based on its id or uuid and return a Bay object. :param bay_id: the id *or* uuid of a bay. :param context: Security context :returns: a :class:`Bay` object. """ if strutils.is_int_like(bay_id): return cls.get_by_id(context, bay_id) elif uuidutils.is_uuid_like(bay_id): return cls.get_by_uuid(context, bay_id) else: raise exception.InvalidIdentity(identity=bay_id) @base.remotable_classmethod def get_by_id(cls, context, bay_id): """Find a bay based on its integer id and return a Bay object. :param bay_id: the id of a bay. :param context: Security context :returns: a :class:`Bay` object. """ db_bay = cls.dbapi.get_bay_by_id(context, bay_id) bay = Bay._from_db_object(cls(context), db_bay) return bay @base.remotable_classmethod def get_by_uuid(cls, context, uuid): """Find a bay based on uuid and return a :class:`Bay` object. :param uuid: the uuid of a bay. :param context: Security context :returns: a :class:`Bay` object. """ db_bay = cls.dbapi.get_bay_by_uuid(context, uuid) bay = Bay._from_db_object(cls(context), db_bay) return bay @base.remotable_classmethod def get_by_name(cls, context, name): """Find a bay based on name and return a Bay object. :param name: the logical name of a bay. :param context: Security context :returns: a :class:`Bay` object. """ db_bay = cls.dbapi.get_bay_by_name(context, name) bay = Bay._from_db_object(cls(context), db_bay) return bay @base.remotable_classmethod def list(cls, context, limit=None, marker=None, sort_key=None, sort_dir=None, filters=None): """Return a list of Bay objects. :param context: Security context. :param limit: maximum number of resources to return in a single result. :param marker: pagination marker for large data sets. :param sort_key: column to sort results by. :param sort_dir: direction to sort. "asc" or "desc". :param filters: filter dict, can includes 'baymodel_id', 'name', 'node_count', 'stack_id', 'api_address', 'node_addresses', 'project_id', 'user_id', 'status'(should be a status list), 'master_count'. :returns: a list of :class:`Bay` object. """ db_bays = cls.dbapi.get_bay_list(context, limit=limit, marker=marker, sort_key=sort_key, sort_dir=sort_dir, filters=filters) return Bay._from_db_object_list(db_bays, cls, context) @base.remotable def create(self, context=None): """Create a Bay record in the DB. :param context: Security context. NOTE: This should only be used internally by the indirection_api. Unfortunately, RPC requires context as the first argument, even though we don't use it. A context should be set when instantiating the object, e.g.: Bay(context) """ values = self.obj_get_changes() db_bay = self.dbapi.create_bay(values) self._from_db_object(self, db_bay) @base.remotable def destroy(self, context=None): """Delete the Bay from the DB. :param context: Security context. NOTE: This should only be used internally by the indirection_api. Unfortunately, RPC requires context as the first argument, even though we don't use it. A context should be set when instantiating the object, e.g.: Bay(context) """ self.dbapi.destroy_bay(self.uuid) self.obj_reset_changes() @base.remotable def save(self, context=None): """Save updates to this Bay. Updates will be made column by column based on the result of self.what_changed(). :param context: Security context. NOTE: This should only be used internally by the indirection_api. Unfortunately, RPC requires context as the first argument, even though we don't use it. A context should be set when instantiating the object, e.g.: Bay(context) """ updates = self.obj_get_changes() self.dbapi.update_bay(self.uuid, updates) self.obj_reset_changes() @base.remotable def refresh(self, context=None): """Loads updates for this Bay. Loads a bay with the same uuid from the database and checks for updated attributes. Updates are applied from the loaded bay column by column, if there are any updates. :param context: Security context. NOTE: This should only be used internally by the indirection_api. Unfortunately, RPC requires context as the first argument, even though we don't use it. A context should be set when instantiating the object, e.g.: Bay(context) """ current = self.__class__.get_by_uuid(self._context, uuid=self.uuid) for field in self.fields: if self.obj_attr_is_set(field) and self[field] != current[field]: self[field] = current[field]