Skip to Content

Wiki source code of Reset Runtime

Last modified by Martijn Woudstra on 2023/04/13 15:34
Hide last authors
Martijn Woudstra 1.1 1 {{container}}
2 {{container layoutStyle="columns"}}
3 (((
4 In the previous [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-restart-runtime.WebHome||target="blank"]], we learned about restarting runtimes. In that [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-restart-runtime.WebHome||target="blank"]], we learned that restarting the runtime does not affect flows, data, psychical hardware, or otherwise. It is simply jump-starting the runtime or machine once more. In this microlearning, however, we will focus on the action to reset a runtime. A reset on the other hand is the more aggressive approach and does have a significant effect. In other words, the main difference is that with a reset you begin with a clean slate compared to the simple restart.
5
6 Having said that there are some cases where it can become beneficial to reset a runtime. For instance when running into memory issues or when doing large bulk build number upgrades.
7
8 Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
9
10 == 1. Prerequisites ==
11
12 * Intermediate knowledge of the eMagiz platform
13 * Intermediate knowledge of runtime management
14
15 == 2. Key concepts ==
16
17 This microlearning centers around resetting a runtime
18 With resetting, we mean: Ensure that we begin with a clean slate and forget about what happened before
19
20 * A reset is the more aggressive approach compared to a restart.
21 * The reset does the following on runtime level:
22 ** Stops the runtime service (if running)
23 ** Removes data (except Artemis folder + revision info)
24 ** Removes local repository folder
25 ** Starts the runtime service (if stopped at step 1)
26 * With a reset, you start with a clean slate
27 ** Flow version could be different based on changes in the release
28 ** Custom H2 database is emptied
29
30 == 3. Reset runtime ==
31
32 In the previous [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-restart-runtime.WebHome||target="blank"]], we learned about restarting runtimes. In that [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-restart-runtime.WebHome||target="blank"]], we learned that restarting the runtime does not affect flows, data, psychical hardware, or otherwise. It is simply jump-starting the runtime or machine once more. In this microlearning, however, we will focus on the action to reset a runtime. A reset on the other hand is the more aggressive approach and does have a significant effect. In other words, the main difference is that with a reset you begin with a clean slate compared to the simple restart.
33
34 Having said that there are some cases where it can become beneficial to reset a runtime. For instance when running into memory issues or when doing large bulk build number upgrades.
35
36 In short, the reset action can be described by the following:
37
38 * A reset is the more aggressive approach compared to a restart.
39 * The reset does the following on runtime level:
40 ** Stops the runtime service (if running)
41 ** Removes data (except Artemis folder + revision info)
42 ** Removes local repository folder
43 ** Starts the runtime service (if stopped at step 1)
44 * With a reset, you start with a clean slate
45 ** Flow version could be different based on changes in the release
46 ** Custom H2 database is emptied
47
48 To execute this action please navigate to Deploy -> Architecture (if you are not there already). After you have done so you can access the context menu of a particular runtime (via a right mouse click), while in "Start Editing" mode, and select the option called "Reset runtime".
49
50 [[image:Main.Images.Microlearning.WebHome@intermediate-emagiz-runtime-management-reset-runtime--context-menu-reset-runtime.png]]
51
52 By pressing this button your executes all steps mentioned above.
53
54 To verify that everything went correctly and your runtime is running correctly you can access the details pop-up on Architecture level. In here you can access the "Status" tab to check the status of your runtime.
55
56 [[image:Main.Images.Microlearning.WebHome@intermediate-emagiz-runtime-management-reset-runtime--context-menu-details-runtime-status-tab.png]]
57
58 Subsequently you can double check this by looking at the logs under Manage -> Log Entries.
59
60 {{warning}}Note that when you have a custom H2 database on runtime level (i.e. for storing metadata) the H2 database will be deleted as well when you remove the runtime. To safeguard against this you could store your H2 database on EFS. Please take a look at the help text for the URL field on the JDBC H2 connection pool component for more information.
61
62 [[image:Main.Images.Microlearning.WebHome@intermediate-emagiz-runtime-management-reset-runtime--help-text-h2-efs.png]]{{/warning}}
63
64 == 4. Key takeaways ==
65
66 * A reset is the more aggressive approach compared to a restart.
67 * The reset does the following on cloud level:
68 ** Stops the runtime service (if running)
69 ** Removes data (except Artemis folder + revision info)
70 ** Removes local repository folder
71 ** Starts the runtime service (if stopped at step 1)
72 * With a reset, you start with a clean slate
73 ** Flow version could be different based on changes in the release
74 ** Custom H2 database is emptied
75
76 == 5. Suggested Additional Readings ==
77
78 There are no suggested additional readings on this topic)))
79 ((({{toc/}}))){{/container}}
80 {{/container}}