234 lines
8.4 KiB
Python
234 lines
8.4 KiB
Python
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
import collections
|
|
import copy
|
|
|
|
from heat.common import exception
|
|
from heat.engine import attributes
|
|
from heat.engine import constraints
|
|
from heat.engine import properties
|
|
from heat.engine import stack_resource
|
|
from heat.engine import template
|
|
from heat.openstack.common.gettextutils import _
|
|
|
|
template_template = {
|
|
"heat_template_version": "2013-05-23",
|
|
"resources": {}
|
|
}
|
|
|
|
|
|
class ResourceGroup(stack_resource.StackResource):
|
|
"""
|
|
A resource that creates one or more identically configured nested
|
|
resources.
|
|
|
|
In addition to the `refs` attribute, this resource implements synthetic
|
|
attributes that mirror those of the resources in the group. When
|
|
getting an attribute from this resource, however, a list of attribute
|
|
values for each resource in the group is returned. To get attribute values
|
|
for a single resource in the group, synthetic attributes of the form
|
|
`resource.{resource index}.{attribute name}` can be used. The resource ID
|
|
of a particular resource in the group can be obtained via the synthetic
|
|
attribute `resource.{resource index}`.
|
|
|
|
While each resource in the group will be identically configured, this
|
|
resource does allow for some index-based customization of the properties
|
|
of the resources in the group. For example::
|
|
|
|
resources:
|
|
my_indexed_group:
|
|
type: OS::Heat::ResourceGroup
|
|
properties:
|
|
count: 3
|
|
resource_def:
|
|
type: OS::Nova::Server
|
|
properties:
|
|
# create a unique name for each server
|
|
# using its index in the group
|
|
name: my_server_%index%
|
|
image: CentOS 6.5
|
|
flavor: 4GB Performance
|
|
|
|
would result in a group of three servers having the same image and flavor,
|
|
but names of `my_server_0`, `my_server_1`, and `my_server_2`. The variable
|
|
used for substitution can be customized by using the `index_var` property.
|
|
"""
|
|
|
|
PROPERTIES = (
|
|
COUNT, INDEX_VAR, RESOURCE_DEF,
|
|
) = (
|
|
'count', 'index_var', 'resource_def',
|
|
)
|
|
|
|
_RESOURCE_DEF_KEYS = (
|
|
RESOURCE_DEF_TYPE, RESOURCE_DEF_PROPERTIES,
|
|
) = (
|
|
'type', 'properties',
|
|
)
|
|
|
|
ATTRIBUTES = (
|
|
REFS,
|
|
) = (
|
|
'refs',
|
|
)
|
|
|
|
properties_schema = {
|
|
COUNT: properties.Schema(
|
|
properties.Schema.INTEGER,
|
|
_('The number of instances to create.'),
|
|
default=1,
|
|
constraints=[
|
|
constraints.Range(min=1),
|
|
],
|
|
update_allowed=True
|
|
),
|
|
INDEX_VAR: properties.Schema(
|
|
properties.Schema.STRING,
|
|
_('A variable that this resource will use to replace with the '
|
|
'current index of a given resource in the group. Can be used, '
|
|
'for example, to customize the name property of grouped '
|
|
'servers in order to differentiate them when listed with '
|
|
'nova client.'),
|
|
default="%index%",
|
|
constraints=[
|
|
constraints.Length(min=3)
|
|
]
|
|
),
|
|
RESOURCE_DEF: properties.Schema(
|
|
properties.Schema.MAP,
|
|
_('Resource definition for the resources in the group. The value '
|
|
'of this property is the definition of a resource just as if '
|
|
'it had been declared in the template itself.'),
|
|
schema={
|
|
RESOURCE_DEF_TYPE: properties.Schema(
|
|
properties.Schema.STRING,
|
|
_('The type of the resources in the group'),
|
|
required=True
|
|
),
|
|
RESOURCE_DEF_PROPERTIES: properties.Schema(
|
|
properties.Schema.MAP,
|
|
_('Property values for the resources in the group')
|
|
),
|
|
},
|
|
required=True
|
|
),
|
|
}
|
|
|
|
attributes_schema = {
|
|
REFS: attributes.Schema(
|
|
_("A list of resource IDs for the resources in the group")
|
|
),
|
|
}
|
|
|
|
def validate(self):
|
|
# validate our basic properties
|
|
super(ResourceGroup, self).validate()
|
|
# make sure the nested resource is valid
|
|
test_tmpl = self._assemble_nested(1, include_all=True)
|
|
val_templ = template.Template(test_tmpl)
|
|
res_def = val_templ.resource_definitions(self.stack)["0"]
|
|
res_class = self.stack.env.get_class(res_def.resource_type)
|
|
res_inst = res_class("%s:resource_def" % self.name, res_def,
|
|
self.stack)
|
|
res_inst.validate()
|
|
|
|
def handle_create(self):
|
|
count = self.properties[self.COUNT]
|
|
return self.create_with_template(self._assemble_nested(count),
|
|
{},
|
|
self.stack.timeout_mins)
|
|
|
|
def handle_update(self, new_snippet, tmpl_diff, prop_diff):
|
|
count = prop_diff.get(self.COUNT)
|
|
if count:
|
|
return self.update_with_template(self._assemble_nested(count),
|
|
{},
|
|
self.stack.timeout_mins)
|
|
|
|
def handle_delete(self):
|
|
return self.delete_nested()
|
|
|
|
def FnGetAtt(self, key, *path):
|
|
nested_stack = self.nested()
|
|
|
|
def get_rsrc_attr(resource_name, *attr_path):
|
|
try:
|
|
resource = nested_stack[resource_name]
|
|
except KeyError:
|
|
raise exception.InvalidTemplateAttribute(resource=self.name,
|
|
key=key)
|
|
if not attr_path:
|
|
return resource.FnGetRefId()
|
|
else:
|
|
return resource.FnGetAtt(*attr_path)
|
|
|
|
if key.startswith("resource."):
|
|
path = key.split(".", 2)[1:] + list(path)
|
|
return get_rsrc_attr(*path)
|
|
else:
|
|
if key == self.REFS:
|
|
path = []
|
|
else:
|
|
path = [key] + list(path)
|
|
|
|
count = self.properties[self.COUNT]
|
|
return [get_rsrc_attr(str(n), *path) for n in range(count)]
|
|
|
|
def _assemble_nested(self, count, include_all=False):
|
|
child_template = copy.deepcopy(template_template)
|
|
res_def = self.properties[self.RESOURCE_DEF]
|
|
if res_def[self.RESOURCE_DEF_PROPERTIES] is None:
|
|
res_def[self.RESOURCE_DEF_PROPERTIES] = {}
|
|
if not include_all:
|
|
resource_def_props = res_def[self.RESOURCE_DEF_PROPERTIES]
|
|
clean = dict((k, v) for k, v in resource_def_props.items() if v)
|
|
res_def[self.RESOURCE_DEF_PROPERTIES] = clean
|
|
|
|
def handle_repl_val(repl_var, idx, val):
|
|
recurse = lambda x: handle_repl_val(repl_var, idx, x)
|
|
if isinstance(val, basestring):
|
|
return val.replace(repl_var, str(idx))
|
|
elif isinstance(val, collections.Mapping):
|
|
return dict(zip(val, map(recurse, val.values())))
|
|
elif isinstance(val, collections.Sequence):
|
|
return map(recurse, val)
|
|
return val
|
|
|
|
def do_prop_replace(repl_var, idx, res_def):
|
|
props = res_def[self.RESOURCE_DEF_PROPERTIES]
|
|
if props:
|
|
props = handle_repl_val(repl_var, idx, props)
|
|
res_def[self.RESOURCE_DEF_PROPERTIES] = props
|
|
return res_def
|
|
|
|
repl_var = self.properties[self.INDEX_VAR]
|
|
resources = dict((str(k), do_prop_replace(repl_var, k,
|
|
copy.deepcopy(res_def)))
|
|
for k in range(count))
|
|
child_template['resources'] = resources
|
|
return child_template
|
|
|
|
def child_template(self):
|
|
count = self.properties[self.COUNT]
|
|
return self._assemble_nested(count)
|
|
|
|
def child_params(self):
|
|
return {}
|
|
|
|
|
|
def resource_mapping():
|
|
return {
|
|
'OS::Heat::ResourceGroup': ResourceGroup,
|
|
}
|