Changes for page Failover - Configuration

Summary

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

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-Setting up Failover - Design 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.ebakker

Content

...	...	@@ -1,57 +1,37 @@
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 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.
5	5
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		-
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.
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.
	10	+* 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.
	14	+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-linux-installguide.WebHome||target="blank"]] for Linux and in this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-onpremises-server-windows-installguide.WebHome||target="blank"]] for Windows.
19	19
20		-== 3. Design Phase Configuration ==
	16	+== 3. eMagiz Deploy agent installation ==
21	21
22		-== 3.1 Solution Design ==
	18	+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.
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.
	20	+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.
25	25
26		-[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-design-phase-solution-design.png]]
	22	+[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.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}}
29		-
30		-== 3.2 Design Architecture ==
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).
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).
37		-
38		-[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-design-phase-routers.png]]
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.
41		-
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.
	26	+* 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:
	30	+No suggested additional readings for this microlearning.
52	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"]]
	32	+
54	54	)))
	34	+
55	55	(((
56	56	{{toc/}}
57	57	)))