heat.api.openstack.v1.stacks module

Stack endpoint for Heat v1 REST API.

class heat.api.openstack.v1.stacks.InstantiationData(data, patch=False)[source]

Bases: object

The data to create or update a stack.

The data accompanying a PUT or POST request.

PARAMS = ('stack_name', 'template', 'template_url', 'parameters', 'environment', 'files', 'environment_files', 'files_container')
PARAM_ENVIRONMENT = 'environment'
PARAM_ENVIRONMENT_FILES = 'environment_files'
PARAM_FILES = 'files'
PARAM_FILES_CONTAINER = 'files_container'
PARAM_STACK_NAME = 'stack_name'
PARAM_TEMPLATE = 'template'
PARAM_TEMPLATE_URL = 'template_url'
PARAM_USER_PARAMS = 'parameters'

Get any additional arguments supplied by the user.


Get the user-supplied environment for the stack in YAML format.

If the user supplied Parameters then merge these into the environment global options.

static parse_error_check(data_type)[source]

Return the stack name.


Get template file contents.

Get template file contents, either inline, from stack adopt data or from a URL, in JSON or YAML format.

class heat.api.openstack.v1.stacks.StackController(options)[source]

Bases: object

WSGI controller for stacks resource in Heat v1 API.

Implements the API actions.

REQUEST_SCOPE = 'stacks'
abandon(req, identity)[source]

Abandons specified stack.

Abandons specified stack by deleting the stack and it’s resources from the database, but underlying resources will not be deleted.

create(req, body)[source]

Create a new stack.

default(req, **args)[source]
delete(req, identity)[source]

Delete the specified stack.

delete_snapshot(req, identity, snapshot_id)[source]

Lists detailed information for all stacks.

environment(req, identity)[source]

Get the environment for an existing stack.

export(req, identity)[source]

Export specified stack.

Return stack data in JSON format.

files(req, identity)[source]

Get the files for an existing stack.

generate_template(req, type_name)[source]

Generates a template based on the specified type.


Lists summary information for all stacks.

list_outputs(req, identity)[source]

Returns a resource types list which may be used in template.

list_snapshots(req, identity)[source]
list_template_functions(req, template_version)[source]

Returns a list of available functions in a given template.


Returns a list of available template versions.

lookup(req, stack_name, path='', body=None)[source]

Redirect to the canonical URL for a stack.

prepare_args(data, is_update=False)[source]
preview(req, body)[source]

Preview the outcome of a template and its params.

preview_update(req, identity, body)[source]

Preview update for existing stack with a new template/parameters.

preview_update_patch(req, identity, body)[source]

Preview PATCH update for existing stack.

resource_schema(req, type_name, with_description=False)[source]

Returns the schema of the given resource type.

restore_snapshot(req, identity, snapshot_id)[source]
show(req, identity)[source]

Gets detailed information for a stack.

show_output(req, identity, output_key)[source]
show_snapshot(req, identity, snapshot_id)[source]
snapshot(req, identity, body)[source]
template(req, identity)[source]

Get the template body for an existing stack.

update(req, identity, body)[source]

Update an existing stack with a new template and/or parameters.

update_patch(req, identity, body)[source]

Update an existing stack with a new template.

Update an existing stack with a new template by patching the parameters Add the flag patch to the args so the engine code can distinguish

validate_template(req, body)[source]

Implements the ValidateTemplate API action.

Validates the specified template.

class heat.api.openstack.v1.stacks.StackSerializer[source]

Bases: heat.common.serializers.JSONResponseSerializer

Handles serialization of specific controller method responses.

create(response, result)[source]

Stacks resource factory method.