The 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 accompanying a PUT or POST request to create or update a stack.
-
InstantiationData.PARAMS = ('stack_name', 'template', 'template_url', 'parameters', 'environment', 'files')
-
InstantiationData.PARAM_ENVIRONMENT = 'environment'
-
InstantiationData.PARAM_FILES = 'files'
-
InstantiationData.PARAM_STACK_NAME = 'stack_name'
-
InstantiationData.PARAM_TEMPLATE = 'template'
-
InstantiationData.PARAM_TEMPLATE_URL = 'template_url'
-
InstantiationData.PARAM_USER_PARAMS = 'parameters'
-
InstantiationData.args()[source]
Get any additional arguments supplied by the user.
-
InstantiationData.environment()[source]
Get the user-supplied environment for the stack in YAML format.
If the user supplied Parameters then merge these into the
environment global options.
-
InstantiationData.files()[source]
-
static InstantiationData.format_parse(data, data_type)[source]
Parse the supplied data as JSON or YAML, raising the appropriate
exception if it is in the wrong format.
-
InstantiationData.stack_name()[source]
Return the stack name.
-
InstantiationData.template()[source]
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
-
StackController.REQUEST_SCOPE = 'stacks'
-
StackController.abandon(controller, req, tenant_id, **kwargs)[source]
Abandons specified stack by deleting the stack and it’s resources
from the database, but underlying resources will not be deleted.
-
StackController.create(controller, req, tenant_id, **kwargs)[source]
Create a new stack
-
StackController.default(req, **args)[source]
-
StackController.delete(controller, req, tenant_id, **kwargs)[source]
Delete the specified stack
-
StackController.delete_snapshot(controller, req, tenant_id, **kwargs)[source]
-
StackController.detail(controller, req, tenant_id, **kwargs)[source]
Lists detailed information for all stacks
-
StackController.generate_template(controller, req, tenant_id, **kwargs)[source]
Generates a template based on the specified type.
-
StackController.global_index(controller, req, tenant_id, **kwargs)[source]
-
StackController.index(controller, req, tenant_id, **kwargs)[source]
Lists summary information for all stacks
-
StackController.list_resource_types(controller, req, tenant_id, **kwargs)[source]
Returns a list of valid resource types that may be used in a template.
-
StackController.list_snapshots(controller, req, tenant_id, **kwargs)[source]
-
StackController.lookup(controller, req, tenant_id, **kwargs)[source]
Redirect to the canonical URL for a stack
-
StackController.preview(controller, req, tenant_id, **kwargs)[source]
Preview the outcome of a template and its params
-
StackController.resource_schema(controller, req, tenant_id, **kwargs)[source]
Returns the schema of the given resource type.
-
StackController.show(controller, req, tenant_id, **kwargs)[source]
Gets detailed information for a stack
-
StackController.show_snapshot(controller, req, tenant_id, **kwargs)[source]
-
StackController.snapshot(controller, req, tenant_id, **kwargs)[source]
-
StackController.template(controller, req, tenant_id, **kwargs)[source]
Get the template body for an existing stack
-
StackController.update(controller, req, tenant_id, **kwargs)[source]
Update an existing stack with a new template and/or parameters
-
StackController.update_patch(controller, req, tenant_id, **kwargs)[source]
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
-
StackController.validate_template(controller, req, tenant_id, **kwargs)[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.
-
StackSerializer.create(response, result)[source]
-
heat.api.openstack.v1.stacks.create_resource(options)[source]
Stacks resource factory method.