Please note that this microlearning is for the new monitoring stack only.
In this microlearning, we will focus on the situation where a change in your environment needs to be deployed to an environment. A change can be a flow update, a property addition or update, or an update in the "base image" of eMagiz.
Should you have any questions, please contact academy@emagiz.com.
- 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
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.
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.
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.
Key notes to consider during the execution of the plan with flow changes
- With each functional release, the default behavior of the deploy functionality is that a new image is created for each container (i.e., runtime). Consequently, each container (i.e., runtimes) will be restarted.
- When using the property, release only the containers (i.e., runtimes) for which a change is scheduled will be updated. The rest will be untouched.
- All containers (i.e., runtimes) for which no change is scheduled will only be restarted.
- 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. 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 flows are taking place
- A message will be displayed that the deployment is completed
Key notes to consider during the execution of the plan via the "property release" functionality
- With each property release, the default behavior of the deploy functionality is that a new image is created for each container (i.e., runtime) containing a property change. Consequently, only those containers (i.e., runtimes) will be affected.
- All containers (i.e., runtimes) for which no change is scheduled will not be affected.
- 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 of at least one property compared to the active "deployed version" (determined per runtime)
- A global property is linked to all runtimes and therefore all runtimes will be updated.
- 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 flows are taking place
- A message will be displayed that the deployment is completed
- There is one exception to the considerations above, which is when a new "base image" is issued by eMagiz. When that happens, and this is the first release, the considerations for the plan with flow changes need to be consulted.
- 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.
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.