Skip to Content
Version 1.1 by eMagiz on 2022/05/10 11:24
Show last authors
1 {{html wiki="true"}}
2 <div class="ez-academy">
3 <div class="ez-academy_body">
4
5 <div class="doc">
6
7
8
9 = Setting up a deployment plan =
10
11 In this microlearning, we will focus on the various options to create and edit properties i.e. property management.
12
13 Should you have any questions, please contact academy@emagiz.com.
14
15 * Last update: February 4th, 2021
16 * Required reading time: 4 minutes
17
18 == 1. Prerequisites ==
19
20 * Basic knowledge of the eMagiz platform
21 * Understand eMagiz releases in basics
22 * Have an environment where you can add releases and that is operational to try out the deployment plan
23
24 == 2. Key concepts ==
25
26 This microlearning centers around the Deployment plan. The deployment plan is a series of steps that need to be executed on a TAP environment to make the release defined as active. Active in the sense that all changes made to the release compared to the running environment before executing the deployment plan are applied effectively.
27
28 The Deployment plan is defined in the Deployment Plan section under Deploy. Each Test, Acceptance and Production environment have their plan, and across an environment, the plan may vary. The Deployment plan is executed from the Release itself, using the options that a Release has.
29
30 <p align="center">[[image:crashcourse-platform-deploy-setup-deployment-plan-pic1.png||]]</p>
31
32
33
34 == 3. Defining the Deployment plan ==
35
36 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.
37
38 <p align="center">[[image:crashcourse-platform-deploy-setup-deployment-plan--default-deployment-plan.png||]]</p>
39
40 === 3.1 Enable or disable triggers ===
41
42 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.
43 At the same time, you can enable these triggers as the last step in any deployment plan.
44
45 === 3.2 Deploy flows ===
46
47 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.
48
49 * Install (updated) flows from that container
50 * Stop all flows from that container
51 * Start all flows from that container
52 * Remove all old flows from that container
53
54 === 3.3 Restart runtime ===
55
56 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.
57
58 === 3.4 Manual steps ===
59
60 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.
61
62 === 3.5 Keep the deployment plan up to date ===
63
64 The following ways will help to keep the plan up to date:
65
66 * Use the Default plan option to handle 90% of all cases so that every new runtime is automatically added
67 * Copy the plan to the next environment to align all plans in the same way.
68 * Ensure to have a Prepare deployment step in your work definition (sprint) and improve the deployment at each iteration
69
70 ===== Practice =====
71
72 == 4. Assignment ==
73
74 Go to your environment, and try to add a deployment plan for your environment. Experiments with all options, and ensure to run the deployment plan at least once. Be so familiar with the plan that you will use this approach to refresh your environment at all times.
75
76 == 5. Key takeaways ==
77
78 * The deployment plan is part of the Release Management feature set of eMagiz
79 * Using the deployment plan, you are always sure that the release defined is the release that runs on any environment (notably the production environment)
80 * The deployment plan is a must-have to deploy all the changes in an active release on an environment
81 * Keep the plan up to date is easy, and takes away the manual effort to deploy flows on the different runtimes.
82
83
84
85 == 6. Suggested Additional Readings ==
86
87 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.
88
89 == 7. Silent demonstration video ==
90
91 This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
92
93 <iframe width="1280" height="720" src="../../vid/microlearning/crashcourse-platform-deploy-setup-deployment-plan-video.mp4" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
94
95 </div>
96
97 </div>
98 </div>
99
100 {{/html}}