Skip to Content

Wiki source code of Deploy a release

Last modified by Erik Bakker on 2024/11/24 09:32
Show last authors
1 {{container}}
2 {{container layoutStyle="columns"}}(((
3
4 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.
5
6 Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
7
8 == 1. Prerequisites ==
9
10 * Basic knowledge of the eMagiz platform
11 * Understanding of Releases and how to set up a Deployment plan
12 * Edit rights for your environment in Deploy
13 * A change that is added to a release so you can try it yourself
14
15 == 2. Key concepts ==
16
17 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.
18
19 [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-execute-deployment-plan-gen3--execute-release-button.png]]
20
21 == 3. Execute a Deployment plan ==
22
23 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.
24
25 [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-execute-deployment-plan-gen3--overview-default-steps.png]]
26
27 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.
28
29 [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-execute-deployment-plan-gen3--feedback-to-user.png]]
30
31 {{info}}* 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:
32 ** Update in at least **one** flow version compared to the active "deployed version."
33 ** Addition or update of properties created via a **functional** release or a **property** release. Please check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-deploy-property-management-new.WebHome||target="blank"]] for information on release properties.
34 ** New "base image" issued by eMagiz. Please keep an eye on the [[release notes>>Main.Release Information.Portal.WebHome||target="blank"]] to see when this happens. Search for "eMagiz version" in Manage to see which image you are currently running.
35 * The middle section showing the integration landscape is highlighting in what system the deployment of a flow is happening
36 * 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
37 * A message will be displayed that the deployment is completed{{/info}}
38
39 == 4. Key takeaways ==
40
41 * The execution of a deployment plan is a smooth process to avoid manual deployments of flows
42 * Be aware of the specific considerations involved
43 * Tune the deployment plan continuously to make it better all the time.
44
45 == 5. Suggested Additional Readings ==
46
47 * [[Crash Courses (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]]
48 ** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]]
49 *** [[Setting up a deployment plan (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-deploy-setup-deployment-plan-gen3||target="blank"]]
50 *** [[Creating a new Release (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-deploy-create-new-release||target="blank"]]
51 *** [[Property Management (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-deploy-property-management-new.WebHome||target="blank"]]
52 *** [[Actualize properties (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-deploy-actualize-properties-gen3-new.WebHome||target="blank"]]
53 * [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
54 ** [[Grouping and Failover (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Grouping and Failover.WebHome||target="blank"]]
55 *** [[Deploy Possibilities (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Grouping and Failover.intermediate-grouping-and-failover-deploy-possibilities.WebHome||target="blank"]]
56 * [[Deployment Plan (Search Result)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=%22deployment+plan%22||target="blank"]]
57
58 )))((({{toc/}}))){{/container}}
59 {{/container}}