Preface

The Trigger plugin allows you to configure Deployit to send emails for certain events. For example, you can add rules to send an email whenever a step fails, or when a deployment has completed successfully.

When Deployit resolves a deployment plan, a task comprising of multiple steps is created and subsequently executed. The task, along with the steps, transition throught various states before finally completing. The Trigger Plugin allows a user to associate actions, example sending an email, to be triggered for one of these state transitions.

Requirements

This plugin is bundled with Deployit from version 3.8 and has no additional requirements.

Actions

With the trigger plugin, you can define notification actions for certain events.

The following Deployit objects are made available to the actions:

• Deployed Application: The entire deployed application containing application and environment configuration items. See UDM CI reference for udm.DeployedApplication.
• Task: Contains information about the task. The following properties are available,
  • id
  • state
  • description
  • startDate
  • completionDate
  • nrSteps : number of steps in the task.
  • currentStepNr : the current step been executed.
  • failureCount : number of times the task has failed
  • owner
  • steps : List of steps in the task. Not available when action triggered from StepTrigger. See step information below for properties.

• Step: Contains information about a step. Not available when action triggered from TaskTrigger. The following properties are available,

  • description
  • state
  • log
  • startDate
  • completionDate
  • failureCount

• Action: Reference to the executing action itself.

Email Action

This section describes how to configure an email action.

First, you will need to define a mail.SmtpServer CI under the Configuration root. See the Generic Model Plugin Manual for more details.

The trigger.EmailNotification CI is used to define the message template for the emails that will be sent.

Under the Configuration root, define a trigger.EmailNotification configuration item. In the CLI you can do something like:

myEmailAction = factory.configurationItem("Configuration/MyFailedDeploymentNotification", "trigger.EmailNotification")
myEmailAction.mailServer = "Configuration/MailServer"
myEmailAction.subject = "Application ${deployedApplication.version.application.name} failed."
myEmailAction.toAddresses = ["support@mycompany.com"]
myEmailAction.body = "Deployment of ${deployedApplication.version.application.name} was cancelled on environment ${deployedApplication.environment.name}"
repository.create(myEmailAction)

The subject, toAddresses, fromAddress, body properties accept FreeMarker template syntax and can access the following Deployit objects:

• ${deployedApplication}
• ${task}
• ${step}

For example, ${deployedApplication.version.application.name} refers to the name of the application being deployed.

The email body can also be defined in an external template file. Set the path to the file in the bodyTemplatePath property. This can be either an absolute path, or a relative path that will be resolved via Deployit's classpath. By specifying a relative path, Deployit will look in the ext directory of the Deployit Server and in all (packaged) plugin jar files.

State Transitions

To enable a trigger for deployments, add it to the triggers property of an Environment. The trigger will then listen to state transitions in tasks and steps that occur during a deployment. When the state transition described by the trigger matches, the associated actions are executed.

Deployit 3.8 is shipped with the EmailNotification trigger. Custom trigger actions can be written in Java.

Task state transitions

A TaskTrigger can be defined under the Configuration root and associated with the environment on which it should be triggered.

taskTrigger = factory.configurationItem("Configuration/TriggerOnCancel","trigger.TaskTrigger")
taskTrigger.fromState = "ANY"
taskTrigger.toState   = "CANCELLED"
taskTrigger.actions   = [myEmailAction]
repository.create(taskTrigger)

env = repository.read("Environments/Dev")
env.triggers = ["Configuration/TriggerOnCancel"]
repository.update(env)

Step state transitions

A StepTrigger can be defined under the Configuration root and associated with the environment on which it should be triggered.

stepTrigger = factory.configurationItem("Configuration/TriggerOnFailure","trigger.StepTrigger")
stepTrigger.fromState = "EXECUTING"
stepTrigger.toState   = "FAILED"
stepTrigger.actions   = [myEmailAction]
repository.create(stepTrigger)

env = repository.read("Environments/Dev")
env.triggers = ["Configuration/TriggerOnFailure"]
repository.update(env)