Migrate BayModel to ClusterTemplate
Magnum has moved to the more industry-aligned terms of "cluster" and "cluster template" [1], so heat resources should align to this as well. This patch migrates 'OS::Magnum::BayModel' to 'OS::Magnum::ClusterTemplate', the old templates with 'OS::Magnum::BayModel' is still available. Also deprecate 'OS::Magnum::BayModel'. [1] https://blueprints.launchpad.net/magnum/+spec/rename-bay-to-cluster Co-Authored-By: huangtianhua@huawei.com Partial-Bug: #1625757 Change-Id: Iccad89da7a421a57f5944d8f36ce12d41b9872ab
This commit is contained in:
ricolin
parent
e8e0a2483a
commit
27346b8928
@ -11,187 +11,32 @@
|
||||
# License for the specific language governing permissions and limitations
|
||||
# under the License.
|
||||
|
||||
from heat.common import exception
|
||||
from heat.common.i18n import _
|
||||
from heat.engine import constraints
|
||||
from heat.engine import properties
|
||||
from heat.engine import resource
|
||||
from heat.engine.resources.openstack.magnum import cluster_template
|
||||
from heat.engine import support
|
||||
from heat.engine import translation
|
||||
|
||||
|
||||
class BayModel(resource.Resource):
|
||||
class BayModel(cluster_template.ClusterTemplate):
|
||||
"""A resource for the BayModel in Magnum.
|
||||
|
||||
This resource has been deprecated by ClusterTemplate.
|
||||
BayModel is an object that stores template information about the bay which
|
||||
is used to create new bays consistently.
|
||||
"""
|
||||
SSH_AUTHORIZED_KEY = 'ssh_authorized_key'
|
||||
|
||||
support_status = support.SupportStatus(version='5.0.0')
|
||||
|
||||
PROPERTIES = (
|
||||
NAME, IMAGE, FLAVOR, MASTER_FLAVOR, KEYPAIR,
|
||||
EXTERNAL_NETWORK, FIXED_NETWORK, DNS_NAMESERVER,
|
||||
DOCKER_VOLUME_SIZE, SSH_AUTHORIZED_KEY, COE, NETWORK_DRIVER,
|
||||
HTTP_PROXY, HTTPS_PROXY, NO_PROXY, LABELS, TLS_DISABLED, PUBLIC,
|
||||
REGISTRY_ENABLED, VOLUME_DRIVER
|
||||
) = (
|
||||
'name', 'image', 'flavor', 'master_flavor', 'keypair',
|
||||
'external_network', 'fixed_network', 'dns_nameserver',
|
||||
'docker_volume_size', 'ssh_authorized_key', 'coe', 'network_driver',
|
||||
'http_proxy', 'https_proxy', 'no_proxy', 'labels', 'tls_disabled',
|
||||
'public', 'registry_enabled', 'volume_driver'
|
||||
deprecate_msg = _('Please use OS::Magnum::ClusterTemplate instead.')
|
||||
support_status = support.SupportStatus(
|
||||
status=support.DEPRECATED,
|
||||
message=deprecate_msg,
|
||||
version='9.0.0',
|
||||
previous_status=support.SupportStatus(
|
||||
status=support.SUPPORTED,
|
||||
version='5.0.0'),
|
||||
substitute_class=cluster_template.ClusterTemplate
|
||||
)
|
||||
|
||||
# Change it when magnum supports more function in the future.
|
||||
SUPPORTED_VOLUME_DRIVER = {'kubernetes': ['cinder'], 'swarm': ['rexray'],
|
||||
'mesos': ['rexray']}
|
||||
|
||||
properties_schema = {
|
||||
NAME: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('The bay model name.'),
|
||||
),
|
||||
IMAGE: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('The image name or UUID to use as a base image for this '
|
||||
'baymodel.'),
|
||||
constraints=[
|
||||
constraints.CustomConstraint('glance.image')
|
||||
],
|
||||
required=True
|
||||
),
|
||||
FLAVOR: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('The flavor of this bay model.'),
|
||||
constraints=[
|
||||
constraints.CustomConstraint('nova.flavor')
|
||||
]
|
||||
),
|
||||
MASTER_FLAVOR: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('The flavor of the master node for this bay model.'),
|
||||
constraints=[
|
||||
constraints.CustomConstraint('nova.flavor')
|
||||
]
|
||||
),
|
||||
KEYPAIR: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('The name or id of the nova ssh keypair.'),
|
||||
constraints=[
|
||||
constraints.CustomConstraint('nova.keypair')
|
||||
],
|
||||
required=True
|
||||
),
|
||||
EXTERNAL_NETWORK: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('The external network to attach the Bay.'),
|
||||
constraints=[
|
||||
constraints.CustomConstraint('neutron.network')
|
||||
],
|
||||
required=True
|
||||
),
|
||||
FIXED_NETWORK: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('The fixed network to attach the Bay.'),
|
||||
constraints=[
|
||||
constraints.CustomConstraint('neutron.network')
|
||||
]
|
||||
),
|
||||
DNS_NAMESERVER: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('The DNS nameserver address.'),
|
||||
constraints=[
|
||||
constraints.CustomConstraint('ip_addr')
|
||||
]
|
||||
|
||||
),
|
||||
DOCKER_VOLUME_SIZE: properties.Schema(
|
||||
properties.Schema.INTEGER,
|
||||
_('The size in GB of the docker volume.'),
|
||||
constraints=[
|
||||
constraints.Range(min=1),
|
||||
]
|
||||
),
|
||||
SSH_AUTHORIZED_KEY: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('The SSH Authorized Key.'),
|
||||
support_status=support.SupportStatus(
|
||||
status=support.HIDDEN,
|
||||
version='6.0.0',
|
||||
message=_('This attribute has been removed in Magnum'),
|
||||
previous_status=support.SupportStatus(version='5.0.0')
|
||||
)
|
||||
),
|
||||
COE: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('The Container Orchestration Engine for this bay model.'),
|
||||
constraints=[
|
||||
constraints.AllowedValues(['kubernetes', 'swarm', 'mesos'])
|
||||
],
|
||||
required=True
|
||||
),
|
||||
NETWORK_DRIVER: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('The name of the driver used for instantiating '
|
||||
'container networks. By default, Magnum will choose the '
|
||||
'pre-configured network driver based on COE type.'),
|
||||
support_status=support.SupportStatus(version='6.0.0')
|
||||
),
|
||||
HTTP_PROXY: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('The http_proxy address to use for nodes in bay.'),
|
||||
support_status=support.SupportStatus(version='6.0.0')
|
||||
),
|
||||
HTTPS_PROXY: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('The https_proxy address to use for nodes in bay.'),
|
||||
support_status=support.SupportStatus(version='6.0.0')
|
||||
),
|
||||
NO_PROXY: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('A comma separated list of addresses for which proxies should '
|
||||
'not be used in the bay.'),
|
||||
support_status=support.SupportStatus(version='6.0.0')
|
||||
),
|
||||
LABELS: properties.Schema(
|
||||
properties.Schema.MAP,
|
||||
_('Arbitrary labels in the form of key=value pairs to '
|
||||
'associate with a baymodel.'),
|
||||
support_status=support.SupportStatus(version='6.0.0')
|
||||
),
|
||||
TLS_DISABLED: properties.Schema(
|
||||
properties.Schema.BOOLEAN,
|
||||
_('Disable TLS in the bay.'),
|
||||
default=False,
|
||||
support_status=support.SupportStatus(version='6.0.0')
|
||||
),
|
||||
PUBLIC: properties.Schema(
|
||||
properties.Schema.BOOLEAN,
|
||||
_('Make the baymodel public.'),
|
||||
default=False,
|
||||
support_status=support.SupportStatus(version='6.0.0')
|
||||
),
|
||||
REGISTRY_ENABLED: properties.Schema(
|
||||
properties.Schema.BOOLEAN,
|
||||
_('Enable the docker registry in the bay.'),
|
||||
default=False,
|
||||
support_status=support.SupportStatus(version='6.0.0')
|
||||
),
|
||||
VOLUME_DRIVER: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('The volume driver name for instantiating container volume.'),
|
||||
support_status=support.SupportStatus(version='7.0.0'),
|
||||
constraints=[
|
||||
constraints.AllowedValues(['cinder', 'rexray'])
|
||||
]
|
||||
),
|
||||
}
|
||||
|
||||
default_client_name = 'magnum'
|
||||
|
||||
entity = 'baymodels'
|
||||
|
||||
def translation_rules(self, props):
|
||||
if props.get(self.SSH_AUTHORIZED_KEY):
|
||||
return [
|
||||
@ -202,59 +47,6 @@ class BayModel(resource.Resource):
|
||||
)
|
||||
]
|
||||
|
||||
def validate(self):
|
||||
"""Validate the provided params."""
|
||||
super(BayModel, self).validate()
|
||||
|
||||
coe = self.properties[self.COE]
|
||||
volume_driver = self.properties[self.VOLUME_DRIVER]
|
||||
|
||||
# Confirm that volume driver is supported by Magnum COE per
|
||||
# SUPPORTED_VOLUME_DRIVER.
|
||||
value = self.SUPPORTED_VOLUME_DRIVER[coe]
|
||||
if volume_driver is not None and volume_driver not in value:
|
||||
msg = (_('Volume driver type %(driver)s is not supported by '
|
||||
'COE:%(coe)s, expecting a %(supported_volume_driver)s '
|
||||
'volume driver.') % {
|
||||
'driver': volume_driver, 'coe': coe,
|
||||
'supported_volume_driver': value})
|
||||
raise exception.StackValidationFailed(message=msg)
|
||||
|
||||
def handle_create(self):
|
||||
args = {
|
||||
'name': self.properties[self.NAME],
|
||||
'image_id': self.properties[self.IMAGE],
|
||||
'flavor_id': self.properties[self.FLAVOR],
|
||||
'master_flavor_id': self.properties[self.MASTER_FLAVOR],
|
||||
'keypair_id': self.properties[self.KEYPAIR],
|
||||
'external_network_id': self.properties[self.EXTERNAL_NETWORK],
|
||||
'fixed_network': self.properties[self.FIXED_NETWORK],
|
||||
'dns_nameserver': self.properties[self.DNS_NAMESERVER],
|
||||
'docker_volume_size': self.properties[self.DOCKER_VOLUME_SIZE],
|
||||
'coe': self.properties[self.COE],
|
||||
}
|
||||
if self.properties[self.NETWORK_DRIVER]:
|
||||
args['network_driver'] = self.properties[self.NETWORK_DRIVER]
|
||||
if self.properties[self.HTTP_PROXY]:
|
||||
args['http_proxy'] = self.properties[self. HTTP_PROXY]
|
||||
if self.properties[self.HTTPS_PROXY]:
|
||||
args['https_proxy'] = self.properties[self.HTTPS_PROXY]
|
||||
if self.properties[self.NO_PROXY]:
|
||||
args['no_proxy'] = self.properties[self.NO_PROXY]
|
||||
if self.properties[self.LABELS]:
|
||||
args['labels'] = self.properties[self.LABELS]
|
||||
if self.properties[self.TLS_DISABLED]:
|
||||
args['tls_disabled'] = self.properties[self.TLS_DISABLED]
|
||||
if self.properties[self.PUBLIC]:
|
||||
args['public'] = self.properties[self.PUBLIC]
|
||||
if self.properties[self.REGISTRY_ENABLED]:
|
||||
args['registry_enabled'] = self.properties[self.REGISTRY_ENABLED]
|
||||
if self.properties[self.VOLUME_DRIVER]:
|
||||
args['volume_driver'] = self.properties[self.VOLUME_DRIVER]
|
||||
|
||||
bm = self.client().baymodels.create(**args)
|
||||
self.resource_id_set(bm.uuid)
|
||||
|
||||
|
||||
def resource_mapping():
|
||||
return {
|
||||
|
||||
@ -47,6 +47,7 @@ class ResourceTypeTest(common.HeatTestCase):
|
||||
'OS::Designate::Record',
|
||||
'OS::Heat::HARestarter',
|
||||
'OS::Magnum::Bay',
|
||||
'OS::Magnum::BayModel',
|
||||
'OS::Glance::Image',
|
||||
'OS::Nova::FloatingIP',
|
||||
'OS::Nova::FloatingIPAssociation']),
|
||||
|
||||
@ -1,160 +0,0 @@
|
||||
#
|
||||
# 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 mock
|
||||
import six
|
||||
|
||||
from heat.common import exception
|
||||
from heat.common import template_format
|
||||
from heat.engine import resource
|
||||
from heat.engine.resources.openstack.magnum import baymodel
|
||||
from heat.engine import scheduler
|
||||
from heat.tests import common
|
||||
from heat.tests import utils
|
||||
|
||||
|
||||
RESOURCE_TYPE = 'OS::Magnum::BayModel'
|
||||
|
||||
|
||||
class TestMagnumBayModel(common.HeatTestCase):
|
||||
magnum_template = '''
|
||||
heat_template_version: 2015-04-30
|
||||
resources:
|
||||
test_baymodel:
|
||||
type: OS::Magnum::BayModel
|
||||
properties:
|
||||
name: test_bay_model
|
||||
image: fedora-21-atomic-2
|
||||
flavor: m1.small
|
||||
master_flavor: m1.medium
|
||||
keypair: heat_key
|
||||
external_network: 0244b54d-ae1f-44f0-a24a-442760f1d681
|
||||
fixed_network: 0f59a3dd-fac1-4d03-b41a-d4115fbffa89
|
||||
dns_nameserver: 8.8.8.8
|
||||
docker_volume_size: 5
|
||||
coe: 'swarm'
|
||||
'''
|
||||
|
||||
expected = {
|
||||
'name': 'test_bay_model',
|
||||
'image_id': 'fedora-21-atomic-2',
|
||||
'flavor_id': 'm1.small',
|
||||
'master_flavor_id': 'm1.medium',
|
||||
'keypair_id': 'heat_key',
|
||||
'external_network_id': '0244b54d-ae1f-44f0-a24a-442760f1d681',
|
||||
'fixed_network': '0f59a3dd-fac1-4d03-b41a-d4115fbffa89',
|
||||
'dns_nameserver': '8.8.8.8',
|
||||
'docker_volume_size': 5,
|
||||
'coe': 'swarm',
|
||||
}
|
||||
|
||||
def setUp(self):
|
||||
super(TestMagnumBayModel, self).setUp()
|
||||
resource._register_class(RESOURCE_TYPE, baymodel.BayModel)
|
||||
t = template_format.parse(self.magnum_template)
|
||||
self.stack = utils.parse_stack(t)
|
||||
|
||||
resource_defns = self.stack.t.resource_definitions(self.stack)
|
||||
self.rsrc_defn = resource_defns['test_baymodel']
|
||||
self.client = mock.Mock()
|
||||
self.patchobject(baymodel.BayModel, 'client',
|
||||
return_value=self.client)
|
||||
self.stub_FlavorConstraint_validate()
|
||||
self.stub_KeypairConstraint_validate()
|
||||
self.stub_ImageConstraint_validate()
|
||||
self.stub_NetworkConstraint_validate()
|
||||
|
||||
def _create_resource(self, name, snippet, stack):
|
||||
self.resource_id = '12345'
|
||||
self.test_bay_model = self.stack['test_baymodel']
|
||||
value = mock.MagicMock(uuid=self.resource_id)
|
||||
self.client.baymodels.create.return_value = value
|
||||
bm = baymodel.BayModel(name, snippet, stack)
|
||||
scheduler.TaskRunner(bm.create)()
|
||||
return bm
|
||||
|
||||
def test_bay_model_create(self):
|
||||
bm = self._create_resource('bm', self.rsrc_defn, self.stack)
|
||||
self.assertEqual(self.resource_id, bm.resource_id)
|
||||
self.assertEqual((bm.CREATE, bm.COMPLETE), bm.state)
|
||||
self.client.baymodels.create.assert_called_once_with(**self.expected)
|
||||
|
||||
|
||||
class TestMagnumBayModelWithAddedProperties(TestMagnumBayModel):
|
||||
magnum_template = '''
|
||||
heat_template_version: 2015-04-30
|
||||
resources:
|
||||
test_baymodel:
|
||||
type: OS::Magnum::BayModel
|
||||
properties:
|
||||
name: test_bay_model
|
||||
image: fedora-21-atomic-2
|
||||
flavor: m1.small
|
||||
master_flavor: m1.medium
|
||||
keypair: heat_key
|
||||
external_network: 0244b54d-ae1f-44f0-a24a-442760f1d681
|
||||
fixed_network: 0f59a3dd-fac1-4d03-b41a-d4115fbffa89
|
||||
dns_nameserver: 8.8.8.8
|
||||
docker_volume_size: 5
|
||||
coe: 'mesos'
|
||||
network_driver: 'flannel'
|
||||
http_proxy: 'http://proxy.com:123'
|
||||
https_proxy: 'https://proxy.com:123'
|
||||
no_proxy: '192.168.0.1'
|
||||
labels: {'flannel_cidr': ['10.101.0.0/16', '10.102.0.0/16']}
|
||||
tls_disabled: True
|
||||
public: True
|
||||
registry_enabled: True
|
||||
volume_driver: rexray
|
||||
'''
|
||||
expected = {
|
||||
'name': 'test_bay_model',
|
||||
'image_id': 'fedora-21-atomic-2',
|
||||
'flavor_id': 'm1.small',
|
||||
'master_flavor_id': 'm1.medium',
|
||||
'keypair_id': 'heat_key',
|
||||
'external_network_id': '0244b54d-ae1f-44f0-a24a-442760f1d681',
|
||||
'fixed_network': '0f59a3dd-fac1-4d03-b41a-d4115fbffa89',
|
||||
'dns_nameserver': '8.8.8.8',
|
||||
'docker_volume_size': 5,
|
||||
'coe': 'mesos',
|
||||
'network_driver': 'flannel',
|
||||
'http_proxy': 'http://proxy.com:123',
|
||||
'https_proxy': 'https://proxy.com:123',
|
||||
'no_proxy': '192.168.0.1',
|
||||
'labels': {'flannel_cidr': ['10.101.0.0/16', '10.102.0.0/16']},
|
||||
'tls_disabled': True,
|
||||
'public': True,
|
||||
'registry_enabled': True,
|
||||
'volume_driver': 'rexray'
|
||||
}
|
||||
|
||||
def setUp(self):
|
||||
super(TestMagnumBayModelWithAddedProperties, self).setUp()
|
||||
self.t = template_format.parse(self.magnum_template)
|
||||
|
||||
def test_bay_model_create_with_added_properties(self):
|
||||
bm = self._create_resource('bm', self.rsrc_defn, self.stack)
|
||||
self.assertEqual(self.resource_id, bm.resource_id)
|
||||
self.assertEqual((bm.CREATE, bm.COMPLETE), bm.state)
|
||||
self.client.baymodels.create.assert_called_once_with(**self.expected)
|
||||
|
||||
def test_validate_invalid_volume_driver(self):
|
||||
props = self.t['resources']['test_baymodel']['properties']
|
||||
props['volume_driver'] = 'cinder'
|
||||
stack = utils.parse_stack(self.t)
|
||||
msg = ("Volume driver type cinder is not supported by COE:mesos, "
|
||||
"expecting a ['rexray'] volume driver.")
|
||||
ex = self.assertRaises(exception.StackValidationFailed,
|
||||
stack['test_baymodel'].validate)
|
||||
self.assertEqual(msg, six.text_type(ex))
|
||||
Loading…
Reference in New Issue
Block a user