Skip to Content

Changes for page Failover - Configuration

Last modified by Erik Bakker on 2024/09/27 14:06
From version 9.1
edited by Eva Torken
on 2023/09/20 14:36
Change comment: There is no comment for this version
To version 17.1
edited by Erik Bakker
on 2024/03/01 13:28
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -eMagiz Deploy agent
1 +Flow Configuration
Parent
... ... @@ -1,1 +1,1 @@
1 -Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome
1 +Main.eMagiz Academy.Microlearnings.Intermediate Level.Grouping and Failover.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.etorken
1 +XWiki.ebakker
Content
... ... @@ -1,7 +1,12 @@
1 -{{container}}{{container layoutStyle="columns"}}(((
1 +{{container}}
2 +{{container layoutStyle="columns"}}
3 +(((
4 +eMagiz flows, or more specifically, the flow's inbound component(s), can be grouped. The effect is that you can later in [[Deploy>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Grouping and Failover.intermediate-grouping-and-failover-flow-configuration.WebHome||target="blank"]], control them as one entity. This is mainly beneficial when faced with substantial maintenance or outage of systems connected to your eMagiz model.
2 2  
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 +Building on this functionality, you can even configure the group to run in an active/passive failover mode when you activate the multiple runtimes option on your runtime, and each separate runtime is deployed on another machine. The failover functionality is not only relevant in cases of server maintenance. It can also assist you when you want to exchange data with a system that allows only one active connection. Should this connection be business-critical, you can use this failover functionality to create a passive failover situation that will take over when the active connection breaks down (regardless of the reason).
4 4  
8 +In this microlearning, we will focus on configuring the flow to group various inbound components and configure the flow (including the infra) if you want to activate the active/passive failover configuration.
9 +
5 5  Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
6 6  
7 7  == 1. Prerequisites ==
... ... @@ -10,23 +10,94 @@
10 10  
11 11  == 2. Key concepts ==
12 12  
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 in this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-onpremises-server-installguide.WebHome||target="blank"]].
18 +This microlearning describes how to configure (parts of) your flow(s) to set up the grouping and, if needed, the failover functionality on the flow level. The grouping 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.
14 14  
15 -== 3. eMagiz Deploy agent installation ==
20 +== 3. Flow Configuration ==
16 16  
17 -eMagiz needs to install a specific agent in the Docker instance that allows to download runtime images that need 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. In case the command is presented it means that this machine is not yet equipped with the eMagiz Deploy agent. The command can be executed inside the Linux command prompt on the on-premises server.
18 -
19 -Once the agent is installed, eMagiz can manage the machine to deploy new runtimes and or update runtimes as needed. Also the container runtime can be controlled with start, stop, et commands. Please consult this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-interpret-on-premise-logging.WebHome||target="blank"]] to inspect the on-premises runtime logs.
22 +== 3.1 Grouping ==
20 20  
21 -[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
24 +To configure grouping, we need to open the flow designer of the flow in Create. We want to edit and enter "Start Editing" mode. On the inbound component(s) in the flow, we now have an "Advanced" tab that allows you to configure the grouping information.
22 22  
23 -== 4. Key takeaways ==
26 +[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-starting-point.png]]
24 24  
25 -* The eMagiz Docker agent needs to be installed to allow runtime to be installed on the on-premises server
28 +{{info}}Note that the options above are available in all inbound components. The one chosen above is simply an illustration of how to configure.{{/info}}
26 26  
27 -== 5. Suggested Additional Readings ==
30 +Once on the "Advanced" tab, you must define the group name. You can determine the group name if this is the first flow you change. In all subsequent flows, you want to add to the same group, you must use the **same** group name.
28 28  
29 -No suggested additional readings for this microlearning.
32 +[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-define-group-name.png]]
30 30  
34 +Once filled in, ensure that the auto startup configuration is set to Yes to ensure that, on default, all flows within the group start up when the container is started.
31 31  
32 -)))((({{toc/}}))){{/container}}{{/container}}
36 +[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-define-auto-startup.png]]
37 +
38 +Within a runtime context, you can add multiple groups that can be stopped and started separately from each other. In this example, we would also like to have a group for our exits to stop them if the connecting system undergoes maintenance or is down to store the messages in the queue.
39 +
40 +[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-starting-point-exit.png]]
41 +
42 +[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-other-group.png]]
43 +
44 +== 3.2 Failover ==
45 +
46 +If you want to expand the grouping functionality to include an active/passive failover component, you need to change the settings on the inbound component. Apart from specifying the group name, you need to configure the auto-startup option on "No" so the failover configuration can take the correct actions in all situations.
47 +
48 +[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-failover-example-group.png]]
49 +
50 +[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-failover-other-group.png]]
51 +
52 +{{info}}Note that each group within a single runtime that you want to treat differently needs to have a **unique** name.{{/info}}
53 +
54 +== 3.3 Failover Infra ==
55 +
56 +The configuration of the infra flow of the runtime for which you want to configure the failover is detailed and only works if you configure all support objects correctly. Although we explain the various steps in the documentation, we advise utilizing the store item we created for this that will guide you in setting this up correctly.
57 +
58 +The configuration consists of at least three separate support objects. Two are needed once (infinispan cache manager and clustered lock registry), whereas the other is required per unique group you have defined within the context of your runtime. So, if you have two unique group names within the runtime, you need two leader initiator support objects.
59 +
60 +=== 3.3.1 Infinispan Cache Manager ===
61 +
62 +Given this, let us first look at the Infinispan cache manager. You can add this support object in the [[standard manner>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-support-objects-introduction.WebHome||target="blank"]] by searching for "infinispan cache manager."
63 +
64 +[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-cache-manager-search-result.png]]
65 +
66 +Once found, give it a name and fill in a cluster name.
67 +
68 +[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-cache-manager-basic.png]]
69 +
70 +Once done, switch to the "Advanced" tab, select the option "TCP Ping," and fill in the "Host address" and "Other host addresses". Once filled in, press Save to keep your changes.
71 +
72 +[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-cache-manager-advanced.png]]
73 +
74 +=== 3.3.2 Clustered Lock Registry ===
75 +
76 +Now that we have the cache manager, we can configure the next support object on our list, the clustered lock registry. You can add this support object in the [[standard manner>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-support-objects-introduction.WebHome||target="blank"]] by searching for "lock registry."
77 +
78 +[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-lock-registry-search-result.png]]
79 +
80 +Once found, name it and select the cache manager support object you created.
81 +
82 +[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-lock-registry-basic.png]]
83 +
84 +=== 3.3.3 Leader Initiator ===
85 +
86 +Lastly, we need to configure a leader initiator for each **unique** group we have defined within the context of the runtime, and that uses the failover functionality. You can add this support object in the [[standard manner>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-support-objects-introduction.WebHome||target="blank"]] by searching for "leader."
87 +
88 +[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-leader-initiator-search-result.png]]
89 +
90 +Once found, give it a name, define the role name (which should **exactly** match the name you gave in the inbound components), and link it to the lock registry.
91 +
92 +[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-leader-initiator-basic.png]]
93 +
94 +== 4. Key takeaways ==
95 +
96 +* Grouping is beneficial when external systems go through maintenance or downtime.
97 +* 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
98 +* The role naming in both grouping and failover is crucial. The whole name needs to be matched fully to make it work.
99 +* For the infra configuration of the failover setup, we have a store item that you can use.
100 +
101 +== 5. Suggested Additional Readings ==
102 +
103 +There are no suggested additional readings for this microlearning.)))
104 +(((
105 +{{toc/}}
106 +)))
107 +{{/container}}
108 +{{/container}}