Edit On Github

Policy Triggers

---

policy_triggers specify the implementation of actions invoked by policies and declare the properties that define the trigger’s behavior.

Declaration

The policy_triggers section is a hash where each item in the hash represents an policy trigger.

  
policy_triggers:
  # my_definitions.policy_triggers.my_trigger1 is the policy trigger name
  my_definitions.policy_triggers.my_trigger1:
    ...
  my_trigger2:
    ...
  

Schema

Keyname	Required	Type	Description
source	yes	string	The policy trigger implementation source (URL or a path relative to the blueprint root directory).
parameters	no	dict	Optional parameters schema for the policy trigger.

Example

  
policy_triggers:

  my_webhook_trigger:

    source: policy_trigger/webhook_trigger.clj

    properties:
      webhook_endpoint:
        description: >
          URL for making a POST HTTP request to
      webhook_body:
        description: >
          request body (serialized to JSON)
        default: {}

  

Built-in Policy Triggers

The following policy triggers are defined in types.yaml.

cloudify.policies.triggers.execute_workflow

Parameters:

• workflow Workflow name to execute.
• workflow_parameters Workflow parameters. (Optional, Default {})
• force Should the workflow be executed even when another execution for the same workflow is currently in progress. (Optional, Default: false)
• allow_custom_parameters Should parameters not defined in the workflow parameters schema be accepted. (Optional, Default: false)
• socket_timeout Socket timeout when making request to manager REST in ms. (Optional, Default: 1000)
• conn_timeout Connection timeout when making request to manager REST in ms. (Optional, Default: 1000)

You can find the implementation for this trigger on github. It builds the HTTP request to the manager REST service and makes the actual REST call using the clj-http clojure library.

Usage

This page describes how to define a policy trigger. To actually use policy triggers with policies, refer to the Groups specification.