Setting up a deployment plan

Last modified by Erik Bakker on 2023/01/24 15:17

In this microlearning, we will focus on setting up a deployment plan and learn about the considerations when setting up such a deployment plan.

Should you have any questions, please contact

1. Prerequisites

  • Basic knowledge of the eMagiz platform
  • Understand eMagiz releases in basics
  • Have an environment where you can add releases that is operational to try out the deployment plan

2. Key concepts

This microlearning centers around the Deployment plan. The deployment plan is a series of steps that must be executed on a TAP environment to deploy the (active) release. Active in that all changes made to the release compared to the running environment are applied effectively before executing the deployment.

The Deployment plan is defined in the Deployment Plan section under Deploy. Each Test, Acceptance, and Production environment has its plan, and the plan may vary across the environments. The Deployment plan is executed from the release itself, using a Release's options.


3. Defining the Deployment plan

Below is a screenshot of a very basic Deployment plan. In the next section, we'll take a look at the options available for configuration. These are referred to as steps and can be added with the button New as can be seen below.


3.1 Enable or disable triggers

One of the steps is to disable all triggers that are defined in the Manage phase. Running a deployment plan means certain flows are stopped, new ones deployed and the entire runtime might be stopped and started. Depending on the alerting approach, specific alerts will be triggered during execution which is to be regarded as false-positive alerts. Making this step the first one of any deployment plan would prevent this from happening.
At the same time, you can enable these triggers as the last step in any deployment plan.

3.2 Deploy flows

For every runtime or connector, the actions on the flows can be defined. Hereunder the options available for this step. Note that only changed, deleted or new flows will be handled in any option.

  • Install (updated) flows from that container
  • Stop all flows from that container
  • Start all flows from that container
  • Remove all old flows from that container

3.3 Restart runtime

In specific cases, an entire runtime can be just restarted. During larger deployment, this helps to clean up the metaspace section of the memory allowing more flows to be deployed effectively. After a restart, more capability exists for that.

3.4 Manual steps

All the above options are automated steps. In case a specific step needs to be taken before any next automated step needs to be taken, a manual step can be added. The description helps to describe it, and the deployment steps will halt at this part. It is however often used for pre-deployment and post-deployment reminders.

3.5 Keep the deployment plan up to date

The following ways will help to keep the plan up to date:

  • Use the Default plan option to handle 90% of all cases so that every new runtime is automatically added
  • Copy the plan to the next environment to align all plans in the same way.
  • Ensure to have a Prepare deployment step in your work definition (sprint) and improve the deployment at each iteration

4. Key takeaways

  • The deployment plan is part of the Release Management feature set of eMagiz
  • Using the deployment plan, you are always sure that the release defined is the release that runs on any environment (notably the production environment)
  • The deployment plan is a must-have to deploy all the changes in an active release on an environment
  • Keep the plan up to date is easy, and takes away the manual effort to deploy flows on the different runtimes.

5. Suggested Additional Readings

If you are interested in this topic and want more information on it please read the help text provided by eMagiz when executing these actions.