cloudify-breakpoint-plugin

Breakpoint, Semaphore, confirmed execution, manual intervention

A Cloudify plugin for confirming an execution, which is defined as a stop in workflow execution that needs to be acknowledged by a user (may be any or specific user).

Usage

Node type:

cloudify.nodes.breakpoint.Breakpoint

The node acting as a breakpoint.

Properties:

• authorization
  • users - list of usernames that can change breakpoint state
  • roles - (optional) list of roles that can change breakpoint state
• resource_config
  • default_break_on_install - initial flag applied in cloudify.interfaces.lifecycle.start, used when there was not any execution of set_breakpoint_state workflow that is related to this node (neither the latest execution nor with permanent flag)
  • default_break_on_uninstall - initial flag applied in cloudify.interfaces.lifecycle.delete, analogous to default_break_on_install

Operations:

• cloudify.interfaces.lifecycle.start- when break_on_install (or initially default_break_on_install) is enabled it raises OperationRetry; this operation is executed on install (see Cloudify Built-in Workflows)
• cloudify.interfaces.lifecycle.delete - when break_on_uninstall (or initially default_break_on_uninstall) is enabled it raises OperationRetry; this operation is executed on uninstall (see Cloudify Built-in Workflows)
• cloudify.interfaces.breakpoint.check - If the user executing the operation is not in the nodes property authorization.users raise NonRecoverableError

Workflow:

set_breakpoint_state

Runs for the node type defined above. Admin user is always implicitly the allowed (does not need to be included in the list).

Parameters:

• node_ids - list of IDs of cloudify.nodes.breakpoint.Breakpoint
• node_instance_ids - list of IDs of cloudify.nodes.breakpoint.Breakpoint node instance, node ID is used interchangeably
• break_on_install (default: false) - specifies if the breakpoint should stop on cloudify.interfaces.lifecycle.start lifecycle operation
• break_on_uninstall (default: false) - specifies if the breakpoint should stop on cloudify.interfaces.lifecycle.delete lifecycle operation
• permanent (default: false) - specifies that this setting of the breakpoints is permanent, if false it will apply only to the next execution

Runtime properties

There is no runtime properties, authorized users are provided on blueprint upload.

Requirements

Examples

A blueprint with breakpoint is located in examples directory.

For other official blueprint examples using this Cloudify plugin, please see Cloudify Community Blueprints Examples.