Skip to Content
Last modified by Erik Bakker on 2024/09/27 14:07
From version 28.60
edited by dfirdausy
on 2024/09/25 16:04
Change comment: There is no comment for this version
To version 3.1
edited by eMagiz
on 2023/02/07 13:03
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Setting up Failover - Deploy Phase
1 +eMagiz Deploy agent
Parent
... ... @@ -1,1 +1,1 @@
1 -Main.eMagiz Academy.Microlearnings.Intermediate Level.Grouping and Failover.WebHome
1 +Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.dfirdausy
1 +XWiki.eMagiz
Content
... ... @@ -1,71 +1,37 @@
1 -{{container}}
2 -{{container layoutStyle="columns"}}
3 -(((
1 +{{container}}{{container layoutStyle="columns"}}(((
4 4  
5 -In the previous microlearning, we discussed what needs to be done in the Create phase to enable failover for systems that are configured to have them in the Design phase. Next to that, we also discussed that setting up this failover functionality in your model requires you to execute some steps in your Design, Create, and lastly Deploy phase. Picking up from what we have toggled in the Create phase, in this microlearning, we will focus on the steps and configurations that you have to make in the Deploy phase to activate the active/passive failover functionality.
3 +eMagiz runtimes can run on local, on-premises servers. Main reason is that some systems are only accessible from within the client's infrastructure. In such scenario's that on-premises server needs to be equipped with a linux based Docker installation.
6 6  
7 7  Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
8 8  
9 9  == 1. Prerequisites ==
10 10  
11 -* Intermediate knowledge of the eMagiz platform.
9 +* Intermediate knowledge of the eMagiz platform
12 12  
13 13  == 2. Key concepts ==
14 14  
15 -This microlearning describes what configuration that you will have to do in the Create phase, based on what you have configured in the Design phase, to enable failover for systems connecting with your model. The grouping and failover functionality is relevant when faced with maintenance and outages of systems connected to your model. The failover functionality assists in that case and allows you to have a fallback option on an active connection.
13 +This microlearning describes how the eMagiz Deploy agent is installed on the on-premises server where a eMagiz runtime should run on. Please note that the eMagiz Deploy agent requires a valid Docker installation on the on-premises server. The detailed install guide can be found on [[this link>>https://docs.emagiz.com/bin/view/Main/eMagiz%20Academy/Microlearnings/Expert%20Level/Solution%20Architecture/expert-solution-architecture-onpremises-server-installguide/||target="_blank"]]
16 16  
17 -== 3. Create Phase Configuration ==
15 +== 3. Interpreting log on-premise ==
18 18  
19 -== 3.1 Settings ==
17 +=== 3.7 eMagiz Docker agent installation ===
20 20  
21 -After finishing up your configuration in the Design phase, you can then go to the Settings page on the top right corner of the Create phase. In this page, under the "Failover systems" tab in the "Transfer settings from design" section, you will find the system connector(s) that you can transfer the failover settings from Design. Please check the screenshot below as an example.
19 +eMagiz needs to install a specific agent in the Docker instance that allows to download runtime images that needs to be installed on the Docker instance. The specific command to run inside the Docker instance is specific for the machine that is configured inside eMagiz Design & Deploy Architectures. It can be found inside the eMagiz iPaaS portal under Deploy Architecture. At the runtime connector, there is a right click option called Deploy Agent. That presents either the command or the location where that agent is installed.
22 22  
23 -[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-create-phase-create-settings.png]]
21 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
24 24  
25 -By pressing the "Transfer failover" button, eMagiz will regenerate the connector infra flow of that system as well as update the exit and entry flows connected to that system with the required settings. We will discuss these required settings and what components are affected in the following section.
23 +After installing the agent, you can use the Docker cheat sheet below to see if the docker containers are running and/or images are available.
26 26  
27 -== 3.2 Flow Configurations ==
28 -
29 -As mentioned just now, by pressing that button in Create>Settings, eMagiz will configure the correct settings for you, so then you do not have to configure them manually by yourself. With that being said, this section focuses on showing you the components that are affected and keep you informed of the required components for the failover functionality to work correctly.
30 -
31 -The first setting that eMagiz configures for you takes place in the connector infra flow of the system that you enable for failover from the previous step. The configuration in this infra flow requires of at least three separate support objects. Two support objects will be added here, which are the Infinispan Cache Manager and Clustered Lock Registry. From the screenshot below, you can see that eMagiz, by default, will give the "Cluster name" in the Infinispan Cache Manager as {{code}}failover-<system technical name>{{/code}}. The other one that is also added is the Leader Initiator support object, which is required per unique group that you will have within the context of your runtime. eMagiz also automatically provides the "Role" name in this support object. It will be filled in with the same value as the "Cluster name" later when you have moved to the Deploy phase (e.g., {{code}}failover-xctnln{{/code}} in the example below).
32 -
33 -[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-create-phase-connector-infra.png]]
34 -
35 -The second setting that eMagiz configures for you happens in the exit and entry flows that are connected to that system. Here, eMagiz configures for you (parts of) your flow(s) with the required setting to enable grouping for the failover functionality on the flow level. The configurations for grouping consist of the "Group" name and "Auto startup", which are available for all inbound components. See the screenshot below as an example of an inbound component that has its "Group" name and "Auto startup" configured by eMagiz automatically when enabling the failover functionality.
36 -
37 -{{info}}The grouping functionality here is relevant when faced with maintenance and outages of systems connected to your model.{{/info}}
38 -
39 -[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-create-phase-exit-entry.png]]
40 -
41 -Again, in this part, you do not have to make any changes yourself. Once you are satisfied with the settings that eMagiz has configured for you, then you are finished in the Create phase and can move on to the Deploy phase that will be discussed in the next microlearning.
42 -
43 43  == 4. Key takeaways ==
44 44  
45 -* Grouping is beneficial when external systems go through maintenance or downtime.
46 -* Failover can have the additional benefit of having a fallback scenario while still adhering to the requirement that there can only be one active connection at a time.
47 -* The role naming in both grouping and failover is crucial. The whole name needs to be matched fully to make it work.
48 -* For the infra configuration of the failover setup, we have a store item that you can use.
27 +* The karaf.log can be found within the folder called log under the folder data
28 +* You can search the log with the help of tools such as Notepad++
29 +* By looking at the timestamp in the eMagiz Manage Log, you can run a focused search
49 49  
50 -== 5. Suggested Additional Readings ==
31 +== 6. Suggested Additional Readings ==
51 51  
52 -If you are interested in this topic and want more information, please read the help text provided by eMagiz and check out these links:
33 +No suggested additional readings for this microlearning.
53 53  
54 -* [[eMagiz Store (Menu)>>doc:Main.eMagiz Store.WebHome||target="blank"]]
55 -** [[Accelerators (Navigation)>>doc:Main.eMagiz Store.Accelerators.WebHome||target="blank"]]
56 -*** [[Active/Passive Failover (Explanation)>>doc:Main.eMagiz Store.Accelerators.Active-Passive Failover.WebHome||target="blank"]]
57 -* [[Crash Courses (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]]
58 -** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]]
59 -*** [[Support objects - Introduction (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-support-objects-introduction||target="blank"]]
60 -*** [[Promote flows to deploy (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-promote-flows-to-deploy||target="blank"]]
61 -* [[Intermediate Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Grouping and Failover.WebHome||target="blank"]]
62 -** [[Grouping and Failover (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Grouping and Failover.WebHome||target="blank"]]
63 -*** [[Deploy Possibilities (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Grouping and Failover.intermediate-grouping-and-failover-deploy-possibilities.WebHome||target="blank"]]
64 -** [[eMagiz Cloud Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Cloud Management.WebHome||target="blank"]]
65 -* [[Failover (Search Results)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&l_space_facet=10&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=%22Failover%22||target="blank"]]
66 -)))
67 -(((
68 -{{toc/}}
69 -)))
70 -{{/container}}
71 -{{/container}}
35 +* [[Container commands on containers>>https://docs.docker.com/engine/reference/commandline/ps/||target="blank"]]
36 +* [[Logging commands on containers>>https://docs.docker.com/engine/reference/commandline/logs/||target="blank"]]
37 +)))((({{toc/}}))){{/container}}{{/container}}