# 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 ecl import exceptions
from ecl.orchestration import orchestration_service
from ecl import resource2 as resource
from ecl import utils
[docs]class Stack(resource.Resource):
name_attribute = 'stack_name'
resource_key = 'stack'
resources_key = 'stacks'
base_path = '/stacks'
service = orchestration_service.OrchestrationService()
# capabilities
allow_create = True
allow_list = True
allow_get = True
allow_update = True
allow_delete = True
# Properties
#: Placeholder for AWS compatible template listing capabilities
#: required by the stack.
capabilities = resource.Body('capabilities')
#: Timestamp of the stack creation.
created_at = resource.Body('creation_time')
#: A text description of the stack.
description = resource.Body('description')
#: Whether the stack will support a rollback operation on stack
#: create/update failures. *Type: bool*
is_rollback_disabled = resource.Body('disable_rollback', type=bool)
#: A list of dictionaries containing links relevant to the stack.
links = resource.Body('links')
#: Name of the stack.
name = resource.Body('stack_name')
#: Placeholder for future extensions where stack related events
#: can be published.
notification_topics = resource.Body('notification_topics')
#: A list containing output keys and values from the stack, if any.
outputs = resource.Body('outputs')
#: The ID of the owner stack if any.
owner_id = resource.Body('stack_owner')
#: A dictionary containing the parameter names and values for the stack.
parameters = resource.Body('parameters', type=dict)
#: The ID of the parent stack if any
parent_id = resource.Body('parent')
#: A string representation of the stack status, e.g. ``CREATE_COMPLETE``.
status = resource.Body('stack_status')
#: A text explaining how the stack transits to its current status.
status_reason = resource.Body('stack_status_reason')
#: A dict containing the template use for stack creation.
template = resource.Body('template', type=dict)
#: Stack template description text. Currently contains the same text
#: as that of the ``description`` property.
template_description = resource.Body('template_description')
#: A string containing the URL where a stack template can be found.
template_url = resource.Body('template_url')
#: Stack operation timeout in minutes.
timeout_mins = resource.Body('timeout_mins')
#: Timestamp of last update on the stack.
updated_at = resource.Body('updated_time')
#: The ID of the user project created for this stack.
user_project_id = resource.Body('stack_user_project_id')
[docs] def create(self, session):
# This overrides the default behavior of resource creation because
# heat doesn't accept resource_key in its request.
return super(Stack, self).create(session, prepend_key=False)
[docs] def update(self, session):
# This overrides the default behavior of resource creation because
# heat doesn't accept resource_key in its request.
return super(Stack, self).update(session, prepend_key=False,
has_body=False)
def _action(self, session, body):
"""Perform stack actions"""
url = utils.urljoin(self.base_path, self._get_id(self), 'actions')
resp = session.post(url, endpoint_filter=self.service, json=body)
return resp.json()
[docs] def check(self, session):
return self._action(session, {'check': ''})
[docs] def get(self, session, requires_id=True):
stk = super(Stack, self).get(session, requires_id=requires_id)
if stk and stk.status in ['DELETE_COMPLETE', 'ADOPT_COMPLETE']:
raise exceptions.NotFoundException(
"No stack found for %s" % stk.id)
return stk
[docs]class StackPreview(Stack):
base_path = '/stacks/preview'
allow_create = True
allow_list = False
allow_get = False
allow_update = False
allow_delete = False