def update(self, json_snippet=None): ''' update the resource. Subclasses should provide a handle_update() method to customise update, the base-class handle_update will fail by default. ''' assert json_snippet is not None, 'Must specify update json snippet' if self.state in (self.CREATE_IN_PROGRESS, self.UPDATE_IN_PROGRESS): raise exception.ResourceFailure( Exception('Resource update already requested')) logger.info('updating %s' % str(self)) try: self.state_set(self.UPDATE_IN_PROGRESS) properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), self.stack.resolve_runtime_data, self.name) properties.validate() tmpl_diff = self.update_template_diff(json_snippet) prop_diff = self.update_template_diff_properties(json_snippet) if callable(getattr(self, 'handle_update', None)): result = self.handle_update(json_snippet, tmpl_diff, prop_diff) except UpdateReplace: logger.debug("Resource %s update requires replacement" % self.name) raise except Exception as ex: logger.exception('update %s : %s' % (str(self), str(ex))) failure = exception.ResourceFailure(ex) self.state_set(self.UPDATE_FAILED, str(failure)) raise failure else: self.t = self.stack.resolve_static_data(json_snippet) self.state_set(self.UPDATE_COMPLETE)
def handle_update(self, json_snippet, tmpl_diff, prop_diff): """ If Properties has changed, update self.properties, so we get the new values during any subsequent adjustment. """ if tmpl_diff: # parse update policy if 'UpdatePolicy' in tmpl_diff: self.update_policy = Properties(self.update_policy_schema, json_snippet.get( 'UpdatePolicy', {}), parent_name=self.name, context=self.context) if prop_diff: self.properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), self.stack.resolve_runtime_data, self.name, self.context) # Replace instances first if launch configuration has changed if (self.update_policy[self.ROLLING_UPDATE] and self.LAUNCH_CONFIGURATION_NAME in prop_diff): policy = self.update_policy[self.ROLLING_UPDATE] self._replace(policy[self.MIN_INSTANCES_IN_SERVICE], policy[self.MAX_BATCH_SIZE], policy[self.PAUSE_TIME]) # Get the current capacity, we may need to adjust if # Size has changed if self.SIZE in prop_diff: inst_list = self.get_instances() if len(inst_list) != self.properties[self.SIZE]: self.resize(self.properties[self.SIZE])
def reparse(self): self.t = self.stack.resolve_static_data(self.json_snippet) self.properties = Properties(self.properties_schema, self.t.get('Properties', {}), self._resolve_runtime_data, self.name, self.context)
def update(self, json_snippet=None): ''' update the resource. Subclasses should provide a handle_update() method to customise update, the base-class handle_update will fail by default. ''' assert json_snippet is not None, 'Must specify update json snippet' if self.state in (self.CREATE_IN_PROGRESS, self.UPDATE_IN_PROGRESS): raise exception.ResourceFailure(Exception( 'Resource update already requested')) logger.info('updating %s' % str(self)) try: self.state_set(self.UPDATE_IN_PROGRESS) properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), self.stack.resolve_runtime_data, self.name) properties.validate() tmpl_diff = self.update_template_diff(json_snippet) prop_diff = self.update_template_diff_properties(json_snippet) if callable(getattr(self, 'handle_update', None)): result = self.handle_update(json_snippet, tmpl_diff, prop_diff) except UpdateReplace: logger.debug("Resource %s update requires replacement" % self.name) raise except Exception as ex: logger.exception('update %s : %s' % (str(self), str(ex))) failure = exception.ResourceFailure(ex) self.state_set(self.UPDATE_FAILED, str(failure)) raise failure else: self.t = self.stack.resolve_static_data(json_snippet) self.state_set(self.UPDATE_COMPLETE)
def update(self, after, before=None): """ update the resource. Subclasses should provide a handle_update() method to customise update, the base-class handle_update will fail by default. """ if before is None: before = self.parsed_template() if (self.action, self.status) in ((self.CREATE, self.IN_PROGRESS), (self.UPDATE, self.IN_PROGRESS)): raise exception.ResourceFailure(Exception("Resource update already requested")) logger.info("updating %s" % str(self)) try: self.state_set(self.UPDATE, self.IN_PROGRESS) properties = Properties( self.properties_schema, after.get("Properties", {}), self.stack.resolve_runtime_data, self.name ) properties.validate() tmpl_diff = self.update_template_diff(after, before) prop_diff = self.update_template_diff_properties(after, before) if callable(getattr(self, "handle_update", None)): result = self.handle_update(after, tmpl_diff, prop_diff) except UpdateReplace: logger.debug("Resource %s update requires replacement" % self.name) raise except Exception as ex: logger.exception("update %s : %s" % (str(self), str(ex))) failure = exception.ResourceFailure(ex) self.state_set(self.UPDATE, self.FAILED, str(failure)) raise failure else: self.t = self.stack.resolve_static_data(after) self.state_set(self.UPDATE, self.COMPLETE)
def handle_update(self, json_snippet, tmpl_diff, prop_diff): """ If Properties has changed, update self.properties, so we get the new values during any subsequent adjustment. """ if tmpl_diff: # parse update policy if 'UpdatePolicy' in tmpl_diff: self.update_policy = Properties(self.update_policy_schema, json_snippet.get( 'UpdatePolicy', {}), parent_name=self.name, context=self.context) if prop_diff: self.properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), function.resolve, self.name, self.context) # Replace instances first if launch configuration has changed self._try_rolling_update(prop_diff) # Get the current capacity, we may need to adjust if # Size has changed if self.SIZE in prop_diff: inst_list = self.get_instances() if len(inst_list) != self.properties[self.SIZE]: self.resize(self.properties[self.SIZE])
def handle_update(self, json_snippet, tmpl_diff, prop_diff): """ If Properties has changed, update self.properties, so we get the new values during any subsequent adjustment. """ if tmpl_diff: # parse update policy if 'UpdatePolicy' in tmpl_diff: self.update_policy = Properties(self.update_policy_schema, json_snippet.get( 'UpdatePolicy', {}), parent_name=self.name) if prop_diff: self.properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), self.stack.resolve_runtime_data, self.name) # Replace instances first if launch configuration has changed if (self.update_policy['RollingUpdate'] and 'LaunchConfigurationName' in prop_diff): policy = self.update_policy['RollingUpdate'] self._replace(int(policy['MinInstancesInService']), int(policy['MaxBatchSize']), policy['PauseTime']) # Get the current capacity, we may need to adjust if # Size has changed if 'Size' in prop_diff: inst_list = self.get_instances() if len(inst_list) != int(self.properties['Size']): self.resize(int(self.properties['Size']))
def update(self, json_snippet=None): ''' update the resource. Subclasses should provide a handle_update() method to customise update, the base-class handle_update will fail by default. ''' if self.state in (self.CREATE_IN_PROGRESS, self.UPDATE_IN_PROGRESS): return 'Resource update already requested' if not json_snippet: return 'Must specify json snippet for resource update!' logger.info('updating %s' % str(self)) result = self.UPDATE_NOT_IMPLEMENTED try: self.state_set(self.UPDATE_IN_PROGRESS) properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), self.stack.resolve_runtime_data, self.name) properties.validate() if callable(getattr(self, 'handle_update', None)): result = self.handle_update(json_snippet) except Exception as ex: logger.exception('update %s : %s' % (str(self), str(ex))) self.state_set(self.UPDATE_FAILED, str(ex)) return str(ex) or "Error : %s" % type(ex) else: # If resource was updated (with or without interruption), # then we set the resource to UPDATE_COMPLETE if not result == self.UPDATE_REPLACE: self.t = self.stack.resolve_static_data(json_snippet) self.state_set(self.UPDATE_COMPLETE) return result
def handle_update(self, json_snippet, tmpl_diff, prop_diff): """ If Properties has changed, update self.properties, so we get the new values during any subsequent adjustment. """ if tmpl_diff: # parse update policy if 'UpdatePolicy' in tmpl_diff: self.update_policy = Properties(self.update_policy_schema, json_snippet.get( 'UpdatePolicy', {}), parent_name=self.name) if prop_diff: self.properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), self.stack.resolve_runtime_data, self.name) # Get the current capacity, we may need to adjust if # Size has changed if 'Size' in prop_diff: inst_list = self.get_instances() if len(inst_list) != int(self.properties['Size']): self.resize(int(self.properties['Size']))
def handle_update(self, json_snippet, tmpl_diff, prop_diff): """ If Properties has changed, update self.properties, so we get the new values during any subsequent adjustment. """ if tmpl_diff: # parse update policy if 'UpdatePolicy' in tmpl_diff: self.update_policy = Properties( self.update_policy_schema, json_snippet.get('UpdatePolicy', {}), parent_name=self.name, context=self.context) if prop_diff: self.properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), self.stack.resolve_runtime_data, self.name, self.context) # Replace instances first if launch configuration has changed if (self.update_policy[self.ROLLING_UPDATE] and self.LAUNCH_CONFIGURATION_NAME in prop_diff): policy = self.update_policy[self.ROLLING_UPDATE] self._replace(policy[self.MIN_INSTANCES_IN_SERVICE], policy[self.MAX_BATCH_SIZE], policy[self.PAUSE_TIME]) # Get the current capacity, we may need to adjust if # Size has changed if self.SIZE in prop_diff: inst_list = self.get_instances() if len(inst_list) != self.properties[self.SIZE]: self.resize(self.properties[self.SIZE])
def create(self): ''' Create the resource. Subclasses should provide a handle_create() method to customise creation. ''' if self.state in (self.CREATE_IN_PROGRESS, self.CREATE_COMPLETE): return 'Resource creation already requested' logger.info('creating %s' % str(self)) # Re-resolve the template, since if the resource Ref's # the AWS::StackId pseudo parameter, it will change after # the parser.Stack is stored (which is after the resources # are __init__'d, but before they are create()'d) self.t = self.stack.resolve_static_data(self.json_snippet) self.properties = Properties(self.properties_schema, self.t.get('Properties', {}), self.stack.resolve_runtime_data, self.name) try: self.properties.validate() self.state_set(self.CREATE_IN_PROGRESS) create_data = None if callable(getattr(self, 'handle_create', None)): create_data = self.handle_create() while not self.check_active(create_data): eventlet.sleep(1) except greenlet.GreenletExit: raise except Exception as ex: logger.exception('create %s', str(self)) self.state_set(self.CREATE_FAILED, str(ex)) return str(ex) or "Error : %s" % type(ex) else: self.state_set(self.CREATE_COMPLETE)
def handle_update(self, json_snippet, tmpl_diff, prop_diff): """ If Properties has changed, update self.properties, so we get the new values during any subsequent adjustment. """ if tmpl_diff: # parse update policy if 'UpdatePolicy' in tmpl_diff: self.update_policy = Properties( self.update_policy_schema, json_snippet.get('UpdatePolicy', {}), parent_name=self.name, context=self.context) if prop_diff: self.properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), self.stack.resolve_runtime_data, self.name, self.context) # Replace instances first if launch configuration has changed if (self.update_policy['RollingUpdate'] and self.LAUNCH_CONFIGURATION_NAME in prop_diff): policy = self.update_policy['RollingUpdate'] self._replace(int(policy['MinInstancesInService']), int(policy['MaxBatchSize']), policy['PauseTime']) # Get the current capacity, we may need to adjust if # Size has changed if self.SIZE in prop_diff: inst_list = self.get_instances() if len(inst_list) != int(self.properties[self.SIZE]): self.resize(int(self.properties[self.SIZE]))
def __init__(self, name, json_snippet, stack): if '/' in name: raise ValueError(_('Resource name may not contain "/"')) self.stack = stack self.context = stack.context self.name = name self.json_snippet = json_snippet self.t = stack.resolve_static_data(json_snippet) self.cached_t = None self.properties = Properties(self.properties_schema, self.t.get('Properties', {}), self.stack.resolve_runtime_data, self.name) resource = db_api.resource_get_by_name_and_stack( self.context, name, stack.id) if resource: self.resource_id = resource.nova_instance self.state = resource.state self.state_description = resource.state_description self.id = resource.id else: self.resource_id = None self.state = None self.state_description = '' self.id = None
def __init__(self, name, json_snippet, stack): if '/' in name: raise ValueError(_('Resource name may not contain "/"')) self.stack = stack self.context = stack.context self.name = name self.json_snippet = json_snippet self.t = stack.resolve_static_data(json_snippet) self.properties = Properties(self.properties_schema, self.t.get('Properties', {}), self._resolve_runtime_data, self.name) self.attributes = Attributes(self.name, self.attributes_schema, self._resolve_attribute) resource = db_api.resource_get_by_name_and_stack( self.context, name, stack.id) if resource: self.resource_id = resource.nova_instance self.action = resource.action self.status = resource.status self.status_reason = resource.status_reason self.id = resource.id self.data = resource.data else: self.resource_id = None # if the stack is being deleted, assume we've already been deleted if stack.action == stack.DELETE: self.action = self.DELETE else: self.action = self.INIT self.status = self.COMPLETE self.status_reason = '' self.id = None self.data = []
def handle_update(self, json_snippet, tmpl_diff, prop_diff): """ If Properties has changed, update self.properties, so we get the new values during any subsequent adjustment. """ if tmpl_diff: # parse update policy if 'UpdatePolicy' in tmpl_diff: self.update_policy = Properties( self.update_policy_schema, json_snippet.get('UpdatePolicy', {}), parent_name=self.name) if prop_diff: self.properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), self.stack.resolve_runtime_data, self.name) # Get the current capacity, we may need to adjust if # Size has changed if 'Size' in prop_diff: inst_list = self.get_instances() if len(inst_list) != int(self.properties['Size']): self.resize(int(self.properties['Size']))
def handle_update(self, json_snippet, tmpl_diff, prop_diff): """ If Properties has changed, update self.properties, so we get the new values during any subsequent adjustment. """ if tmpl_diff: # parse update policy if 'UpdatePolicy' in tmpl_diff: self.update_policy = Properties( self.update_policy_schema, json_snippet.get('UpdatePolicy', {}), parent_name=self.name, context=self.context) if prop_diff: self.properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), function.resolve, self.name, self.context) # Replace instances first if launch configuration has changed self._try_rolling_update(prop_diff) # Get the current capacity, we may need to adjust if # Size has changed if self.SIZE in prop_diff: inst_list = self.get_instances() if len(inst_list) != self.properties[self.SIZE]: self.resize(self.properties[self.SIZE])
def update(self, after, before=None, prev_resource=None): ''' update the resource. Subclasses should provide a handle_update() method to customise update, the base-class handle_update will fail by default. ''' action = self.UPDATE (cur_class_def, cur_ver) = self.implementation_signature() prev_ver = cur_ver if prev_resource is not None: (prev_class_def, prev_ver) = prev_resource.implementation_signature() if prev_class_def != cur_class_def: raise UpdateReplace(self.name) if before is None: before = self.parsed_template() if prev_ver == cur_ver and before == after: return if (self.action, self.status) in ((self.CREATE, self.IN_PROGRESS), (self.UPDATE, self.IN_PROGRESS), (self.ADOPT, self.IN_PROGRESS)): exc = Exception(_('Resource update already requested')) raise exception.ResourceFailure(exc, self, action) logger.info('updating %s' % str(self)) try: self.updated_time = datetime.utcnow() self.state_set(action, self.IN_PROGRESS) properties = Properties(self.properties_schema, after.get('Properties', {}), self._resolve_runtime_data, self.name, self.context) properties.validate() tmpl_diff = self.update_template_diff(after, before) prop_diff = self.update_template_diff_properties(after, before) if callable(getattr(self, 'handle_update', None)): handle_data = self.handle_update(after, tmpl_diff, prop_diff) yield if callable(getattr(self, 'check_update_complete', None)): while not self.check_update_complete(handle_data): yield except UpdateReplace: with excutils.save_and_reraise_exception(): logger.debug(_("Resource %s update requires replacement") % self.name) except Exception as ex: logger.exception('update %s : %s' % (str(self), str(ex))) failure = exception.ResourceFailure(ex, self, action) self.state_set(action, self.FAILED, str(failure)) raise failure else: self.json_snippet = copy.deepcopy(after) self.reparse() self.state_set(action, self.COMPLETE)
def __init__(self, name, json_snippet, stack): """ UpdatePolicy is currently only specific to InstanceGroup and AutoScalingGroup. Therefore, init is overridden to parse for the UpdatePolicy. """ super(InstanceGroup, self).__init__(name, json_snippet, stack) self.update_policy = Properties(self.update_policy_schema, self.t.get('UpdatePolicy', {}), parent_name=self.name)
def prepare_update_properties(self, json_snippet): ''' Removes any properties which are not update_allowed, then processes as for prepare_properties. ''' p = Properties(self.properties_schema, json_snippet.get('Properties', {}), self._resolve_runtime_data, self.name, self.context) props = dict((k, v) for k, v in p.items() if p.props.get(k).schema.update_allowed) return props
def create(self): ''' Create the resource. Subclasses should provide a handle_create() method to customise creation. ''' assert self.state is None, 'Resource create requested in invalid state' logger.info('creating %s' % str(self)) # Re-resolve the template, since if the resource Ref's # the AWS::StackId pseudo parameter, it will change after # the parser.Stack is stored (which is after the resources # are __init__'d, but before they are create()'d) self.t = self.stack.resolve_static_data(self.json_snippet) self.properties = Properties(self.properties_schema, self.t.get('Properties', {}), self.stack.resolve_runtime_data, self.name) try: self.properties.validate() self.state_set(self.CREATE_IN_PROGRESS) create_data = None if callable(getattr(self, 'handle_create', None)): create_data = self.handle_create() yield while not self.check_create_complete(create_data): yield except greenlet.GreenletExit: # Older versions of greenlet erroneously had GreenletExit inherit # from Exception instead of BaseException with excutils.save_and_reraise_exception(): try: self.state_set(self.CREATE_FAILED, 'Creation aborted') except Exception: logger.exception('Error marking resource as failed') except Exception as ex: logger.exception('create %s', str(self)) failure = exception.ResourceFailure(ex) self.state_set(self.CREATE_FAILED, str(failure)) raise failure except: with excutils.save_and_reraise_exception(): try: self.state_set(self.CREATE_FAILED, 'Creation aborted') except Exception: logger.exception('Error marking resource as failed') else: self.state_set(self.CREATE_COMPLETE)
def __init__(self, name, json_snippet, stack): if '/' in name: raise ValueError(_('Resource name may not contain "/"')) self.stack = stack self.context = stack.context self.name = name self.json_snippet = json_snippet self.t = stack.resolve_static_data(json_snippet) self.properties = Properties(self.properties_schema, self.t.get('Properties', {}), self.stack.resolve_runtime_data, self.name) self.attributes = Attributes(self.name, self.attributes_schema, self._resolve_attribute) resource = db_api.resource_get_by_name_and_stack(self.context, name, stack.id) if resource: self.resource_id = resource.nova_instance self.action = resource.action self.status = resource.status self.status_reason = resource.status_reason self.id = resource.id self.data = resource.data else: self.resource_id = None self.action = self.INIT self.status = self.COMPLETE self.status_reason = '' self.id = None self.data = []
def __init__(self, name, json_snippet, stack): if '/' in name: raise ValueError(_('Resource name may not contain "/"')) self.references = [] self.stack = stack self.context = stack.context self.name = name self.t = stack.resolve_static_data(json_snippet) self.properties = Properties(self.properties_schema, self.t.get('Properties', {}), self.stack.resolve_runtime_data, self.name) resource = db_api.resource_get_by_name_and_stack(self.context, name, stack.id) if resource: self.resource_id = resource.nova_instance self.state = resource.state self.state_description = resource.state_description self.id = resource.id else: self.resource_id = None self.state = None self.state_description = '' self.id = None self._nova = {} self._keystone = None self._swift = None self._quantum = None
def handle_update(self, json_snippet): try: tmpl_diff = self.update_template_diff(json_snippet) except NotImplementedError: logger.error("Could not update %s, invalid key" % self.name) return self.UPDATE_REPLACE try: prop_diff = self.update_template_diff_properties(json_snippet) except NotImplementedError: logger.error("Could not update %s, invalid Property" % self.name) return self.UPDATE_REPLACE # If Properties has changed, update self.properties, so we # get the new values during any subsequent adjustment if prop_diff: self.properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), self.stack.resolve_runtime_data, self.name) # Get the current capacity, we may need to adjust if # Size has changed if 'Size' in prop_diff: inst_list = [] if self.resource_id is not None: inst_list = sorted(self.resource_id.split(',')) if len(inst_list) != int(self.properties['Size']): self.resize(int(self.properties['Size']), raise_on_error=True) self._wait_for_activation() return self.UPDATE_COMPLETE
def validate(self): """Validate any of the provided params.""" res = super(CloudLoadBalancer, self).validate() if res: return res if self.properties.get(self.HALF_CLOSED): if not (self.properties[self.PROTOCOL] == 'TCP' or self.properties[self.PROTOCOL] == 'TCP_CLIENT_FIRST'): return { 'Error': 'The %s property is only available for the TCP or ' 'TCP_CLIENT_FIRST protocols' % self.HALF_CLOSED } #health_monitor connect and http types require completely different #schema if self.properties.get(self.HEALTH_MONITOR): health_monitor = \ self._remove_none(self.properties[self.HEALTH_MONITOR]) schema = self._health_monitor_schema if health_monitor[self.HEALTH_MONITOR_TYPE] == 'CONNECT': schema = dict((k, v) for k, v in schema.items() if k in self._HEALTH_MONITOR_CONNECT_KEYS) try: Properties(schema, health_monitor, function.resolve, self.name).validate() except exception.StackValidationFailed as svf: return {'Error': str(svf)}
def __init__(self, name, json_snippet, stack): if "/" in name: raise ValueError(_('Resource name may not contain "/"')) self.stack = stack self.context = stack.context self.name = name self.json_snippet = json_snippet self.t = stack.resolve_static_data(json_snippet) self.cached_t = None self.properties = Properties( self.properties_schema, self.t.get("Properties", {}), self.stack.resolve_runtime_data, self.name ) resource = db_api.resource_get_by_name_and_stack(self.context, name, stack.id) if resource: self.resource_id = resource.nova_instance self.state = resource.state self.state_description = resource.state_description self.id = resource.id else: self.resource_id = None self.state = None self.state_description = "" self.id = None
def handle_update(self, json_snippet): try: self.update_template_diff(json_snippet) except NotImplementedError: logger.error("Could not update %s, invalid key" % self.name) return self.UPDATE_REPLACE try: prop_diff = self.update_template_diff_properties(json_snippet) except NotImplementedError: logger.error("Could not update %s, invalid Property" % self.name) return self.UPDATE_REPLACE # If Properties has changed, update self.properties, so we # get the new values during any subsequent adjustment if prop_diff: self.properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), self.stack.resolve_runtime_data, self.name) loader = watchrule.WatchRule.load wr = loader(self.context, watch_name=self.physical_resource_name()) wr.rule = self.parsed_template('Properties') wr.store() return self.UPDATE_COMPLETE
def handle_update(self, json_snippet, tmpl_diff, prop_diff): """ If Properties has changed, update self.properties, so we get the new values during any subsequent adjustment. """ if prop_diff: self.properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), self.stack.resolve_runtime_data, self.name) # Get the current capacity, we may need to adjust if # MinSize or MaxSize has changed capacity = len(self.get_instances()) # Figure out if an adjustment is required new_capacity = None if 'MinSize' in prop_diff: if capacity < int(self.properties['MinSize']): new_capacity = int(self.properties['MinSize']) if 'MaxSize' in prop_diff: if capacity > int(self.properties['MaxSize']): new_capacity = int(self.properties['MaxSize']) if 'DesiredCapacity' in prop_diff: if self.properties['DesiredCapacity']: new_capacity = int(self.properties['DesiredCapacity']) if new_capacity is not None: self.adjust(new_capacity, adjustment_type='ExactCapacity')
def __init__(self, name, json_snippet, stack): if "/" in name: raise ValueError(_('Resource name may not contain "/"')) self.stack = stack self.context = stack.context self.name = name self.json_snippet = json_snippet self.t = stack.resolve_static_data(json_snippet) self.properties = Properties( self.properties_schema, self.t.get("Properties", {}), self.stack.resolve_runtime_data, self.name ) self.attributes = Attributes(self.name, self.attributes_schema, self._resolve_attribute) resource = db_api.resource_get_by_name_and_stack(self.context, name, stack.id) if resource: self.resource_id = resource.nova_instance self.action = resource.action self.status = resource.status self.status_reason = resource.status_reason self.id = resource.id self.data = resource.data else: self.resource_id = None # if the stack is being deleted, assume we've already been deleted if stack.action == stack.DELETE: self.action = self.DELETE else: self.action = self.INIT self.status = self.COMPLETE self.status_reason = "" self.id = None self.data = []
def handle_update(self, json_snippet, tmpl_diff, prop_diff): # If Properties has changed, update self.properties, so we # get the new values during any subsequent adjustment if prop_diff: self.properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), self.stack.resolve_runtime_data, self.name) # Get the current capacity, we may need to adjust if # MinSize or MaxSize has changed inst_list = [] if self.resource_id is not None: inst_list = sorted(self.resource_id.split(',')) capacity = len(inst_list) # Figure out if an adjustment is required new_capacity = None if 'MinSize' in prop_diff: if capacity < int(self.properties['MinSize']): new_capacity = int(self.properties['MinSize']) if 'MaxSize' in prop_diff: if capacity > int(self.properties['MaxSize']): new_capacity = int(self.properties['MaxSize']) if 'DesiredCapacity' in prop_diff: if self.properties['DesiredCapacity']: new_capacity = int(self.properties['DesiredCapacity']) if new_capacity is not None: creator = self._adjust(new_capacity) self._wait_for_activation(creator)
def create(self): ''' Create the resource. Subclasses should provide a handle_create() method to customise creation. ''' if self.state in (self.CREATE_IN_PROGRESS, self.CREATE_COMPLETE): return 'Resource creation already requested' logger.info('creating %s' % str(self)) # Re-resolve the template, since if the resource Ref's # the AWS::StackId pseudo parameter, it will change after # the parser.Stack is stored (which is after the resources # are __init__'d, but before they are create()'d) self.t = self.stack.resolve_static_data(self.json_snippet) self.properties = Properties(self.properties_schema, self.t.get('Properties', {}), self.stack.resolve_runtime_data, self.name) try: self.properties.validate() self.state_set(self.CREATE_IN_PROGRESS) if callable(getattr(self, 'handle_create', None)): self.handle_create() while not self.check_active(): eventlet.sleep(1) except greenlet.GreenletExit: raise except Exception as ex: logger.exception('create %s', str(self)) self.state_set(self.CREATE_FAILED, str(ex)) return str(ex) or "Error : %s" % type(ex) else: self.state_set(self.CREATE_COMPLETE)
def prepare_update_properties(self, json_snippet): ''' Prepares the property values so that they can be passed directly to the Neutron update call. Removes any properties which are not update_allowed, then processes as for prepare_properties. ''' p = Properties(self.properties_schema, json_snippet.get('Properties', {}), self._resolve_runtime_data, self.name, self.context) update_props = dict((k, v) for k, v in p.items() if p.props.get(k).schema.update_allowed) props = self.prepare_properties(update_props, self.physical_resource_name()) return props
def handle_update(self, json_snippet, tmpl_diff, prop_diff): """ If Properties has changed, update self.properties, so we get the new values during any subsequent adjustment. """ if tmpl_diff: # parse update policy if 'UpdatePolicy' in tmpl_diff: self.update_policy = Properties(self.update_policy_schema, json_snippet.get( 'UpdatePolicy', {}), parent_name=self.name, context=self.context) if prop_diff: self.properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), self.stack.resolve_runtime_data, self.name, self.context) # Replace instances first if launch configuration has changed if (self.update_policy[self.ROLLING_UPDATE] and self.LAUNCH_CONFIGURATION_NAME in prop_diff): policy = self.update_policy[self.ROLLING_UPDATE] self._replace(policy[self.MIN_INSTANCES_IN_SERVICE], policy[self.MAX_BATCH_SIZE], policy[self.PAUSE_TIME]) # Get the current capacity, we may need to adjust if # MinSize or MaxSize has changed capacity = len(self.get_instances()) # Figure out if an adjustment is required new_capacity = None if self.MIN_SIZE in prop_diff: if capacity < self.properties[self.MIN_SIZE]: new_capacity = self.properties[self.MIN_SIZE] if self.MAX_SIZE in prop_diff: if capacity > self.properties[self.MAX_SIZE]: new_capacity = self.properties[self.MAX_SIZE] if self.DESIRED_CAPACITY in prop_diff: if self.properties[self.DESIRED_CAPACITY]: new_capacity = self.properties[self.DESIRED_CAPACITY] if new_capacity is not None: self.adjust(new_capacity, adjustment_type=EXACT_CAPACITY)
def handle_update(self, json_snippet, tmpl_diff, prop_diff): # If Properties has changed, update self.properties, so we # get the new values during any subsequent adjustment if prop_diff: self.properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), self.stack.resolve_runtime_data, self.name)
def validate(self): """ Validate any of the provided params """ res = super(CloudLoadBalancer, self).validate() if res: return res if self.properties.get('halfClosed'): if not (self.properties['protocol'] == 'TCP' or self.properties['protocol'] == 'TCP_CLIENT_FIRST'): return { 'Error': 'The halfClosed property is only available for the ' 'TCP or TCP_CLIENT_FIRST protocols' } #health_monitor connect and http types require completely different #schema if self.properties.get('healthMonitor'): health_monitor = \ self._remove_none(self.properties['healthMonitor']) if health_monitor['type'] == 'CONNECT': schema = CloudLoadBalancer.health_monitor_connect_schema else: schema = CloudLoadBalancer.health_monitor_http_schema try: Properties(schema, health_monitor, self.stack.resolve_runtime_data, self.name).validate() except exception.StackValidationFailed as svf: return {'Error': str(svf)} if self.properties.get('sslTermination'): ssl_termination = self._remove_none( self.properties['sslTermination']) if ssl_termination['enabled']: try: Properties( CloudLoadBalancer.ssl_termination_enabled_schema, ssl_termination, self.stack.resolve_runtime_data, self.name).validate() except exception.StackValidationFailed as svf: return {'Error': str(svf)}
def handle_update(self, json_snippet, tmpl_diff, prop_diff): """ If Properties has changed, update self.properties, so we get the new values during any subsequent adjustment. """ if tmpl_diff: # parse update policy if 'UpdatePolicy' in tmpl_diff: self.update_policy = Properties(self.update_policy_schema, json_snippet.get( 'UpdatePolicy', {}), parent_name=self.name, context=self.context) if prop_diff: self.properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), self.stack.resolve_runtime_data, self.name, self.context) # Replace instances first if launch configuration has changed if (self.update_policy['AutoScalingRollingUpdate'] and 'LaunchConfigurationName' in prop_diff): policy = self.update_policy['AutoScalingRollingUpdate'] self._replace(int(policy['MinInstancesInService']), int(policy['MaxBatchSize']), policy['PauseTime']) # Get the current capacity, we may need to adjust if # MinSize or MaxSize has changed capacity = len(self.get_instances()) # Figure out if an adjustment is required new_capacity = None if self.MIN_SIZE in prop_diff: if capacity < int(self.properties[self.MIN_SIZE]): new_capacity = int(self.properties[self.MIN_SIZE]) if self.MAX_SIZE in prop_diff: if capacity > int(self.properties[self.MAX_SIZE]): new_capacity = int(self.properties[self.MAX_SIZE]) if self.DESIRED_CAPACITY in prop_diff: if self.properties[self.DESIRED_CAPACITY]: new_capacity = int(self.properties[self.DESIRED_CAPACITY]) if new_capacity is not None: self.adjust(new_capacity, adjustment_type='ExactCapacity')
def update(self, after, before=None): ''' update the resource. Subclasses should provide a handle_update() method to customise update, the base-class handle_update will fail by default. ''' action = self.UPDATE if before is None: before = self.parsed_template() if (self.action, self.status) in ((self.CREATE, self.IN_PROGRESS), (self.UPDATE, self.IN_PROGRESS)): exc = Exception(_('Resource update already requested')) raise exception.ResourceFailure(exc, self, action) logger.info('updating %s' % str(self)) try: self.state_set(action, self.IN_PROGRESS) properties = Properties(self.properties_schema, after.get('Properties', {}), self._resolve_runtime_data, self.name) properties.validate() tmpl_diff = self.update_template_diff(after, before) prop_diff = self.update_template_diff_properties(after, before) if callable(getattr(self, 'handle_update', None)): handle_data = self.handle_update(after, tmpl_diff, prop_diff) yield if callable(getattr(self, 'check_update_complete', None)): while not self.check_update_complete(handle_data): yield except UpdateReplace: logger.debug(_("Resource %s update requires replacement") % self.name) raise except Exception as ex: logger.exception('update %s : %s' % (str(self), str(ex))) failure = exception.ResourceFailure(ex, self, action) self.state_set(action, self.FAILED, str(failure)) raise failure else: self.t = self.stack.resolve_static_data(after) self.state_set(action, self.COMPLETE)
def prepare_update_properties(self, json_snippet): ''' Prepares the property values so that they can be passed directly to the Neutron update call. Removes any properties which are not update_allowed, then processes as for prepare_properties. ''' p = Properties(self.properties_schema, json_snippet.get('Properties', {}), self._resolve_runtime_data, self.name) update_props = dict((k, v) for k, v in p.items() if p.props.get(k).schema.update_allowed) props = self.prepare_properties( update_props, self.physical_resource_name()) return props
def handle_update(self, json_snippet, tmpl_diff, prop_diff): """ If Properties has changed, update self.properties, so we get the new values during any subsequent adjustment. """ if prop_diff: self.properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), function.resolve, self.name, self.context)
def update(self, after, before=None): ''' update the resource. Subclasses should provide a handle_update() method to customise update, the base-class handle_update will fail by default. ''' action = self.UPDATE if before is None: before = self.parsed_template() if (self.action, self.status) in ((self.CREATE, self.IN_PROGRESS), (self.UPDATE, self.IN_PROGRESS)): exc = Exception('Resource update already requested') raise exception.ResourceFailure(exc, self, action) logger.info('updating %s' % str(self)) try: self.state_set(action, self.IN_PROGRESS) properties = Properties(self.properties_schema, after.get('Properties', {}), self._resolve_runtime_data, self.name) properties.validate() tmpl_diff = self.update_template_diff(after, before) prop_diff = self.update_template_diff_properties(after, before) if callable(getattr(self, 'handle_update', None)): handle_data = self.handle_update(after, tmpl_diff, prop_diff) yield if callable(getattr(self, 'check_update_complete', None)): while not self.check_update_complete(handle_data): yield except UpdateReplace: logger.debug("Resource %s update requires replacement" % self.name) raise except Exception as ex: logger.exception('update %s : %s' % (str(self), str(ex))) failure = exception.ResourceFailure(ex, self, action) self.state_set(action, self.FAILED, str(failure)) raise failure else: self.t = self.stack.resolve_static_data(after) self.state_set(action, self.COMPLETE)
def handle_update(self, json_snippet, tmpl_diff, prop_diff): """ If Properties has changed, update self.properties, so we get the new values during any subsequent adjustment. """ if tmpl_diff: # parse update policy if 'UpdatePolicy' in tmpl_diff: self.update_policy = Properties(self.update_policy_schema, json_snippet.get( 'UpdatePolicy', {}), parent_name=self.name, context=self.context) if prop_diff: self.properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), function.resolve, self.name, self.context) # Replace instances first if launch configuration has changed self._try_rolling_update(prop_diff) # Get the current capacity, we may need to adjust if # MinSize or MaxSize has changed capacity = len(self.get_instances()) # Figure out if an adjustment is required new_capacity = None if self.MIN_SIZE in prop_diff: if capacity < self.properties[self.MIN_SIZE]: new_capacity = self.properties[self.MIN_SIZE] if self.MAX_SIZE in prop_diff: if capacity > self.properties[self.MAX_SIZE]: new_capacity = self.properties[self.MAX_SIZE] if self.DESIRED_CAPACITY in prop_diff: if self.properties[self.DESIRED_CAPACITY] is not None: new_capacity = self.properties[self.DESIRED_CAPACITY] if new_capacity is not None: self.adjust(new_capacity, adjustment_type=EXACT_CAPACITY)
def handle_update(self, json_snippet, tmpl_diff, prop_diff): # Nested stack template may be changed even if the prop_diff is empty. self.properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), self.stack.resolve_runtime_data, self.name) template_data = urlfetch.get(self.properties[PROP_TEMPLATE_URL]) template = template_format.parse(template_data) self.update_with_template(template, self.properties[PROP_PARAMETERS], self.properties[PROP_TIMEOUT_MINS])
def create(self): ''' Create the resource. Subclasses should provide a handle_create() method to customise creation. ''' action = self.CREATE if (self.action, self.status) != (self.INIT, self.COMPLETE): exc = exception.Error('State %s invalid for create' % str(self.state)) raise exception.ResourceFailure(exc, self, action) logger.info('creating %s' % str(self)) # Re-resolve the template, since if the resource Ref's # the AWS::StackId pseudo parameter, it will change after # the parser.Stack is stored (which is after the resources # are __init__'d, but before they are create()'d) self.t = self.stack.resolve_static_data(self.json_snippet) self.properties = Properties(self.properties_schema, self.t.get('Properties', {}), self._resolve_runtime_data, self.name) return self._do_action(action, self.properties.validate)
def handle_update(self, json_snippet, tmpl_diff, prop_diff): # If Properties has changed, update self.properties, so we # get the new values during any subsequent adjustment if prop_diff: self.properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), function.resolve, self.name, self.context) loader = watchrule.WatchRule.load wr = loader(self.context, watch_name=self.physical_resource_name()) wr.rule = self.parsed_template('Properties') wr.store()
def resource_to_template(cls, resource_type): """ :param resource_type: The resource type to be displayed in the template :returns: A template where the resource's properties_schema is mapped as parameters, and the resource's attributes_schema is mapped as outputs """ (parameters, properties) = Properties.schema_to_parameters_and_properties(cls.properties_schema) resource_name = cls.__name__ return { "Parameters": parameters, "Resources": {resource_name: {"Type": resource_type, "Properties": properties}}, "Outputs": Attributes.as_outputs(resource_name, cls), }
def handle_update(self, json_snippet, tmpl_diff, prop_diff): """ If Properties has changed, update self.properties, so we get the new values during any subsequent adjustment. """ if tmpl_diff: # parse update policy if 'UpdatePolicy' in tmpl_diff: self.update_policy = Properties( self.update_policy_schema, json_snippet.get('UpdatePolicy', {}), parent_name=self.name, context=self.context) if prop_diff: self.properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), self.stack.resolve_runtime_data, self.name, self.context) # Replace instances first if launch configuration has changed if (self.update_policy['AutoScalingRollingUpdate'] and 'LaunchConfigurationName' in prop_diff): policy = self.update_policy['AutoScalingRollingUpdate'] self._replace(int(policy['MinInstancesInService']), int(policy['MaxBatchSize']), policy['PauseTime']) # Get the current capacity, we may need to adjust if # MinSize or MaxSize has changed capacity = len(self.get_instances()) # Figure out if an adjustment is required new_capacity = None if self.MIN_SIZE in prop_diff: if capacity < int(self.properties[self.MIN_SIZE]): new_capacity = int(self.properties[self.MIN_SIZE]) if self.MAX_SIZE in prop_diff: if capacity > int(self.properties[self.MAX_SIZE]): new_capacity = int(self.properties[self.MAX_SIZE]) if self.DESIRED_CAPACITY in prop_diff: if self.properties[self.DESIRED_CAPACITY]: new_capacity = int(self.properties[self.DESIRED_CAPACITY]) if new_capacity is not None: self.adjust(new_capacity, adjustment_type='ExactCapacity')
def handle_update(self, json_snippet, tmpl_diff, prop_diff): """ If Properties has changed, update self.properties, so we get the new values during any subsequent adjustment. """ if tmpl_diff: # parse update policy if 'UpdatePolicy' in tmpl_diff: self.update_policy = Properties( self.update_policy_schema, json_snippet.get('UpdatePolicy', {}), parent_name=self.name, context=self.context) if prop_diff: self.properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), self.stack.resolve_runtime_data, self.name, self.context) # Replace instances first if launch configuration has changed if (self.update_policy[self.ROLLING_UPDATE] and self.LAUNCH_CONFIGURATION_NAME in prop_diff): policy = self.update_policy[self.ROLLING_UPDATE] self._replace(policy[self.MIN_INSTANCES_IN_SERVICE], policy[self.MAX_BATCH_SIZE], policy[self.PAUSE_TIME]) # Get the current capacity, we may need to adjust if # MinSize or MaxSize has changed capacity = len(self.get_instances()) # Figure out if an adjustment is required new_capacity = None if self.MIN_SIZE in prop_diff: if capacity < self.properties[self.MIN_SIZE]: new_capacity = self.properties[self.MIN_SIZE] if self.MAX_SIZE in prop_diff: if capacity > self.properties[self.MAX_SIZE]: new_capacity = self.properties[self.MAX_SIZE] if self.DESIRED_CAPACITY in prop_diff: if self.properties[self.DESIRED_CAPACITY] is not None: new_capacity = self.properties[self.DESIRED_CAPACITY] if new_capacity is not None: self.adjust(new_capacity, adjustment_type=EXACT_CAPACITY)
def create(self): ''' Create the resource. Subclasses should provide a handle_create() method to customise creation. ''' assert None in (self.action, self.status), 'invalid state for create' logger.info('creating %s' % str(self)) # Re-resolve the template, since if the resource Ref's # the AWS::StackId pseudo parameter, it will change after # the parser.Stack is stored (which is after the resources # are __init__'d, but before they are create()'d) self.t = self.stack.resolve_static_data(self.json_snippet) self.properties = Properties(self.properties_schema, self.t.get('Properties', {}), self.stack.resolve_runtime_data, self.name) return self._do_action(self.CREATE, self.properties.validate)
def handle_update(self, json_snippet, tmpl_diff, prop_diff): """ If Properties has changed, update self.properties, so we get the new values during any subsequent adjustment. """ if tmpl_diff: # parse update policy if 'UpdatePolicy' in tmpl_diff: self.update_policy = Properties( self.update_policy_schema, json_snippet.get('UpdatePolicy', {}), parent_name=self.name, context=self.context) if prop_diff: self.properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), function.resolve, self.name, self.context) # Replace instances first if launch configuration has changed self._try_rolling_update(prop_diff) # Get the current capacity, we may need to adjust if # MinSize or MaxSize has changed capacity = len(self.get_instances()) # Figure out if an adjustment is required new_capacity = None if self.MIN_SIZE in prop_diff: if capacity < self.properties[self.MIN_SIZE]: new_capacity = self.properties[self.MIN_SIZE] if self.MAX_SIZE in prop_diff: if capacity > self.properties[self.MAX_SIZE]: new_capacity = self.properties[self.MAX_SIZE] if self.DESIRED_CAPACITY in prop_diff: if self.properties[self.DESIRED_CAPACITY] is not None: new_capacity = self.properties[self.DESIRED_CAPACITY] if new_capacity is not None: self.adjust(new_capacity, adjustment_type=EXACT_CAPACITY)
def create(self): """ Create the resource. Subclasses should provide a handle_create() method to customise creation. """ if (self.action, self.status) != (self.INIT, self.COMPLETE): exc = exception.Error("State %s invalid for create" % str(self.state)) raise exception.ResourceFailure(exc) logger.info("creating %s" % str(self)) # Re-resolve the template, since if the resource Ref's # the AWS::StackId pseudo parameter, it will change after # the parser.Stack is stored (which is after the resources # are __init__'d, but before they are create()'d) self.t = self.stack.resolve_static_data(self.json_snippet) self.properties = Properties( self.properties_schema, self.t.get("Properties", {}), self.stack.resolve_runtime_data, self.name ) return self._do_action(self.CREATE, self.properties.validate)
def handle_update(self, json_snippet, tmpl_diff, prop_diff): """ If Properties has changed, update self.properties, so we get the new values during any subsequent adjustment. """ if tmpl_diff: # parse update policy if 'UpdatePolicy' in tmpl_diff: self.update_policy = Properties( self.update_policy_schema, json_snippet.get('UpdatePolicy', {}), parent_name=self.name) if prop_diff: self.properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), self.stack.resolve_runtime_data, self.name) # Get the current capacity, we may need to adjust if # MinSize or MaxSize has changed capacity = len(self.get_instances()) # Figure out if an adjustment is required new_capacity = None if 'MinSize' in prop_diff: if capacity < int(self.properties['MinSize']): new_capacity = int(self.properties['MinSize']) if 'MaxSize' in prop_diff: if capacity > int(self.properties['MaxSize']): new_capacity = int(self.properties['MaxSize']) if 'DesiredCapacity' in prop_diff: if self.properties['DesiredCapacity']: new_capacity = int(self.properties['DesiredCapacity']) if new_capacity is not None: self.adjust(new_capacity, adjustment_type='ExactCapacity')
class Resource(object): ACTIONS = (INIT, CREATE, DELETE, UPDATE, ROLLBACK, SUSPEND, RESUME, ADOPT ) = ('INIT', 'CREATE', 'DELETE', 'UPDATE', 'ROLLBACK', 'SUSPEND', 'RESUME', 'ADOPT') STATUSES = (IN_PROGRESS, FAILED, COMPLETE ) = ('IN_PROGRESS', 'FAILED', 'COMPLETE') # If True, this resource must be created before it can be referenced. strict_dependency = True # Resource implementation set this to the subset of resource properties # supported for handle_update, used by update_template_diff_properties update_allowed_properties = () # Resource implementations set this to the name: description dictionary # that describes the appropriate resource attributes attributes_schema = {} # If True, this resource may perform authenticated API requests # throughout its lifecycle requires_deferred_auth = False # Limit to apply to physical_resource_name() size reduction algorithm. # If set to None no limit will be applied. physical_resource_name_limit = 255 support_status = support.SupportStatus() def __new__(cls, name, json, stack): '''Create a new Resource of the appropriate class for its type.''' if cls != Resource: # Call is already for a subclass, so pass it through return super(Resource, cls).__new__(cls) # Select the correct subclass to instantiate ResourceClass = stack.env.get_class(json.get('Type'), resource_name=name) return ResourceClass(name, json, stack) def __init__(self, name, definition, stack): if '/' in name: raise ValueError(_('Resource name may not contain "/"')) self.stack = stack self.context = stack.context self.name = name if isinstance(definition, rsrc_defn.ResourceDefinition): self.t = definition else: self.t = self.stack.resolve_static_data(definition) self.reparse() self.attributes = Attributes(self.name, self.attributes_schema, self._resolve_attribute) self.abandon_in_progress = False resource = stack.db_resource_get(name) if resource: self.resource_id = resource.nova_instance self.action = resource.action self.status = resource.status self.status_reason = resource.status_reason self.id = resource.id try: self._data = db_api.resource_data_get_all(self, resource.data) except exception.NotFound: self._data = {} self._rsrc_metadata = resource.rsrc_metadata self.created_time = resource.created_at self.updated_time = resource.updated_at else: self.resource_id = None # if the stack is being deleted, assume we've already been deleted if stack.action == stack.DELETE: self.action = self.DELETE else: self.action = self.INIT self.status = self.COMPLETE self.status_reason = '' self.id = None self._data = {} self._rsrc_metadata = None self.created_time = None self.updated_time = None def reparse(self): self.properties = Properties(self.properties_schema, self.t.get('Properties', {}), function.resolve, self.name, self.context) def __eq__(self, other): '''Allow == comparison of two resources.''' # For the purposes of comparison, we declare two resource objects # equal if their names and parsed_templates are the same if isinstance(other, Resource): return (self.name == other.name) and ( self.parsed_template() == other.parsed_template()) return NotImplemented def __ne__(self, other): '''Allow != comparison of two resources.''' result = self.__eq__(other) if result is NotImplemented: return result return not result def metadata_get(self, refresh=False): if refresh: self._rsrc_metadata = None if self.id is None: return self.parsed_template('Metadata') if self._rsrc_metadata is not None: return self._rsrc_metadata rs = db_api.resource_get(self.stack.context, self.id) rs.refresh(attrs=['rsrc_metadata']) self._rsrc_metadata = rs.rsrc_metadata return rs.rsrc_metadata def metadata_set(self, metadata): if self.id is None: raise exception.ResourceNotAvailable(resource_name=self.name) rs = db_api.resource_get(self.stack.context, self.id) rs.update_and_save({'rsrc_metadata': metadata}) self._rsrc_metadata = metadata def type(self): return self.t['Type'] def has_interface(self, resource_type): """Check to see if this resource is either mapped to resource_type or is a "resource_type". """ if self.type() == resource_type: return True ri = self.stack.env.get_resource_info(self.type(), self.name) return ri.name == resource_type def implementation_signature(self): ''' Return a tuple defining the implementation. This should be broken down into a definition and an implementation version. ''' return (self.__class__.__name__, self.support_status.version) def identifier(self): '''Return an identifier for this resource.''' return identifier.ResourceIdentifier(resource_name=self.name, **self.stack.identifier()) def parsed_template(self, section=None, default={}): ''' Return the parsed template data for the resource. May be limited to only one section of the data, in which case a default value may also be supplied. ''' if section is None: template = self.t else: template = self.t.get(section, default) return function.resolve(template) def update_template_diff(self, after, before): ''' Returns the difference between the before and after json snippets. If something has been removed in after which exists in before we set it to None. ''' # Create a set containing the keys in both current and update template template_keys = set(before.keys()) template_keys.update(set(after.keys())) # Create a set of keys which differ (or are missing/added) changed_keys_set = set([k for k in template_keys if before.get(k) != after.get(k)]) return dict((k, after.get(k)) for k in changed_keys_set) def update_template_diff_properties(self, after_props, before_props): ''' Returns the changed Properties between the before and after properties. If any properties have changed which are not in update_allowed_properties, raises UpdateReplace. ''' update_allowed_set = set(self.update_allowed_properties) for (psk, psv) in self.properties.props.iteritems(): if psv.update_allowed(): update_allowed_set.add(psk) # Create a set of keys which differ (or are missing/added) changed_properties_set = set(k for k in after_props if before_props.get(k) != after_props.get(k)) if not changed_properties_set.issubset(update_allowed_set): raise UpdateReplace(self.name) return dict((k, after_props.get(k)) for k in changed_properties_set) def __str__(self): if self.stack.id: if self.resource_id: return '%s "%s" [%s] %s' % (self.__class__.__name__, self.name, self.resource_id, str(self.stack)) return '%s "%s" %s' % (self.__class__.__name__, self.name, str(self.stack)) return '%s "%s"' % (self.__class__.__name__, self.name) def add_dependencies(self, deps): for dep in self.t.dependencies(self.stack): deps += (self, dep) deps += (self, None) def required_by(self): ''' Returns a list of names of resources which directly require this resource as a dependency. ''' return list( [r.name for r in self.stack.dependencies.required_by(self)]) def keystone(self): return self.stack.clients.keystone() def nova(self, service_type='compute'): return self.stack.clients.nova(service_type) def swift(self): return self.stack.clients.swift() def neutron(self): return self.stack.clients.neutron() def cinder(self): return self.stack.clients.cinder() def trove(self): return self.stack.clients.trove() def ceilometer(self): return self.stack.clients.ceilometer() def heat(self): return self.stack.clients.heat() def glance(self): return self.stack.clients.glance() def _do_action(self, action, pre_func=None, resource_data=None): ''' Perform a transition to a new state via a specified action action should be e.g self.CREATE, self.UPDATE etc, we set status based on this, the transition is handled by calling the corresponding handle_* and check_*_complete functions Note pre_func is an optional function reference which will be called before the handle_<action> function If the resource does not declare a check_$action_complete function, we declare COMPLETE status as soon as the handle_$action call has finished, and if no handle_$action function is declared, then we do nothing, useful e.g if the resource requires no action for a given state transition ''' assert action in self.ACTIONS, 'Invalid action %s' % action try: self.state_set(action, self.IN_PROGRESS) action_l = action.lower() handle = getattr(self, 'handle_%s' % action_l, None) check = getattr(self, 'check_%s_complete' % action_l, None) if callable(pre_func): pre_func() handle_data = None if callable(handle): handle_data = (handle(resource_data) if resource_data else handle()) yield if callable(check): while not check(handle_data): yield except Exception as ex: LOG.exception('%s : %s' % (action, str(self))) # noqa failure = exception.ResourceFailure(ex, self, action) self.state_set(action, self.FAILED, six.text_type(failure)) raise failure except: with excutils.save_and_reraise_exception(): try: self.state_set(action, self.FAILED, '%s aborted' % action) except Exception: LOG.exception(_('Error marking resource as failed')) else: self.state_set(action, self.COMPLETE) def preview(self): ''' Default implementation of Resource.preview. This method should be overridden by child classes for specific behavior. ''' return self def create(self): ''' Create the resource. Subclasses should provide a handle_create() method to customise creation. ''' action = self.CREATE if (self.action, self.status) != (self.INIT, self.COMPLETE): exc = exception.Error(_('State %s invalid for create') % str(self.state)) raise exception.ResourceFailure(exc, self, action) LOG.info(_('creating %s') % str(self)) # Re-resolve the template, since if the resource Ref's # the StackId pseudo parameter, it will change after # the parser.Stack is stored (which is after the resources # are __init__'d, but before they are create()'d) self.reparse() return self._do_action(action, self.properties.validate) def prepare_abandon(self): self.abandon_in_progress = True return { 'name': self.name, 'resource_id': self.resource_id, 'type': self.type(), 'action': self.action, 'status': self.status, 'metadata': self.metadata_get(refresh=True), 'resource_data': self.data() } def adopt(self, resource_data): ''' Adopt the existing resource. Resource subclasses can provide a handle_adopt() method to customise adopt. ''' return self._do_action(self.ADOPT, resource_data=resource_data) def handle_adopt(self, resource_data=None): resource_id, data, metadata = self._get_resource_info(resource_data) if not resource_id: exc = Exception(_('Resource ID was not provided.')) failure = exception.ResourceFailure(exc, self) raise failure # set resource id self.resource_id_set(resource_id) # save the resource data if data and isinstance(data, dict): for key, value in data.iteritems(): self.data_set(key, value) # save the resource metadata self.metadata_set(metadata) def _get_resource_info(self, resource_data): if not resource_data: return None, None, None return (resource_data.get('resource_id'), resource_data.get('resource_data'), resource_data.get('metadata')) def update(self, after, before=None, prev_resource=None): ''' update the resource. Subclasses should provide a handle_update() method to customise update, the base-class handle_update will fail by default. ''' action = self.UPDATE (cur_class_def, cur_ver) = self.implementation_signature() prev_ver = cur_ver if prev_resource is not None: (prev_class_def, prev_ver) = prev_resource.implementation_signature() if prev_class_def != cur_class_def: raise UpdateReplace(self.name) if before is None: before = self.parsed_template() if prev_ver == cur_ver and before == after: return if (self.action, self.status) in ((self.CREATE, self.IN_PROGRESS), (self.UPDATE, self.IN_PROGRESS), (self.ADOPT, self.IN_PROGRESS)): exc = Exception(_('Resource update already requested')) raise exception.ResourceFailure(exc, self, action) LOG.info(_('updating %s') % str(self)) try: self.updated_time = datetime.utcnow() self.state_set(action, self.IN_PROGRESS) before_properties = Properties(self.properties_schema, before.get('Properties', {}), function.resolve, self.name, self.context) after_properties = Properties(self.properties_schema, after.get('Properties', {}), function.resolve, self.name, self.context) after_properties.validate() tmpl_diff = self.update_template_diff(function.resolve(after), before) prop_diff = self.update_template_diff_properties(after_properties, before_properties) if callable(getattr(self, 'handle_update', None)): handle_data = self.handle_update(after, tmpl_diff, prop_diff) yield if callable(getattr(self, 'check_update_complete', None)): while not self.check_update_complete(handle_data): yield except UpdateReplace: with excutils.save_and_reraise_exception(): LOG.debug("Resource %s update requires replacement" % self.name) except Exception as ex: LOG.exception(_('update %(resource)s : %(err)s') % {'resource': str(self), 'err': ex}) failure = exception.ResourceFailure(ex, self, action) self.state_set(action, self.FAILED, six.text_type(failure)) raise failure else: self.t = after self.reparse() self.state_set(action, self.COMPLETE) def suspend(self): ''' Suspend the resource. Subclasses should provide a handle_suspend() method to implement suspend ''' action = self.SUSPEND # Don't try to suspend the resource unless it's in a stable state if (self.action == self.DELETE or self.status != self.COMPLETE): exc = exception.Error(_('State %s invalid for suspend') % str(self.state)) raise exception.ResourceFailure(exc, self, action) LOG.info(_('suspending %s') % str(self)) return self._do_action(action) def resume(self): ''' Resume the resource. Subclasses should provide a handle_resume() method to implement resume ''' action = self.RESUME # Can't resume a resource unless it's SUSPEND_COMPLETE if self.state != (self.SUSPEND, self.COMPLETE): exc = exception.Error(_('State %s invalid for resume') % str(self.state)) raise exception.ResourceFailure(exc, self, action) LOG.info(_('resuming %s') % str(self)) return self._do_action(action) def physical_resource_name(self): if self.id is None: return None name = '%s-%s-%s' % (self.stack.name, self.name, short_id.get_id(self.id)) if self.physical_resource_name_limit: name = self.reduce_physical_resource_name( name, self.physical_resource_name_limit) return name @staticmethod def reduce_physical_resource_name(name, limit): ''' Reduce length of physical resource name to a limit. The reduced name will consist of the following: * the first 2 characters of the name * a hyphen * the end of the name, truncated on the left to bring the name length within the limit :param name: The name to reduce the length of :param limit: The max length limit :returns: A name whose length is less than or equal to the limit ''' if len(name) <= limit: return name if limit < 4: raise ValueError(_('limit cannot be less than 4')) postfix_length = limit - 3 return name[0:2] + '-' + name[-postfix_length:] def validate(self): LOG.info(_('Validating %s') % str(self)) function.validate(self.t) self.validate_deletion_policy(self.t) return self.properties.validate() @classmethod def validate_deletion_policy(cls, template): deletion_policy = template.get('DeletionPolicy', DELETE) if deletion_policy not in DELETION_POLICY: msg = _('Invalid DeletionPolicy %s') % deletion_policy raise exception.StackValidationFailed(message=msg) elif deletion_policy == SNAPSHOT: if not callable(getattr(cls, 'handle_snapshot_delete', None)): msg = _('Snapshot DeletionPolicy not supported') raise exception.StackValidationFailed(message=msg) def delete(self): ''' Delete the resource. Subclasses should provide a handle_delete() method to customise deletion. ''' action = self.DELETE if (self.action, self.status) == (self.DELETE, self.COMPLETE): return # No need to delete if the resource has never been created if self.action == self.INIT: return initial_state = self.state LOG.info(_('deleting %s') % str(self)) try: self.state_set(action, self.IN_PROGRESS) if self.abandon_in_progress: deletion_policy = RETAIN else: deletion_policy = self.t.get('DeletionPolicy', DELETE) handle_data = None if deletion_policy == DELETE: if callable(getattr(self, 'handle_delete', None)): handle_data = self.handle_delete() yield elif deletion_policy == SNAPSHOT: if callable(getattr(self, 'handle_snapshot_delete', None)): handle_data = self.handle_snapshot_delete(initial_state) yield if (deletion_policy != RETAIN and callable(getattr(self, 'check_delete_complete', None))): while not self.check_delete_complete(handle_data): yield except Exception as ex: LOG.exception(_('Delete %s') % str(self)) failure = exception.ResourceFailure(ex, self, self.action) self.state_set(action, self.FAILED, six.text_type(failure)) raise failure except: with excutils.save_and_reraise_exception(): try: self.state_set(action, self.FAILED, 'Deletion aborted') except Exception: LOG.exception(_('Error marking resource deletion failed')) else: self.state_set(action, self.COMPLETE) @scheduler.wrappertask def destroy(self): ''' Delete the resource and remove it from the database. ''' yield self.delete() if self.id is None: return try: db_api.resource_get(self.context, self.id).delete() except exception.NotFound: # Don't fail on delete if the db entry has # not been created yet. pass self.id = None def resource_id_set(self, inst): self.resource_id = inst if self.id is not None: try: rs = db_api.resource_get(self.context, self.id) rs.update_and_save({'nova_instance': self.resource_id}) except Exception as ex: LOG.warn(_('db error %s') % ex) def _store(self): '''Create the resource in the database.''' metadata = self.metadata_get() try: rs = {'action': self.action, 'status': self.status, 'status_reason': self.status_reason, 'stack_id': self.stack.id, 'nova_instance': self.resource_id, 'name': self.name, 'rsrc_metadata': metadata, 'stack_name': self.stack.name} new_rs = db_api.resource_create(self.context, rs) self.id = new_rs.id self.created_time = new_rs.created_at self._rsrc_metadata = metadata except Exception as ex: LOG.error(_('DB error %s') % ex) def _add_event(self, action, status, reason): '''Add a state change event to the database.''' ev = event.Event(self.context, self.stack, action, status, reason, self.resource_id, self.properties, self.name, self.type()) ev.store() def _store_or_update(self, action, status, reason): self.action = action self.status = status self.status_reason = reason if self.id is not None: try: rs = db_api.resource_get(self.context, self.id) rs.update_and_save({'action': self.action, 'status': self.status, 'status_reason': reason, 'stack_id': self.stack.id, 'updated_at': self.updated_time, 'nova_instance': self.resource_id}) except Exception as ex: LOG.error(_('DB error %s') % ex) # store resource in DB on transition to CREATE_IN_PROGRESS # all other transitions (other than to DELETE_COMPLETE) # should be handled by the update_and_save above.. elif (action, status) in [(self.CREATE, self.IN_PROGRESS), (self.ADOPT, self.IN_PROGRESS)]: self._store() def _resolve_attribute(self, name): """ Default implementation; should be overridden by resources that expose attributes :param name: The attribute to resolve :returns: the resource attribute named key """ # By default, no attributes resolve pass def state_reset(self): """ Reset state to (INIT, COMPLETE) """ self.action = self.INIT self.status = self.COMPLETE def state_set(self, action, status, reason="state changed"): if action not in self.ACTIONS: raise ValueError(_("Invalid action %s") % action) if status not in self.STATUSES: raise ValueError(_("Invalid status %s") % status) old_state = (self.action, self.status) new_state = (action, status) self._store_or_update(action, status, reason) if new_state != old_state: self._add_event(action, status, reason) @property def state(self): '''Returns state, tuple of action, status.''' return (self.action, self.status) def FnGetRefId(self): ''' For the intrinsic function Ref. :results: the id or name of the resource. ''' if self.resource_id is not None: return unicode(self.resource_id) else: return unicode(self.name) def FnGetAtt(self, key): ''' For the intrinsic function Fn::GetAtt. :param key: the attribute key. :returns: the attribute value. ''' try: return self.attributes[key] except KeyError: raise exception.InvalidTemplateAttribute(resource=self.name, key=key) def FnBase64(self, data): ''' For the instrinsic function Fn::Base64. :param data: the input data. :returns: the Base64 representation of the input data. ''' return base64.b64encode(data) def signal(self, details=None): ''' signal the resource. Subclasses should provide a handle_signal() method to implement the signal, the base-class raise an exception if no handler is implemented. ''' def get_string_details(): if details is None: return 'No signal details provided' if isinstance(details, basestring): return details if isinstance(details, dict): if all(k in details for k in ('previous', 'current', 'reason')): # this is from Ceilometer. auto = '%(previous)s to %(current)s (%(reason)s)' % details return 'alarm state changed from %s' % auto elif 'state' in details: # this is from watchrule return 'alarm state changed to %(state)s' % details elif 'deploy_status_code' in details: # this is for SoftwareDeployment if details['deploy_status_code'] == 0: return 'deployment succeeded' else: return ('deployment failed ' '(%(deploy_status_code)s)' % details) return 'Unknown' try: if not callable(getattr(self, 'handle_signal', None)): msg = (_('Resource %s is not able to receive a signal') % str(self)) raise Exception(msg) self._add_event('signal', self.status, get_string_details()) self.handle_signal(details) except Exception as ex: LOG.exception(_('signal %(name)s : %(msg)s') % {'name': str(self), 'msg': ex}) failure = exception.ResourceFailure(ex, self) raise failure def handle_update(self, json_snippet=None, tmpl_diff=None, prop_diff=None): if prop_diff: raise UpdateReplace(self.name) def metadata_update(self, new_metadata=None): ''' No-op for resources which don't explicitly override this method ''' if new_metadata: LOG.warning(_("Resource %s does not implement metadata update") % self.name) @classmethod def resource_to_template(cls, resource_type): ''' :param resource_type: The resource type to be displayed in the template :returns: A template where the resource's properties_schema is mapped as parameters, and the resource's attributes_schema is mapped as outputs ''' (parameters, properties) = (Properties. schema_to_parameters_and_properties( cls.properties_schema)) resource_name = cls.__name__ return { 'HeatTemplateFormatVersion': '2012-12-12', 'Parameters': parameters, 'Resources': { resource_name: { 'Type': resource_type, 'Properties': properties } }, 'Outputs': Attributes.as_outputs(resource_name, cls) } def data(self): ''' Resource data for this resource Use methods data_set and data_delete to modify the resource data for this resource. :returns: a dict representing the resource data for this resource. ''' if self._data is None and self.id: try: self._data = db_api.resource_data_get_all(self) except exception.NotFound: pass return self._data or {} def data_set(self, key, value, redact=False): '''Save resource's key/value pair to database.''' db_api.resource_data_set(self, key, value, redact) # force fetch all resource data from the database again self._data = None def data_delete(self, key): ''' Remove a resource_data element associated to a resource. :returns: True if the key existed to delete ''' try: db_api.resource_data_delete(self, key) except exception.NotFound: return False else: # force fetch all resource data from the database again self._data = None return True
class Resource(object): # Status strings CREATE_IN_PROGRESS = 'IN_PROGRESS' CREATE_FAILED = 'CREATE_FAILED' CREATE_COMPLETE = 'CREATE_COMPLETE' DELETE_IN_PROGRESS = 'DELETE_IN_PROGRESS' DELETE_FAILED = 'DELETE_FAILED' DELETE_COMPLETE = 'DELETE_COMPLETE' UPDATE_IN_PROGRESS = 'UPDATE_IN_PROGRESS' UPDATE_FAILED = 'UPDATE_FAILED' UPDATE_COMPLETE = 'UPDATE_COMPLETE' # Status values, returned from subclasses to indicate update method UPDATE_REPLACE = 'UPDATE_REPLACE' UPDATE_INTERRUPTION = 'UPDATE_INTERRUPTION' UPDATE_NO_INTERRUPTION = 'UPDATE_NO_INTERRUPTION' UPDATE_NOT_IMPLEMENTED = 'UPDATE_NOT_IMPLEMENTED' # If True, this resource must be created before it can be referenced. strict_dependency = True created_time = timestamp.Timestamp(db_api.resource_get, 'created_at') updated_time = timestamp.Timestamp(db_api.resource_get, 'updated_at') metadata = Metadata() def __new__(cls, name, json, stack): '''Create a new Resource of the appropriate class for its type.''' if cls != Resource: # Call is already for a subclass, so pass it through return super(Resource, cls).__new__(cls) # Select the correct subclass to instantiate ResourceClass = get_class(json['Type']) or GenericResource return ResourceClass(name, json, stack) def __init__(self, name, json_snippet, stack): if '/' in name: raise ValueError(_('Resource name may not contain "/"')) self.references = [] self.stack = stack self.context = stack.context self.name = name self.t = stack.resolve_static_data(json_snippet) self.properties = Properties(self.properties_schema, self.t.get('Properties', {}), self.stack.resolve_runtime_data, self.name) resource = db_api.resource_get_by_name_and_stack(self.context, name, stack.id) if resource: self.resource_id = resource.nova_instance self.state = resource.state self.state_description = resource.state_description self.id = resource.id else: self.resource_id = None self.state = None self.state_description = '' self.id = None self._nova = {} self._keystone = None self._swift = None self._quantum = None def __eq__(self, other): '''Allow == comparison of two resources''' # For the purposes of comparison, we declare two resource objects # equal if their names and parsed_templates are the same if isinstance(other, Resource): return (self.name == other.name) and ( self.parsed_template() == other.parsed_template()) return NotImplemented def __ne__(self, other): '''Allow != comparison of two resources''' result = self.__eq__(other) if result is NotImplemented: return result return not result def type(self): return self.t['Type'] def identifier(self): '''Return an identifier for this resource''' return identifier.ResourceIdentifier(resource_name=self.name, **self.stack.identifier()) def parsed_template(self, section=None, default={}): ''' Return the parsed template data for the resource. May be limited to only one section of the data, in which case a default value may also be supplied. ''' if section is None: template = self.t else: template = self.t.get(section, default) return self.stack.resolve_runtime_data(template) def __str__(self): return '%s "%s"' % (self.__class__.__name__, self.name) def _add_dependencies(self, deps, fragment): if isinstance(fragment, dict): for key, value in fragment.items(): if key in ('DependsOn', 'Ref'): target = self.stack.resources[value] if key == 'DependsOn' or target.strict_dependency: deps += (self, target) elif key != 'Fn::GetAtt': self._add_dependencies(deps, value) elif isinstance(fragment, list): for item in fragment: self._add_dependencies(deps, item) def add_dependencies(self, deps): self._add_dependencies(deps, self.t) deps += (self, None) def keystone(self): return self.stack.clients.keystone() def nova(self, service_type='compute'): return self.stack.clients.nova(service_type) def swift(self): return self.stack.clients.swift() def quantum(self): return self.stack.clients.quantum() def create(self): ''' Create the resource. Subclasses should provide a handle_create() method to customise creation. ''' if self.state in (self.CREATE_IN_PROGRESS, self.CREATE_COMPLETE): return 'Resource creation already requested' logger.info('creating %s' % str(self)) try: err = self.properties.validate() if err: return err self.state_set(self.CREATE_IN_PROGRESS) if callable(getattr(self, 'handle_create', None)): self.handle_create() except Exception as ex: logger.exception('create %s', str(self)) self.state_set(self.CREATE_FAILED, str(ex)) return str(ex) else: self.state_set(self.CREATE_COMPLETE) def update(self, json_snippet=None): ''' update the resource. Subclasses should provide a handle_update() method to customise update, the base-class handle_update will fail by default. ''' if self.state in (self.CREATE_IN_PROGRESS, self.UPDATE_IN_PROGRESS): return 'Resource update already requested' if not json_snippet: return 'Must specify json snippet for resource update!' logger.info('updating %s' % str(self)) result = self.UPDATE_NOT_IMPLEMENTED try: self.state_set(self.UPDATE_IN_PROGRESS) self.t = self.stack.resolve_static_data(json_snippet) err = self.properties.validate() if err: return err if callable(getattr(self, 'handle_update', None)): result = self.handle_update() except Exception as ex: logger.exception('update %s : %s' % (str(self), str(ex))) self.state_set(self.UPDATE_FAILED, str(ex)) return str(ex) else: # If resource was updated (with or without interruption), # then we set the resource to UPDATE_COMPLETE if not result == self.UPDATE_REPLACE: self.state_set(self.UPDATE_COMPLETE) return result def physical_resource_name(self): return '%s.%s' % (self.stack.name, self.name) def physical_resource_name_find(self, resource_name): if resource_name in self.stack: return '%s.%s' % (self.stack.name, resource_name) else: raise IndexError('no such resource') def validate(self): logger.info('Validating %s' % str(self)) return self.properties.validate() def delete(self): ''' Delete the resource. Subclasses should provide a handle_delete() method to customise deletion. ''' if self.state == self.DELETE_COMPLETE: return if self.state == self.DELETE_IN_PROGRESS: return 'Resource deletion already in progress' logger.info('deleting %s (inst:%s db_id:%s)' % (str(self), self.resource_id, str(self.id))) self.state_set(self.DELETE_IN_PROGRESS) try: if callable(getattr(self, 'handle_delete', None)): self.handle_delete() except Exception as ex: logger.exception('Delete %s', str(self)) self.state_set(self.DELETE_FAILED, str(ex)) return str(ex) self.state_set(self.DELETE_COMPLETE) def destroy(self): ''' Delete the resource and remove it from the database. ''' result = self.delete() if result: return result if self.id is None: return try: db_api.resource_get(self.context, self.id).delete() except exception.NotFound: # Don't fail on delete if the db entry has # not been created yet. pass except Exception as ex: logger.exception('Delete %s from DB' % str(self)) return str(ex) self.id = None def resource_id_set(self, inst): self.resource_id = inst if self.id is not None: try: rs = db_api.resource_get(self.context, self.id) rs.update_and_save({'nova_instance': self.resource_id}) except Exception as ex: logger.warn('db error %s' % str(ex)) def _store(self): '''Create the resource in the database''' try: rs = {'state': self.state, 'stack_id': self.stack.id, 'nova_instance': self.resource_id, 'name': self.name, 'rsrc_metadata': self.metadata, 'stack_name': self.stack.name} new_rs = db_api.resource_create(self.context, rs) self.id = new_rs.id self.stack.updated_time = datetime.utcnow() except Exception as ex: logger.error('DB error %s' % str(ex)) def _add_event(self, new_state, reason): '''Add a state change event to the database''' ev = event.Event(self.context, self.stack, self, new_state, reason, self.resource_id, self.properties) try: ev.store() except Exception as ex: logger.error('DB error %s' % str(ex)) def _store_or_update(self, new_state, reason): self.state = new_state self.state_description = reason if self.id is not None: try: rs = db_api.resource_get(self.context, self.id) rs.update_and_save({'state': self.state, 'state_description': reason, 'nova_instance': self.resource_id}) self.stack.updated_time = datetime.utcnow() except Exception as ex: logger.error('DB error %s' % str(ex)) # store resource in DB on transition to CREATE_IN_PROGRESS # all other transistions (other than to DELETE_COMPLETE) # should be handled by the update_and_save above.. elif new_state == self.CREATE_IN_PROGRESS: self._store() def state_set(self, new_state, reason="state changed"): old_state = self.state self._store_or_update(new_state, reason) if new_state != old_state: self._add_event(new_state, reason) def FnGetRefId(self): ''' http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide/\ intrinsic-function-reference-ref.html ''' if self.resource_id is not None: return unicode(self.resource_id) else: return unicode(self.name) def FnGetAtt(self, key): ''' http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide/\ intrinsic-function-reference-getatt.html ''' return unicode(self.name) def FnBase64(self, data): ''' http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide/\ intrinsic-function-reference-base64.html ''' return base64.b64encode(data) def handle_update(self): raise NotImplementedError("Update not implemented for Resource %s" % type(self))
class InstanceGroup(stack_resource.StackResource): tags_schema = {'Key': {'Type': 'String', 'Required': True}, 'Value': {'Type': 'String', 'Required': True}} properties_schema = { 'AvailabilityZones': { 'Required': True, 'Type': 'List', 'Description': _('Not Implemented.')}, 'LaunchConfigurationName': { 'Required': True, 'Type': 'String', 'Description': _('Name of LaunchConfiguration resource.')}, 'Size': { 'Required': True, 'Type': 'Number', 'Description': _('Desired number of instances.')}, 'LoadBalancerNames': { 'Type': 'List', 'Description': _('List of LoadBalancer resources.')}, 'Tags': { 'Type': 'List', 'Schema': {'Type': 'Map', 'Schema': tags_schema}, 'Description': _('Tags to attach to this group.')} } update_allowed_keys = ('Properties', 'UpdatePolicy',) update_allowed_properties = ('Size', 'LaunchConfigurationName',) attributes_schema = { "InstanceList": _("A comma-delimited list of server ip addresses. " "(Heat extension).") } rolling_update_schema = { 'MinInstancesInService': properties.Schema(properties.NUMBER, default=0), 'MaxBatchSize': properties.Schema(properties.NUMBER, default=1), 'PauseTime': properties.Schema(properties.STRING, default='PT0S') } update_policy_schema = { 'RollingUpdate': properties.Schema(properties.MAP, schema=rolling_update_schema) } def __init__(self, name, json_snippet, stack): """ UpdatePolicy is currently only specific to InstanceGroup and AutoScalingGroup. Therefore, init is overridden to parse for the UpdatePolicy. """ super(InstanceGroup, self).__init__(name, json_snippet, stack) self.update_policy = Properties(self.update_policy_schema, self.t.get('UpdatePolicy', {}), parent_name=self.name) def validate(self): """ Add validation for update_policy """ super(InstanceGroup, self).validate() if self.update_policy: self.update_policy.validate() def get_instance_names(self): """Get a list of resource names of the instances in this InstanceGroup. Failed resources will be ignored. """ return sorted(x.name for x in self.get_instances()) def get_instances(self): """Get a set of all the instance resources managed by this group.""" return [resource for resource in self.nested().itervalues() if resource.state[1] != resource.FAILED] def handle_create(self): """Create a nested stack and add the initial resources to it.""" num_instances = int(self.properties['Size']) initial_template = self._create_template(num_instances) return self.create_with_template(initial_template, {}) def check_create_complete(self, task): """ When stack creation is done, update the load balancer. If any instances failed to be created, delete them. """ done = super(InstanceGroup, self).check_create_complete(task) if done: self._lb_reload() return done def handle_update(self, json_snippet, tmpl_diff, prop_diff): """ If Properties has changed, update self.properties, so we get the new values during any subsequent adjustment. """ if tmpl_diff: # parse update policy if 'UpdatePolicy' in tmpl_diff: self.update_policy = Properties( self.update_policy_schema, json_snippet.get('UpdatePolicy', {}), parent_name=self.name) if prop_diff: self.properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), self.stack.resolve_runtime_data, self.name) # Get the current capacity, we may need to adjust if # Size has changed if 'Size' in prop_diff: inst_list = self.get_instances() if len(inst_list) != int(self.properties['Size']): self.resize(int(self.properties['Size'])) def _tags(self): """ Make sure that we add a tag that Ceilometer can pick up. These need to be prepended with 'metering.'. """ tags = self.properties.get('Tags') or [] for t in tags: if t['Key'].startswith('metering.'): # the user has added one, don't add another. return tags return tags + [{'Key': 'metering.groupname', 'Value': self.FnGetRefId()}] def handle_delete(self): return self.delete_nested() def _create_template(self, num_instances): """ Create a template with a number of instance definitions based on the launch configuration. """ conf_name = self.properties['LaunchConfigurationName'] conf = self.stack.resource_by_refid(conf_name) instance_definition = copy.deepcopy(conf.t) instance_definition['Type'] = 'AWS::EC2::Instance' instance_definition['Properties']['Tags'] = self._tags() if self.properties.get('VPCZoneIdentifier'): instance_definition['Properties']['SubnetId'] = \ self.properties['VPCZoneIdentifier'][0] # resolve references within the context of this stack. fully_parsed = self.stack.resolve_runtime_data(instance_definition) resources = {} for i in range(num_instances): resources["%s-%d" % (self.name, i)] = fully_parsed return {"Resources": resources} def resize(self, new_capacity): """ Resize the instance group to the new capacity. When shrinking, the newest instances will be removed. """ new_template = self._create_template(new_capacity) try: updater = self.update_with_template(new_template, {}) updater.run_to_completion() self.check_update_complete(updater) finally: # Reload the LB in any case, so it's only pointing at healthy # nodes. self._lb_reload() def _lb_reload(self): ''' Notify the LoadBalancer to reload its config to include the changes in instances we have just made. This must be done after activation (instance in ACTIVE state), otherwise the instances' IP addresses may not be available. ''' if self.properties['LoadBalancerNames']: id_list = [inst.FnGetRefId() for inst in self.get_instances()] for lb in self.properties['LoadBalancerNames']: lb_resource = self.stack[lb] if 'Instances' in lb_resource.properties_schema: lb_resource.json_snippet['Properties']['Instances'] = ( id_list) elif 'members' in lb_resource.properties_schema: lb_resource.json_snippet['Properties']['members'] = ( id_list) else: raise exception.Error( "Unsupported resource '%s' in LoadBalancerNames" % (lb,)) resolved_snippet = self.stack.resolve_static_data( lb_resource.json_snippet) scheduler.TaskRunner(lb_resource.update, resolved_snippet)() def FnGetRefId(self): return self.physical_resource_name() def _resolve_attribute(self, name): ''' heat extension: "InstanceList" returns comma delimited list of server ip addresses. ''' if name == 'InstanceList': return u','.join(inst.FnGetAtt('PublicIp') for inst in self.get_instances()) or None
class AutoScalingGroup(InstanceGroup, CooldownMixin): tags_schema = {'Key': {'Type': 'String', 'Required': True}, 'Value': {'Type': 'String', 'Required': True}} properties_schema = { 'AvailabilityZones': { 'Required': True, 'Type': 'List', 'Description': _('Not Implemented.')}, 'LaunchConfigurationName': { 'Required': True, 'Type': 'String', 'Description': _('Name of LaunchConfiguration resource.')}, 'MaxSize': { 'Required': True, 'Type': 'String', 'Description': _('Maximum number of instances in the group.')}, 'MinSize': { 'Required': True, 'Type': 'String', 'Description': _('Minimum number of instances in the group.')}, 'Cooldown': { 'Type': 'String', 'Description': _('Cooldown period, in seconds.')}, 'DesiredCapacity': { 'Type': 'Number', 'Description': _('Desired initial number of instances.')}, 'HealthCheckGracePeriod': { 'Type': 'Integer', 'Implemented': False, 'Description': _('Not Implemented.')}, 'HealthCheckType': { 'Type': 'String', 'AllowedValues': ['EC2', 'ELB'], 'Implemented': False, 'Description': _('Not Implemented.')}, 'LoadBalancerNames': { 'Type': 'List', 'Description': _('List of LoadBalancer resources.')}, 'VPCZoneIdentifier': { 'Type': 'List', 'Description': _('List of VPC subnet identifiers.')}, 'Tags': { 'Type': 'List', 'Schema': {'Type': 'Map', 'Schema': tags_schema}, 'Description': _('Tags to attach to this group.')} } rolling_update_schema = { 'MinInstancesInService': properties.Schema(properties.NUMBER, default=0), 'MaxBatchSize': properties.Schema(properties.NUMBER, default=1), 'PauseTime': properties.Schema(properties.STRING, default='PT0S') } update_policy_schema = { 'AutoScalingRollingUpdate': properties.Schema( properties.MAP, schema=rolling_update_schema) } # template keys and properties supported for handle_update, # note trailing comma is required for a single item to get a tuple update_allowed_keys = ('Properties', 'UpdatePolicy',) update_allowed_properties = ('LaunchConfigurationName', 'MaxSize', 'MinSize', 'Cooldown', 'DesiredCapacity',) def handle_create(self): if self.properties['DesiredCapacity']: num_to_create = int(self.properties['DesiredCapacity']) else: num_to_create = int(self.properties['MinSize']) initial_template = self._create_template(num_to_create) return self.create_with_template(initial_template, {}) def check_create_complete(self, task): """Invoke the cooldown after creation succeeds.""" done = super(AutoScalingGroup, self).check_create_complete(task) if done: self._cooldown_timestamp( "%s : %s" % ('ExactCapacity', len(self.get_instances()))) return done def handle_update(self, json_snippet, tmpl_diff, prop_diff): """ If Properties has changed, update self.properties, so we get the new values during any subsequent adjustment. """ if tmpl_diff: # parse update policy if 'UpdatePolicy' in tmpl_diff: self.update_policy = Properties( self.update_policy_schema, json_snippet.get('UpdatePolicy', {}), parent_name=self.name) if prop_diff: self.properties = Properties(self.properties_schema, json_snippet.get('Properties', {}), self.stack.resolve_runtime_data, self.name) # Get the current capacity, we may need to adjust if # MinSize or MaxSize has changed capacity = len(self.get_instances()) # Figure out if an adjustment is required new_capacity = None if 'MinSize' in prop_diff: if capacity < int(self.properties['MinSize']): new_capacity = int(self.properties['MinSize']) if 'MaxSize' in prop_diff: if capacity > int(self.properties['MaxSize']): new_capacity = int(self.properties['MaxSize']) if 'DesiredCapacity' in prop_diff: if self.properties['DesiredCapacity']: new_capacity = int(self.properties['DesiredCapacity']) if new_capacity is not None: self.adjust(new_capacity, adjustment_type='ExactCapacity') def adjust(self, adjustment, adjustment_type='ChangeInCapacity'): """ Adjust the size of the scaling group if the cooldown permits. """ if self._cooldown_inprogress(): logger.info("%s NOT performing scaling adjustment, cooldown %s" % (self.name, self.properties['Cooldown'])) return capacity = len(self.get_instances()) if adjustment_type == 'ChangeInCapacity': new_capacity = capacity + adjustment elif adjustment_type == 'ExactCapacity': new_capacity = adjustment else: # PercentChangeInCapacity new_capacity = capacity + (capacity * adjustment / 100) if new_capacity > int(self.properties['MaxSize']): logger.warn('can not exceed %s' % self.properties['MaxSize']) return if new_capacity < int(self.properties['MinSize']): logger.warn('can not be less than %s' % self.properties['MinSize']) return if new_capacity == capacity: logger.debug('no change in capacity %d' % capacity) return result = self.resize(new_capacity) self._cooldown_timestamp("%s : %s" % (adjustment_type, adjustment)) return result def _tags(self): """Add Identifing Tags to all servers in the group. This is so the Dimensions received from cfn-push-stats all include the groupname and stack id. Note: the group name must match what is returned from FnGetRefId """ autoscaling_tag = [{'Key': 'AutoScalingGroupName', 'Value': self.FnGetRefId()}] return super(AutoScalingGroup, self)._tags() + autoscaling_tag def validate(self): res = super(AutoScalingGroup, self).validate() if res: return res # TODO(pasquier-s): once Neutron is able to assign subnets to # availability zones, it will be possible to specify multiple subnets. # For now, only one subnet can be specified. The bug #1096017 tracks # this issue. if self.properties.get('VPCZoneIdentifier') and \ len(self.properties['VPCZoneIdentifier']) != 1: raise exception.NotSupported(feature=_("Anything other than one " "VPCZoneIdentifier"))