Changes for page Failover - Configuration

Summary

• Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-Setting up Failover - Design Phase
	1	+Flow Configuration

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.dfirdausy
	1	+XWiki.ebakker

Content

...	...	@@ -1,57 +1,74 @@
1	1	{{container}}
2	2	{{container layoutStyle="columns"}}
3	3	(((
4		-eMagiz flows, or more specifically, the flows' inbound components, can be grouped. The benefit from this is that you can later in [[Deploy>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Grouping and Failover.intermediate-grouping-and-failover-deploy-possibilities.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	+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.
5	5
6	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).
7	7
8		-Setting up this failover functionality in your model requires you to first execute some steps in your Design, Create, and lastly Deploy phase. In this microlearning, we will focus on configuring your setup in the Design phase if you want to activate the active/passive failover configuration.
	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	9
10	10	Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
11	11
12	12	== 1. Prerequisites ==
13	13
14		-* Intermediate knowledge of the eMagiz platform.
	14	+* Intermediate knowledge of the eMagiz platform
15	15
16	16	== 2. Key concepts ==
17	17
18		-This microlearning describes how to configure (parts of) of your 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.
19	19
20		-== 3. Design Phase Configuration ==
	20	+== 3. Flow Configuration ==
21	21
22		-== 3.1 Solution Design ==
	22	+== 3.1 Grouping ==
23	23
24		-To configure failover for systems that are connecting with your model, we first need to go to the Design phase. In your Design>Solution Design, find and open the details of the system that you want to enable failover for. Once you do that, then you need to make sure that "Multiple runtimes" option is selected for this system, which is logical since we want to have a second runtime running in case of failover situations (e.g., outage, maintenance, etc.). Afterward, you will see the "Number of runtimes" and "Run in failover" fields. To enable failover, make sure that you fill in 2 as the "Number of runtimes", before selecting the "Run in failover" checkbox. See 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.
25	25
26		-[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-design-phase-solution-design.png]]
	26	+[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-starting-point.png]]
27	27
28		-{{info}}Systems with the failover option enabled must have "Number of runtimes" exactly 2 and must be placed on an external machine in the Architecture panel.{{/info}}
	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}}
29	29
30		-== 3.2 Design Architecture ==
	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.
31	31
32		-Once the previous step is done, the next step is to configure your Design>Architecture. Here, you first need to "Start Editing" and then press "Apply settings" on your bottom left corner. Afterward, you will be faced with a pop-up page informing you that failover will be enabled on the system connector containers that you have previously toggled in Design>Solution Design (see the screenshot below as an example).
	32	+[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-define-group-name.png]]
33	33
34		-[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-design-phase-design-architecture.png]]
35		-
36		-Once you applied the changes, then your Design>Architecture in that environment, will get new router containers placed in your external machines (see the screenshot below as an example). These router containers are responsible for keeping track of the existing group names (in which, runtime containers set to failover are part of those groups) and routing communication between two runtimes (e.g., lead and backup). Next to that, they also facilitate the communication between runtimes when a runtime joins a group (e.g., during startup) or leaves a group (e.g., when becoming inactive).
	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.
37	37
38		-[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-design-phase-routers.png]]
	36	+[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-define-auto-startup.png]]
39	39
40		-When you have done that and satisfied with your landscape configuration, then you are finished in the Design phase and can proceed to the next configuration in the Create phase.
	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.
41	41
	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	+In case you want to expand the grouping functionality to include a active/passive failover component you need to change the settings on the inbound component. Apart from specifying the name of the group 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 in case you configured all support objects correctly. Although we explain the various steps here in the documentation we advise to utilize the store item that we created for this that will guide you in setting this up correctly.
	57	+
	58	+The configuration consists of at least three seperate support objects. Two of them are needed once (infinispan cache manager and clustered lock registry) were the other is needed 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	+Given this let us first look at the infinispan cache manager
	61	+[[image:Main.Images.Microlearning.WebHome@emagiz-runtime-management--intermediate-runtime-management-deploy-agent-command.png]]
	62	+
	63	+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.
	64	+
42	42	== 4. Key takeaways ==
43	43
44		-* The inbound components of eMagiz flows can be grouped, allowing for centralized control, particularly beneficial during system maintenance or outages.
45		-* By enabling multiple runtimes across different machines, you can configure groups to operate in active/passive failover mode, ensuring continued operation during connection failures, system maintenances, or outages.
46		-* Setting up the failover functionality requires configuration in the Design phase, where you enable multiple runtimes and set up failover options in both the Solution Design and Architecture sections.
47		-* In the Design Architecture, router containers are added to manage communication between the lead and backup runtimes, ensuring smooth transitions when a failover runtime becomes inactive or joins a group.
	67	+* The eMagiz Docker agent needs to be installed to allow runtime to be installed on the on-premises server
48	48
49	49	== 5. Suggested Additional Readings ==
50	50
51		-If you are interested in this topic and want more information, please read the help text provided by eMagiz and check out these links:
52		-
53		-* [[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"]]
54		-)))
	71	+There are no suggested additional readings for this microlearning.)))
55	55	(((
56	56	{{toc/}}
57	57	)))