Merge "Add Container to Zun resources"
This commit is contained in:
Jenkins
Gerrit Code Review
commit
bc97d4d8e0
|
|
@ -0,0 +1,221 @@
|
|||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||
# not use this file except in compliance with the License. You may obtain
|
||||
# a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||
# License for the specific language governing permissions and limitations
|
||||
# under the License.
|
||||
|
||||
from heat.common import exception
|
||||
from heat.common.i18n import _
|
||||
from heat.engine import attributes
|
||||
from heat.engine import constraints
|
||||
from heat.engine import properties
|
||||
from heat.engine import resource
|
||||
from heat.engine import support
|
||||
|
||||
|
||||
class Container(resource.Resource):
|
||||
"""A resource that creates a Zun Container.
|
||||
|
||||
This resource creates a Zun container.
|
||||
"""
|
||||
|
||||
support_status = support.SupportStatus(version='9.0.0')
|
||||
|
||||
PROPERTIES = (
|
||||
NAME, IMAGE, COMMAND, CPU, MEMORY,
|
||||
ENVIRONMENT, WORKDIR, LABELS, IMAGE_PULL_POLICY,
|
||||
RESTART_POLICY, INTERACTIVE, IMAGE_DRIVER
|
||||
) = (
|
||||
'name', 'image', 'command', 'cpu', 'memory',
|
||||
'environment', 'workdir', 'labels', 'image_pull_policy',
|
||||
'restart_policy', 'interactive', 'image_driver'
|
||||
)
|
||||
|
||||
ATTRIBUTES = (
|
||||
NAME, ADDRESSES
|
||||
) = (
|
||||
'name', 'addresses'
|
||||
)
|
||||
|
||||
properties_schema = {
|
||||
NAME: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('Name of the container.'),
|
||||
update_allowed=True
|
||||
),
|
||||
IMAGE: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('Name or ID of the image.'),
|
||||
required=True
|
||||
),
|
||||
COMMAND: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('Send command to the container.'),
|
||||
),
|
||||
CPU: properties.Schema(
|
||||
properties.Schema.NUMBER,
|
||||
_('The number of virtual cpus.'),
|
||||
update_allowed=True
|
||||
),
|
||||
MEMORY: properties.Schema(
|
||||
properties.Schema.INTEGER,
|
||||
_('The container memory size in MiB.'),
|
||||
update_allowed=True
|
||||
),
|
||||
ENVIRONMENT: properties.Schema(
|
||||
properties.Schema.MAP,
|
||||
_('The environment variables.'),
|
||||
),
|
||||
WORKDIR: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('The working directory for commands to run in.'),
|
||||
),
|
||||
LABELS: properties.Schema(
|
||||
properties.Schema.MAP,
|
||||
_('Adds a map of labels to a container. '
|
||||
'May be used multiple times.'),
|
||||
),
|
||||
IMAGE_PULL_POLICY: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('The policy which determines if the image should '
|
||||
'be pulled prior to starting the container.'),
|
||||
constraints=[
|
||||
constraints.AllowedValues(['ifnotpresent', 'always',
|
||||
'never']),
|
||||
]
|
||||
),
|
||||
RESTART_POLICY: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('Restart policy to apply when a container exits. Possible '
|
||||
'values are "no", "on-failure[:max-retry]", "always", and '
|
||||
'"unless-stopped".'),
|
||||
),
|
||||
INTERACTIVE: properties.Schema(
|
||||
properties.Schema.BOOLEAN,
|
||||
_('Keep STDIN open even if not attached.'),
|
||||
),
|
||||
IMAGE_DRIVER: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('The image driver to use to pull container image.'),
|
||||
constraints=[
|
||||
constraints.AllowedValues(['docker', 'glance']),
|
||||
]
|
||||
),
|
||||
}
|
||||
|
||||
attributes_schema = {
|
||||
NAME: attributes.Schema(
|
||||
_('Name of the container.'),
|
||||
type=attributes.Schema.STRING
|
||||
),
|
||||
ADDRESSES: attributes.Schema(
|
||||
_('A dict of all network addresses with corresponding port_id. '
|
||||
'Each network will have two keys in dict, they are network '
|
||||
'name and network id. '
|
||||
'The port ID may be obtained through the following expression: '
|
||||
'"{get_attr: [<container>, addresses, <network name_or_id>, 0, '
|
||||
'port]}".'),
|
||||
type=attributes.Schema.MAP
|
||||
),
|
||||
}
|
||||
|
||||
default_client_name = 'zun'
|
||||
|
||||
entity = 'containers'
|
||||
|
||||
def validate(self):
|
||||
super(Container, self).validate()
|
||||
|
||||
policy = self.properties[self.RESTART_POLICY]
|
||||
if policy and not self._parse_restart_policy(policy):
|
||||
msg = _('restart_policy "%s" is invalid. Valid values are '
|
||||
'"no", "on-failure[:max-retry]", "always", and '
|
||||
'"unless-stopped".') % policy
|
||||
raise exception.StackValidationFailed(message=msg)
|
||||
|
||||
def handle_create(self):
|
||||
args = dict((k, v) for k, v in self.properties.items()
|
||||
if v is not None)
|
||||
policy = args.pop(self.RESTART_POLICY, None)
|
||||
if policy:
|
||||
args[self.RESTART_POLICY] = self._parse_restart_policy(policy)
|
||||
container = self.client().containers.run(**args)
|
||||
self.resource_id_set(container.uuid)
|
||||
return container.uuid
|
||||
|
||||
def _parse_restart_policy(self, policy):
|
||||
restart_policy = None
|
||||
if ":" in policy:
|
||||
policy, count = policy.split(":")
|
||||
if policy in ['on-failure']:
|
||||
restart_policy = {"Name": policy,
|
||||
"MaximumRetryCount": count or '0'}
|
||||
else:
|
||||
if policy in ['always', 'unless-stopped', 'on-failure', 'no']:
|
||||
restart_policy = {"Name": policy, "MaximumRetryCount": '0'}
|
||||
|
||||
return restart_policy
|
||||
|
||||
def check_create_complete(self, id):
|
||||
container = self.client().containers.get(id)
|
||||
if container.status in ('Creating', 'Created'):
|
||||
return False
|
||||
elif container.status == 'Running':
|
||||
return True
|
||||
elif container.status == 'Stopped':
|
||||
if container.interactive:
|
||||
msg = (_("Error in creating container '%(name)s' - "
|
||||
"interactive mode was enabled but the container "
|
||||
"has stopped running") % {'name': self.name})
|
||||
raise exception.ResourceInError(
|
||||
status_reason=msg, resource_status=container.status)
|
||||
return True
|
||||
elif container.status == 'Error':
|
||||
msg = (_("Error in creating container '%(name)s' - %(reason)s")
|
||||
% {'name': self.name, 'reason': container.status_reason})
|
||||
raise exception.ResourceInError(status_reason=msg,
|
||||
resource_status=container.status)
|
||||
else:
|
||||
msg = (_("Unknown status Container '%(name)s' - %(reason)s")
|
||||
% {'name': self.name, 'reason': container.status_reason})
|
||||
raise exception.ResourceUnknownStatus(status_reason=msg,
|
||||
resource_status=container
|
||||
.status)
|
||||
|
||||
def handle_update(self, json_snippet, tmpl_diff, prop_diff):
|
||||
if self.NAME in prop_diff:
|
||||
name = prop_diff.pop(self.NAME)
|
||||
self.client().containers.rename(self.resource_id, name=name)
|
||||
if prop_diff:
|
||||
self.client().containers.update(self.resource_id, **prop_diff)
|
||||
|
||||
def handle_delete(self):
|
||||
if not self.resource_id:
|
||||
return
|
||||
try:
|
||||
self.client().containers.delete(self.resource_id, force=True)
|
||||
except Exception as exc:
|
||||
self.client_plugin().ignore_not_found(exc)
|
||||
|
||||
def _resolve_attribute(self, name):
|
||||
if self.resource_id is None:
|
||||
return
|
||||
try:
|
||||
container = self.client().containers.get(self.resource_id)
|
||||
except Exception as exc:
|
||||
self.client_plugin().ignore_not_found(exc)
|
||||
return ''
|
||||
return getattr(container, name, '')
|
||||
|
||||
|
||||
def resource_mapping():
|
||||
return {
|
||||
'OS::Zun::Container': Container
|
||||
}
|
||||
|
|
@ -0,0 +1,253 @@
|
|||
#
|
||||
# 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 copy
|
||||
import mock
|
||||
from oslo_config import cfg
|
||||
import six
|
||||
|
||||
from heat.common import exception
|
||||
from heat.common import template_format
|
||||
from heat.engine.resources.openstack.zun import container
|
||||
from heat.engine import scheduler
|
||||
from heat.engine import template
|
||||
from heat.tests import common
|
||||
from heat.tests import utils
|
||||
|
||||
zun_template = '''
|
||||
heat_template_version: 2017-09-01
|
||||
|
||||
resources:
|
||||
test_container:
|
||||
type: OS::Zun::Container
|
||||
properties:
|
||||
name: test_container
|
||||
image: "cirros:latest"
|
||||
command: sleep 10000
|
||||
cpu: 0.1
|
||||
memory: 100
|
||||
environment:
|
||||
myenv: foo
|
||||
workdir: /testdir
|
||||
labels:
|
||||
mylabel: bar
|
||||
image_pull_policy: always
|
||||
restart_policy: on-failure:2
|
||||
interactive: false
|
||||
image_driver: docker
|
||||
'''
|
||||
|
||||
|
||||
class ZunContainerTest(common.HeatTestCase):
|
||||
|
||||
def setUp(self):
|
||||
super(ZunContainerTest, self).setUp()
|
||||
|
||||
self.resource_id = '12345'
|
||||
self.fake_name = 'test_container'
|
||||
self.fake_image = 'cirros:latest'
|
||||
self.fake_command = 'sleep 10000'
|
||||
self.fake_cpu = 0.1
|
||||
self.fake_memory = 100
|
||||
self.fake_env = {'myenv': 'foo'}
|
||||
self.fake_workdir = '/testdir'
|
||||
self.fake_labels = {'mylabel': 'bar'}
|
||||
self.fake_image_policy = 'always'
|
||||
self.fake_restart_policy = {'MaximumRetryCount': '2',
|
||||
'Name': 'on-failure'}
|
||||
self.fake_interactive = False
|
||||
self.fake_image_driver = 'docker'
|
||||
self.fake_addresses = {
|
||||
'addresses': {
|
||||
'private': [
|
||||
{
|
||||
'version': 4,
|
||||
'addr': '10.0.0.12',
|
||||
'port': 'ab5c12d8-f414-48a3-b765-8ce34a6714d2'
|
||||
},
|
||||
],
|
||||
}
|
||||
}
|
||||
|
||||
t = template_format.parse(zun_template)
|
||||
self.stack = utils.parse_stack(t)
|
||||
resource_defns = self.stack.t.resource_definitions(self.stack)
|
||||
self.rsrc_defn = resource_defns[self.fake_name]
|
||||
self.client = mock.Mock()
|
||||
self.patchobject(container.Container, 'client',
|
||||
return_value=self.client)
|
||||
|
||||
def _mock_get_client(self):
|
||||
value = mock.MagicMock()
|
||||
value.name = self.fake_name
|
||||
value.image = self.fake_image
|
||||
value.command = self.fake_command
|
||||
value.cpu = self.fake_cpu
|
||||
value.memory = self.fake_memory
|
||||
value.environment = self.fake_env
|
||||
value.workdir = self.fake_workdir
|
||||
value.labels = self.fake_labels
|
||||
value.image_pull_policy = self.fake_image_policy
|
||||
value.restart_policy = self.fake_restart_policy
|
||||
value.interactive = self.fake_interactive
|
||||
value.image_driver = self.fake_image_driver
|
||||
value.addresses = self.fake_addresses
|
||||
value.to_dict.return_value = value.__dict__
|
||||
|
||||
self.client.containers.get.return_value = value
|
||||
|
||||
def _create_resource(self, name, snippet, stack, status='Running'):
|
||||
value = mock.MagicMock(uuid=self.resource_id)
|
||||
self.client.containers.run.return_value = value
|
||||
get_rv = mock.MagicMock(status=status)
|
||||
self.client.containers.get.return_value = get_rv
|
||||
c = container.Container(name, snippet, stack)
|
||||
return c
|
||||
|
||||
def test_create(self):
|
||||
c = self._create_resource('container', self.rsrc_defn,
|
||||
self.stack)
|
||||
# validate the properties
|
||||
self.assertEqual(
|
||||
self.fake_name,
|
||||
c.properties.get(container.Container.NAME))
|
||||
self.assertEqual(
|
||||
self.fake_image,
|
||||
c.properties.get(container.Container.IMAGE))
|
||||
self.assertEqual(
|
||||
self.fake_command,
|
||||
c.properties.get(container.Container.COMMAND))
|
||||
self.assertEqual(
|
||||
self.fake_cpu,
|
||||
c.properties.get(container.Container.CPU))
|
||||
self.assertEqual(
|
||||
self.fake_memory,
|
||||
c.properties.get(container.Container.MEMORY))
|
||||
self.assertEqual(
|
||||
self.fake_env,
|
||||
c.properties.get(container.Container.ENVIRONMENT))
|
||||
self.assertEqual(
|
||||
self.fake_workdir,
|
||||
c.properties.get(container.Container.WORKDIR))
|
||||
self.assertEqual(
|
||||
self.fake_labels,
|
||||
c.properties.get(container.Container.LABELS))
|
||||
self.assertEqual(
|
||||
self.fake_image_policy,
|
||||
c.properties.get(container.Container.IMAGE_PULL_POLICY))
|
||||
self.assertEqual(
|
||||
'on-failure:2',
|
||||
c.properties.get(container.Container.RESTART_POLICY))
|
||||
self.assertEqual(
|
||||
self.fake_interactive,
|
||||
c.properties.get(container.Container.INTERACTIVE))
|
||||
self.assertEqual(
|
||||
self.fake_image_driver,
|
||||
c.properties.get(container.Container.IMAGE_DRIVER))
|
||||
|
||||
scheduler.TaskRunner(c.create)()
|
||||
self.assertEqual(self.resource_id, c.resource_id)
|
||||
self.assertEqual((c.CREATE, c.COMPLETE), c.state)
|
||||
self.assertEqual('containers', c.entity)
|
||||
self.client.containers.run.assert_called_once_with(
|
||||
name=self.fake_name,
|
||||
image=self.fake_image,
|
||||
command=self.fake_command,
|
||||
cpu=self.fake_cpu,
|
||||
memory=self.fake_memory,
|
||||
environment=self.fake_env,
|
||||
workdir=self.fake_workdir,
|
||||
labels=self.fake_labels,
|
||||
image_pull_policy=self.fake_image_policy,
|
||||
restart_policy=self.fake_restart_policy,
|
||||
interactive=self.fake_interactive,
|
||||
image_driver=self.fake_image_driver
|
||||
)
|
||||
|
||||
def test_container_create_failed(self):
|
||||
cfg.CONF.set_override('action_retry_limit', 0)
|
||||
c = self._create_resource('container', self.rsrc_defn, self.stack,
|
||||
status='Error')
|
||||
exc = self.assertRaises(
|
||||
exception.ResourceFailure,
|
||||
scheduler.TaskRunner(c.create))
|
||||
self.assertEqual((c.CREATE, c.FAILED), c.state)
|
||||
self.assertIn("Error in creating container ", six.text_type(exc))
|
||||
|
||||
def test_container_create_unknown_status(self):
|
||||
c = self._create_resource('container', self.rsrc_defn, self.stack,
|
||||
status='FOO')
|
||||
exc = self.assertRaises(
|
||||
exception.ResourceFailure,
|
||||
scheduler.TaskRunner(c.create))
|
||||
self.assertEqual((c.CREATE, c.FAILED), c.state)
|
||||
self.assertIn("Unknown status Container", six.text_type(exc))
|
||||
|
||||
def test_container_update(self):
|
||||
c = self._create_resource('container', self.rsrc_defn, self.stack)
|
||||
scheduler.TaskRunner(c.create)()
|
||||
t = template_format.parse(zun_template)
|
||||
new_t = copy.deepcopy(t)
|
||||
new_t['resources'][self.fake_name]['properties']['name'] = \
|
||||
'fake-container'
|
||||
new_t['resources'][self.fake_name]['properties']['cpu'] = 10
|
||||
new_t['resources'][self.fake_name]['properties']['memory'] = 10
|
||||
rsrc_defns = template.Template(new_t).resource_definitions(self.stack)
|
||||
new_c = rsrc_defns[self.fake_name]
|
||||
scheduler.TaskRunner(c.update, new_c)()
|
||||
self.client.containers.update.assert_called_once_with(
|
||||
self.resource_id, cpu=10, memory=10)
|
||||
self.client.containers.rename.assert_called_once_with(
|
||||
self.resource_id, name='fake-container')
|
||||
self.assertEqual((c.UPDATE, c.COMPLETE), c.state)
|
||||
|
||||
def test_container_delete(self):
|
||||
c = self._create_resource('container', self.rsrc_defn, self.stack)
|
||||
scheduler.TaskRunner(c.create)()
|
||||
scheduler.TaskRunner(c.delete)()
|
||||
self.assertEqual((c.DELETE, c.COMPLETE), c.state)
|
||||
self.assertEqual(1, self.client.containers.delete.call_count)
|
||||
|
||||
def test_container_delete_not_found(self):
|
||||
c = self._create_resource('container', self.rsrc_defn, self.stack)
|
||||
scheduler.TaskRunner(c.create)()
|
||||
c.client_plugin = mock.MagicMock()
|
||||
self.client.containers.delete.side_effect = Exception('Not Found')
|
||||
scheduler.TaskRunner(c.delete)()
|
||||
self.assertEqual((c.DELETE, c.COMPLETE), c.state)
|
||||
self.assertEqual(1, self.client.containers.delete.call_count)
|
||||
mock_ignore_not_found = c.client_plugin.return_value.ignore_not_found
|
||||
self.assertEqual(1, mock_ignore_not_found.call_count)
|
||||
|
||||
def test_container_get_live_state(self):
|
||||
c = self._create_resource('container', self.rsrc_defn, self.stack)
|
||||
scheduler.TaskRunner(c.create)()
|
||||
self._mock_get_client()
|
||||
reality = c.get_live_state(c.properties)
|
||||
self.assertEqual(
|
||||
{
|
||||
container.Container.NAME: self.fake_name,
|
||||
container.Container.CPU: self.fake_cpu,
|
||||
container.Container.MEMORY: self.fake_memory,
|
||||
}, reality)
|
||||
|
||||
def test_resolve_attributes(self):
|
||||
c = self._create_resource('container', self.rsrc_defn, self.stack)
|
||||
scheduler.TaskRunner(c.create)()
|
||||
self._mock_get_client()
|
||||
self.assertEqual(
|
||||
self.fake_name,
|
||||
c._resolve_attribute(container.Container.NAME))
|
||||
self.assertEqual(
|
||||
self.fake_addresses,
|
||||
c._resolve_attribute(container.Container.ADDRESSES))
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
features:
|
||||
- |
|
||||
A new OS::Zun::Container resource is added that allows users to manage
|
||||
docker containers powered by Zun. This resource will have an 'addresses'
|
||||
attribute that contains various networking information including the
|
||||
neutron port id. This allows users to orchestrate containers with other
|
||||
networking resources (i.e. floating ip).
|
||||
Loading…
Reference in New Issue