heat.api.openstack.v1.stacks module

Stack endpoint for Heat v1 REST API.

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

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'

args()

Get any additional arguments supplied by the user.

environment()

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

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

environment_files()

files()

files_container()

static parse_error_check(data_type)

stack_name()

Return the stack name.

template()

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)

Bases: object

WSGI controller for stacks resource in Heat v1 API.

Implements the API actions.

REQUEST_SCOPE = 'stacks'

abandon(req, identity)

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)

Create a new stack.

default(req, **args)

delete(req, identity)

Delete the specified stack.

delete_snapshot(req, identity, snapshot_id)

detail(req)

Lists detailed information for all stacks.

environment(req, identity)

Get the environment for an existing stack.

export(req, identity)

Export specified stack.

Return stack data in JSON format.

files(req, identity)

Get the files for an existing stack.

generate_template(req, type_name)

Generates a template based on the specified type.

global_index(req)

index(req)

Lists summary information for all stacks.

list_outputs(req, identity)

list_resource_types(req)

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

list_snapshots(req, identity)

list_template_functions(req, template_version)

Returns a list of available functions in a given template.

list_template_versions(req)

Returns a list of available template versions.

lookup(req, stack_name, path='', body=None)

Redirect to the canonical URL for a stack.

prepare_args(data, is_update=False)

preview(req, body)

Preview the outcome of a template and its params.

preview_update(req, identity, body)

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

preview_update_patch(req, identity, body)

Preview PATCH update for existing stack.

resource_schema(req, type_name, with_description=False)

Returns the schema of the given resource type.

restore_snapshot(req, identity, snapshot_id)

show(req, identity)

Gets detailed information for a stack.

show_output(req, identity, output_key)

show_snapshot(req, identity, snapshot_id)

snapshot(req, identity, body)

template(req, identity)

Get the template body for an existing stack.

update(req, identity, body)

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

update_patch(req, identity, body)

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)

Implements the ValidateTemplate API action.

Validates the specified template.

class heat.api.openstack.v1.stacks.StackSerializer

Bases: heat.common.serializers.JSONResponseSerializer

Handles serialization of specific controller method responses.

create(response, result)

heat.api.openstack.v1.stacks.create_resource(options)

Stacks resource factory method.