Skip to Content
Last modified by Erik Bakker on 2024/09/27 14:07
From version 28.32
edited by Danniar Firdausy
on 2024/09/25 14:13
Change comment: There is no comment for this version
To version 15.1
edited by Erik Bakker
on 2024/03/01 09:40
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Setting up Failover - Create Phase
1 +Flow Configuration
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.dfirdausy
1 +XWiki.ebakker
Content
... ... @@ -1,61 +1,65 @@
1 1  {{container}}
2 2  {{container layoutStyle="columns"}}
3 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.
4 4  
5 -In the previous microlearning, we discussed what situation that failover mode will be beneficial as well as the settings that need to be configured in the Design phase. Next to that, we also discussed that setting up this failover functionality in your model requires you to first execute some steps in your Design, Create, and lastly Deploy phase. Picking up from what we have discussed previously in the Design phase, in this microlearning, we will focus on configuring your setup in the Create phase if you want to activate the active/passive failover configuration.
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).
6 6  
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 +
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.
14 +* 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.
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 not only assists in that case but also allows you to have a fallback option on an active connection.
16 16  
17 -== 3. Create Phase Configuration ==
20 +== 3. Flow Configuration ==
18 18  
19 -== 3.1 Settings ==
22 +== 3.1 Grouping ==
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.
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 -[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-create-phase-create-settings.png]]
26 +[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-starting-point.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.
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 -== 3.2 Flow Configurations ==
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 are changing. In all subsequent flows, you want to add to the same group, you must use the **same** group name.
28 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.
32 +[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-define-group-name.png]]
30 30  
31 -The first setting that eMagiz configure for you takes place in the connector infra flow of the system that you enable for failover. 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. 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.
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.
32 32  
33 -[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-create-phase-connector-infra.png]]
36 +[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-define-auto-startup.png]]
34 34  
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 +When choosing this option, you will see the following pop-up (assuming the machine still needs to be configured). In this pop-up, you must choose between Linux and Windows as OS. Depending on the server OS you previously installed Docker, you must select Linux or Windows.
47 +
48 +[[image:Main.Images.Microlearning.WebHome@emagiz-runtime-management--intermediate-runtime-management-os-selection.png]]
49 +
50 +Once you have selected the correct OS for you, the next step is to press "Save." This action will lead you to another pop-up showing the command that needs to be executed (with administrator rights) on the host machine. This way, the deploy agent is activated on the host machine.
51 +== 3.3 Failover Infra ==
52 +[[image:Main.Images.Microlearning.WebHome@emagiz-runtime-management--intermediate-runtime-management-deploy-agent-command.png]]
53 +
54 +Once the agent is installed, eMagiz can manage the machine to deploy new runtimes or update runtimes as needed. Also, the container runtime can be controlled with start, stop, and reset 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.
55 +
35 35  == 4. Key takeaways ==
36 36  
37 -* Grouping is beneficial when external systems go through maintenance or downtime.
38 -* 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.
39 -* The role naming in both grouping and failover is crucial. The whole name needs to be matched fully to make it work.
40 -* For the infra configuration of the failover setup, we have a store item that you can use.
58 +* The eMagiz Docker agent needs to be installed to allow runtime to be installed on the on-premises server
41 41  
42 42  == 5. Suggested Additional Readings ==
43 43  
44 -If you are interested in this topic and want more information, please read the help text provided by eMagiz and check out these links:
45 -
46 -* [[eMagiz Store (Menu)>>doc:Main.eMagiz Store.WebHome||target="blank"]]
47 -** [[Accelerators (Navigation)>>doc:Main.eMagiz Store.Accelerators.WebHome||target="blank"]]
48 -*** [[Active/Passive Failover (Explanation)>>doc:Main.eMagiz Store.Accelerators.Active-Passive Failover.WebHome||target="blank"]]
49 -* [[Crash Courses (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]]
50 -** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]]
51 -*** [[Support objects - Introduction (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-support-objects-introduction||target="blank"]]
52 -*** [[Promote flows to deploy (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-promote-flows-to-deploy||target="blank"]]
53 -* [[Intermediate Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Grouping and Failover.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 -** [[eMagiz Cloud Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Cloud Management.WebHome||target="blank"]]
57 -* [[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"]]
58 -)))
62 +There are no suggested additional readings for this microlearning.)))
59 59  (((
60 60  {{toc/}}
61 61  )))