426 lines
16 KiB
Python
426 lines
16 KiB
Python
# Copyright 2013 UnitedStack Inc.
|
|
# All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
from oslo_log import log as logging
|
|
from oslo_utils import timeutils
|
|
import pecan
|
|
from pecan import rest
|
|
import wsme
|
|
from wsme import types as wtypes
|
|
|
|
from magnum.api.controllers import base
|
|
from magnum.api.controllers import link
|
|
from magnum.api.controllers.v1 import collection
|
|
from magnum.api.controllers.v1 import types
|
|
from magnum.api import expose
|
|
from magnum.api import utils as api_utils
|
|
from magnum.api import validation
|
|
from magnum.common import exception
|
|
from magnum.common import policy
|
|
from magnum.i18n import _LE
|
|
from magnum import objects
|
|
from magnum.objects import fields
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
class ContainerPatchType(types.JsonPatchType):
|
|
|
|
@staticmethod
|
|
def mandatory_attrs():
|
|
return ['/bay_uuid']
|
|
|
|
|
|
class Container(base.APIBase):
|
|
"""API representation of a container.
|
|
|
|
This class enforces type checking and value constraints, and converts
|
|
between the internal object model and the API representation of a
|
|
container.
|
|
"""
|
|
|
|
_bay_uuid = None
|
|
|
|
def _get_bay_uuid(self):
|
|
return self._bay_uuid
|
|
|
|
def _set_bay_uuid(self, value):
|
|
if value and self._bay_uuid != value:
|
|
try:
|
|
bay = objects.Bay.get_by_uuid(pecan.request.context, value)
|
|
self._bay_uuid = bay['uuid']
|
|
except exception.BayNotFound as e:
|
|
# Change error code because 404 (NotFound) is inappropriate
|
|
# response for a POST request to create a Service
|
|
e.code = 400 # BadRequest
|
|
raise e
|
|
elif value == wtypes.Unset:
|
|
self._bay_uuid = wtypes.Unset
|
|
|
|
uuid = types.uuid
|
|
"""Unique UUID for this container"""
|
|
|
|
name = wtypes.StringType(min_length=1, max_length=255)
|
|
"""Name of this container"""
|
|
|
|
image = wtypes.text
|
|
"""The image name or ID to use as a base image for this container"""
|
|
|
|
bay_uuid = wsme.wsproperty(types.uuid, _get_bay_uuid, _set_bay_uuid,
|
|
mandatory=True)
|
|
"""Unique UUID of the bay this runs on"""
|
|
|
|
links = wsme.wsattr([link.Link], readonly=True)
|
|
"""A list containing a self link and associated container links"""
|
|
|
|
command = wtypes.text
|
|
"""The command execute when container starts"""
|
|
|
|
status = wtypes.text
|
|
"""The status of container"""
|
|
|
|
memory = wtypes.text
|
|
"""Memory limit for the container. Example: 512m"""
|
|
|
|
environment = wtypes.DictType(str, str)
|
|
"""One or more key/value pairs"""
|
|
|
|
def __init__(self, **kwargs):
|
|
self.fields = []
|
|
for field in objects.Container.fields:
|
|
# Skip fields we do not expose.
|
|
if not hasattr(self, field):
|
|
continue
|
|
self.fields.append(field)
|
|
setattr(self, field, kwargs.get(field, wtypes.Unset))
|
|
|
|
@staticmethod
|
|
def _convert_with_links(container, url, expand=True):
|
|
if not expand:
|
|
container.unset_fields_except(['uuid', 'name', 'bay_uuid',
|
|
'image', 'command', 'status',
|
|
'memory', 'environment'])
|
|
|
|
container.links = [link.Link.make_link(
|
|
'self', url,
|
|
'containers', container.uuid),
|
|
link.Link.make_link(
|
|
'bookmark', url,
|
|
'containers', container.uuid,
|
|
bookmark=True)]
|
|
return container
|
|
|
|
@classmethod
|
|
def convert_with_links(cls, rpc_container, expand=True):
|
|
container = Container(**rpc_container.as_dict())
|
|
return cls._convert_with_links(container, pecan.request.host_url,
|
|
expand)
|
|
|
|
@classmethod
|
|
def sample(cls, expand=True):
|
|
sample = cls(uuid='27e3153e-d5bf-4b7e-b517-fb518e17f34c',
|
|
name='example',
|
|
image='ubuntu',
|
|
command='env',
|
|
status='Running',
|
|
memory='512m',
|
|
environment={'key1': 'val1', 'key2': 'val2'},
|
|
bay_uuid="fff114da-3bfa-4a0f-a123-c0dffad9718e",
|
|
created_at=timeutils.utcnow(),
|
|
updated_at=timeutils.utcnow())
|
|
return cls._convert_with_links(sample, 'http://localhost:9511', expand)
|
|
|
|
|
|
class ContainerCollection(collection.Collection):
|
|
"""API representation of a collection of containers."""
|
|
|
|
containers = [Container]
|
|
"""A list containing containers objects"""
|
|
|
|
def __init__(self, **kwargs):
|
|
self._type = 'containers'
|
|
|
|
@staticmethod
|
|
def convert_with_links(rpc_containers, limit, url=None,
|
|
expand=False, **kwargs):
|
|
collection = ContainerCollection()
|
|
collection.containers = [Container.convert_with_links(p, expand)
|
|
for p in rpc_containers]
|
|
collection.next = collection.get_next(limit, url=url, **kwargs)
|
|
return collection
|
|
|
|
@classmethod
|
|
def sample(cls):
|
|
sample = cls()
|
|
sample.containers = [Container.sample(expand=False)]
|
|
return sample
|
|
|
|
|
|
def check_policy_on_container(container, action):
|
|
context = pecan.request.context
|
|
policy.enforce(context, action, container, action=action)
|
|
|
|
|
|
class StartController(object):
|
|
@expose.expose(types.uuid_or_name, wtypes.text)
|
|
def _default(self, container_ident):
|
|
if pecan.request.method != 'PUT':
|
|
pecan.abort(405, ('HTTP method %s is not allowed'
|
|
% pecan.request.method))
|
|
container = api_utils.get_resource('Container',
|
|
container_ident)
|
|
check_policy_on_container(container, "container:start")
|
|
LOG.debug('Calling conductor.container_start with %s',
|
|
container.uuid)
|
|
return pecan.request.rpcapi.container_start(container.uuid)
|
|
|
|
|
|
class StopController(object):
|
|
@expose.expose(types.uuid_or_name, wtypes.text)
|
|
def _default(self, container_ident):
|
|
if pecan.request.method != 'PUT':
|
|
pecan.abort(405, ('HTTP method %s is not allowed'
|
|
% pecan.request.method))
|
|
container = api_utils.get_resource('Container',
|
|
container_ident)
|
|
check_policy_on_container(container, "container:stop")
|
|
LOG.debug('Calling conductor.container_stop with %s',
|
|
container.uuid)
|
|
return pecan.request.rpcapi.container_stop(container.uuid)
|
|
|
|
|
|
class RebootController(object):
|
|
@expose.expose(types.uuid_or_name, wtypes.text)
|
|
def _default(self, container_ident):
|
|
if pecan.request.method != 'PUT':
|
|
pecan.abort(405, ('HTTP method %s is not allowed'
|
|
% pecan.request.method))
|
|
container = api_utils.get_resource('Container',
|
|
container_ident)
|
|
check_policy_on_container(container, "container:reboot")
|
|
LOG.debug('Calling conductor.container_reboot with %s',
|
|
container.uuid)
|
|
return pecan.request.rpcapi.container_reboot(container.uuid)
|
|
|
|
|
|
class PauseController(object):
|
|
@expose.expose(types.uuid_or_name, wtypes.text)
|
|
def _default(self, container_ident):
|
|
if pecan.request.method != 'PUT':
|
|
pecan.abort(405, ('HTTP method %s is not allowed'
|
|
% pecan.request.method))
|
|
container = api_utils.get_resource('Container',
|
|
container_ident)
|
|
check_policy_on_container(container, "container:pause")
|
|
LOG.debug('Calling conductor.container_pause with %s',
|
|
container.uuid)
|
|
return pecan.request.rpcapi.container_pause(container.uuid)
|
|
|
|
|
|
class UnpauseController(object):
|
|
@expose.expose(types.uuid_or_name, wtypes.text)
|
|
def _default(self, container_ident):
|
|
if pecan.request.method != 'PUT':
|
|
pecan.abort(405, ('HTTP method %s is not allowed'
|
|
% pecan.request.method))
|
|
container = api_utils.get_resource('Container',
|
|
container_ident)
|
|
check_policy_on_container(container, "container:unpause")
|
|
LOG.debug('Calling conductor.container_unpause with %s',
|
|
container.uuid)
|
|
return pecan.request.rpcapi.container_unpause(container.uuid)
|
|
|
|
|
|
class LogsController(object):
|
|
@expose.expose(types.uuid_or_name, wtypes.text)
|
|
def _default(self, container_ident):
|
|
if pecan.request.method != 'GET':
|
|
pecan.abort(405, ('HTTP method %s is not allowed'
|
|
% pecan.request.method))
|
|
container = api_utils.get_resource('Container',
|
|
container_ident)
|
|
check_policy_on_container(container, "container:logs")
|
|
LOG.debug('Calling conductor.container_logs with %s',
|
|
container.uuid)
|
|
return pecan.request.rpcapi.container_logs(container.uuid)
|
|
|
|
|
|
class ExecuteController(object):
|
|
@expose.expose(types.uuid_or_name, wtypes.text, wtypes.text)
|
|
def _default(self, container_ident, command):
|
|
if pecan.request.method != 'PUT':
|
|
pecan.abort(405, ('HTTP method %s is not allowed'
|
|
% pecan.request.method))
|
|
container = api_utils.get_resource('Container',
|
|
container_ident)
|
|
check_policy_on_container(container, "container:execute")
|
|
LOG.debug('Calling conductor.container_exec with %s command %s',
|
|
container.uuid, command)
|
|
return pecan.request.rpcapi.container_exec(container.uuid, command)
|
|
|
|
|
|
def check_policy_on_bay(bay_id, action):
|
|
context = pecan.request.context
|
|
bay = api_utils.get_resource('Bay', bay_id)
|
|
policy.enforce(context, action, bay, action=action)
|
|
|
|
|
|
class ContainersController(rest.RestController):
|
|
"""REST controller for Containers."""
|
|
|
|
def __init__(self):
|
|
super(ContainersController, self).__init__()
|
|
|
|
start = StartController()
|
|
stop = StopController()
|
|
reboot = RebootController()
|
|
pause = PauseController()
|
|
unpause = UnpauseController()
|
|
logs = LogsController()
|
|
execute = ExecuteController()
|
|
|
|
_custom_actions = {
|
|
'detail': ['GET'],
|
|
}
|
|
|
|
def _get_containers_collection(self, marker, limit,
|
|
sort_key, sort_dir, expand=False,
|
|
resource_url=None, bay_ident=None):
|
|
|
|
context = pecan.request.context
|
|
limit = api_utils.validate_limit(limit)
|
|
sort_dir = api_utils.validate_sort_dir(sort_dir)
|
|
|
|
filters = None
|
|
marker_obj = None
|
|
if marker:
|
|
marker_obj = objects.Container.get_by_uuid(context,
|
|
marker)
|
|
if bay_ident:
|
|
bay_obj = api_utils.get_resource('Bay', bay_ident)
|
|
filters = {'bay_uuid': bay_obj.uuid}
|
|
|
|
containers = objects.Container.list(context,
|
|
limit,
|
|
marker_obj,
|
|
sort_key,
|
|
sort_dir,
|
|
filters=filters)
|
|
|
|
for i, c in enumerate(containers):
|
|
try:
|
|
containers[i] = pecan.request.rpcapi.container_show(c.uuid)
|
|
except Exception as e:
|
|
LOG.exception(_LE("Error while list container %(uuid)s: "
|
|
"%(e)s."),
|
|
{'uuid': c.uuid, 'e': e})
|
|
containers[i].status = fields.ContainerStatus.UNKNOWN
|
|
|
|
return ContainerCollection.convert_with_links(containers, limit,
|
|
url=resource_url,
|
|
expand=expand,
|
|
sort_key=sort_key,
|
|
sort_dir=sort_dir)
|
|
|
|
@expose.expose(ContainerCollection, types.uuid, int,
|
|
wtypes.text, wtypes.text, types.uuid_or_name)
|
|
def get_all(self, marker=None, limit=None, sort_key='id',
|
|
sort_dir='asc', bay_ident=None):
|
|
"""Retrieve a list of containers.
|
|
|
|
:param marker: pagination marker for large data sets.
|
|
:param limit: maximum number of resources to return in a single result.
|
|
:param sort_key: column to sort results by. Default: id.
|
|
:param sort_dir: direction to sort. "asc" or "desc". Default: asc.
|
|
:param bay_indent: UUID or logical name of bay.
|
|
"""
|
|
context = pecan.request.context
|
|
policy.enforce(context, "container:get_all",
|
|
action="container:get_all")
|
|
return self._get_containers_collection(marker, limit, sort_key,
|
|
sort_dir, bay_ident=bay_ident)
|
|
|
|
@expose.expose(ContainerCollection, types.uuid, int,
|
|
wtypes.text, wtypes.text)
|
|
def detail(self, marker=None, limit=None, sort_key='id',
|
|
sort_dir='asc'):
|
|
"""Retrieve a list of containers with detail.
|
|
|
|
:param marker: pagination marker for large data sets.
|
|
:param limit: maximum number of resources to return in a single result.
|
|
:param sort_key: column to sort results by. Default: id.
|
|
:param sort_dir: direction to sort. "asc" or "desc". Default: asc.
|
|
"""
|
|
context = pecan.request.context
|
|
policy.enforce(context, "container:detail",
|
|
action="container:detail")
|
|
|
|
parent = pecan.request.path.split('/')[:-1][-1]
|
|
if parent != "containers":
|
|
raise exception.HTTPNotFound
|
|
|
|
expand = True
|
|
resource_url = '/'.join(['containers', 'detail'])
|
|
return self._get_containers_collection(marker, limit,
|
|
sort_key, sort_dir, expand,
|
|
resource_url)
|
|
|
|
@expose.expose(Container, types.uuid_or_name)
|
|
def get_one(self, container_ident):
|
|
"""Retrieve information about the given container.
|
|
|
|
:param container_ident: UUID or name of a container.
|
|
"""
|
|
container = api_utils.get_resource('Container',
|
|
container_ident)
|
|
check_policy_on_container(container, "container:get")
|
|
res_container = pecan.request.rpcapi.container_show(container.uuid)
|
|
return Container.convert_with_links(res_container)
|
|
|
|
@expose.expose(Container, body=Container, status_code=201)
|
|
@validation.enforce_bay_types('swarm')
|
|
def post(self, container):
|
|
"""Create a new container.
|
|
|
|
:param container: a container within the request body.
|
|
"""
|
|
container_dict = container.as_dict()
|
|
check_policy_on_bay(container_dict['bay_uuid'], "container:create")
|
|
context = pecan.request.context
|
|
container_dict['project_id'] = context.project_id
|
|
container_dict['user_id'] = context.user_id
|
|
if 'memory' in container_dict:
|
|
api_utils.validate_docker_memory(container_dict['memory'])
|
|
new_container = objects.Container(context, **container_dict)
|
|
new_container.create()
|
|
res_container = pecan.request.rpcapi.container_create(new_container)
|
|
|
|
# Set the HTTP Location Header
|
|
pecan.response.location = link.build_url('containers',
|
|
res_container.uuid)
|
|
return Container.convert_with_links(res_container)
|
|
|
|
@expose.expose(None, types.uuid_or_name, status_code=204)
|
|
def delete(self, container_ident):
|
|
"""Delete a container.
|
|
|
|
:param container_ident: UUID or Name of a container.
|
|
"""
|
|
container = api_utils.get_resource('Container',
|
|
container_ident)
|
|
check_policy_on_container(container, "container:delete")
|
|
pecan.request.rpcapi.container_delete(container.uuid)
|
|
container.destroy()
|