Skip to Content

Deploy a release

Last modified by Erik Bakker on 2024/11/24 09:32

In this microlearning, we’ll focus on how to execute a Deployment plan within eMagiz. A Deployment plan is a sequence of steps required to apply updates and make a release active in your TAP environment. We'll guide you through starting and monitoring the execution of this plan, and highlight key considerations to ensure a smooth deployment process.

Should you have any questions, please contact academy@emagiz.com.

1. Prerequisites

  • Basic knowledge of the eMagiz platform
  • Understanding of Releases and how to set up a Deployment plan
  • Edit rights for your environment in Deploy
  • A change that is added to a release so you can try it yourself

2. Key concepts

This microlearning centers around the execution of a Deployment plan. The deployment plan is a series of steps that need to be executed on any TAP environment to make the release defined active inside the eMagiz runtimes. Active in that all changes made to the release compared to the running environment before executing the deployment plan are applied effectively.

crashcourse-platform-deploy-execute-deployment-plan-gen3--execute-release-button.png

3. Execute a Deployment plan

Provided there is a deployment plan, the execution is initialized from the Releases section. The button highlighted in the figure above is the button to start the deployment plan. The page below is then displayed as an example of the page showing the deployment steps' progress. Pressing the green play button will start the execution of the deployment plan.

crashcourse-platform-deploy-execute-deployment-plan-gen3--overview-default-steps.png

Should eMagiz not be able to execute a specific step because the runtime is not reachable, a pop-up is shown to the user informing the user that an action needs to be taken.

crashcourse-platform-deploy-execute-deployment-plan-gen3--feedback-to-user.png

Information
  • All containers (i.e. runtimes) for which a change is scheduled will be updated. The following criteria are used to determine whether a change is necessary:
    • Update in at least one flow version compared to the active "deployed version."
    • Addition or update of properties created via a functional release or a property release. Please check out this microlearning for information on release properties.
    • New "base image" issued by eMagiz. Please keep an eye on the release notes to see when this happens. Search for "eMagiz version" in Manage to see which image you are currently running.
  • The middle section showing the integration landscape is highlighting in what system the deployment of a flow is happening
  • The right-hand panel shows the log messages from the runtimes where the deployment(s) of runtime are taking place. Look out for "Started eMagiz" logging
  • A message will be displayed that the deployment is completed

4. Key takeaways

  • The execution of a deployment plan is a smooth process to avoid manual deployments of flows
  • Be aware of the specific considerations involved
  • Tune the deployment plan continuously to make it better all the time.

5. Suggested Additional Readings