The heat.engine.service Module

class heat.engine.service.EngineService(host, topic, manager=None)

Bases: heat.openstack.common.rpc.service.Service

Manages the running instances from creation to destruction. All the methods in here are called from the RPC backend. This is all done dynamically so if a call is made via RPC that does not have a corresponding method here, an exception will be thrown when it attempts to call into this class. Arguments to these methods are also dynamically added and will be named as keyword arguments by the RPC caller.

authenticated_to_backend(ctx, *args, **kwargs)

Verify that the credentials in the RPC context are valid for the current cloud backend.

create_stack(ctx, *args, **kwargs)

The create_stack method creates a new stack using the template provided. Note that at this stage the template has already been fetched from the heat-api process if using a template-url. arg1 -> RPC context. arg2 -> Name of the stack you want to create. arg3 -> Template of stack you want to create. arg4 -> Stack Input Params arg4 -> Request parameters/args passed from API

create_watch_data(ctx, *args, **kwargs)

This could be used by CloudWatch and WaitConditions and treat HA service events like any other CloudWatch.

delete_stack(ctx, *args, **kwargs)

The delete_stack method deletes a given stack. arg1 -> RPC context. arg2 -> Name of the stack you want to delete.

describe_stack_resource(ctx, *args, **kwargs)

describe_stack_resources(ctx, *args, **kwargs)

find_physical_resource(ctx, *args, **kwargs)

Return an identifier for the resource with the specified physical resource ID. arg1 -> RPC context. arg2 -> The physical resource ID to look up.

get_template(ctx, *args, **kwargs)

Get the template. arg1 -> RPC context. arg2 -> Name of the stack you want to see.

identify_stack(ctx, *args, **kwargs)

The identify_stack method returns the full stack identifier for a single, live stack given the stack name. arg1 -> RPC context. arg2 -> Name or UUID of the stack to look up.

list_events(ctx, *args, **kwargs)

The list_events method lists all events associated with a given stack. arg1 -> RPC context. arg2 -> Name of the stack you want to get events for.

list_resource_types(cnxt)

Get a list of supported resource types. arg1 -> RPC context.

list_stack_resources(ctx, *args, **kwargs)

list_stacks(ctx, *args, **kwargs)

The list_stacks method returns attributes of all stacks. arg1 -> RPC cnxt.

metadata_update(ctx, *args, **kwargs)

Update the metadata for the given resource.

set_watch_state(ctx, *args, **kwargs)

Temporarily set the state of a given watch arg1 -> RPC context. arg2 -> Name of the watch arg3 -> State (must be one defined in WatchRule class

show_stack(ctx, *args, **kwargs)

Return detailed information about one or all stacks. arg1 -> RPC cnxt. arg2 -> Name of the stack you want to show, or None to show all

show_watch(ctx, *args, **kwargs)

The show_watch method returns the attributes of one watch/alarm arg1 -> RPC context. arg2 -> Name of the watch you want to see, or None to see all

show_watch_metric(ctx, *args, **kwargs)

The show_watch method returns the datapoints for a metric arg1 -> RPC context. arg2 -> Name of the namespace you want to see, or None to see all arg3 -> Name of the metric you want to see, or None to see all

start()

update_stack(ctx, *args, **kwargs)

The update_stack method updates an existing stack based on the provided template and parameters. Note that at this stage the template has already been fetched from the heat-api process if using a template-url. arg1 -> RPC context. arg2 -> Name of the stack you want to create. arg3 -> Template of stack you want to create. arg4 -> Stack Input Params arg4 -> Request parameters/args passed from API

validate_template(ctx, *args, **kwargs)

The validate_template method uses the stack parser to check the validity of a template.

arg1 -> RPC context. arg3 -> Template of stack you want to create. arg4 -> Stack Input Params

heat.engine.service.request_context(func)