Changes for page Failover - Deploy Possibilities

Summary

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

Details

Page properties

Title

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

Author

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

Content

...	...	@@ -1,41 +1,59 @@
1	1	{{container}}
2	2	{{container layoutStyle="columns"}}
3	3	(((
4		-eMagiz runtimes can run on local, on-premises servers. The main reason is that some systems are only accessible within the client's infrastructure. In such a scenario, the on-premises server must have a Docker installation before you can communicate between your on-premise server and eMagiz.
	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.
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	+
6	6	Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
7	7
8	8	== 1. Prerequisites ==
9	9
10		-* Intermediate knowledge of the eMagiz platform
	14	+* Intermediate knowledge of the eMagiz platform.
11	11
12	12	== 2. Key concepts ==
13	13
14		-This microlearning describes how the eMagiz Deploy agent is installed on the on-premises server where an eMagiz runtime should run. 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**.
	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.
15	15
16		-== 3. eMagiz Deploy agent installation ==
	20	+== 3. Design Phase Configuration ==
17	17
18		-eMagiz needs to install a specific agent in the Docker instance that allows the downloading of runtime images that need to be installed on the Docker instance. The exact command to run inside the Docker instance is specific for the machine configured inside eMagiz Design & Deploy Architectures. It can be found inside the eMagiz iPaaS portal under Deploy Architecture. The runtime connector has a right-click option called Deploy Agent.
	22	+== 3.1 Solution Design ==
19	19
20		-[[image:Main.Images.Microlearning.WebHome@emagiz-runtime-management--intermediate-runtime-management-deploy-agent.png]]
	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.). Once you do that, 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.
21	21
22		-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.
	26	+[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-design-phase-solution-design.png]]
23	23
24		-[[image:Main.Images.Microlearning.WebHome@emagiz-runtime-management--intermediate-runtime-management-os-selection.png]]
	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}}
25	25
26		-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.
	30	+== 3.2 Design Architecture ==
27	27
28		-[[image:Main.Images.Microlearning.WebHome@emagiz-runtime-management--intermediate-runtime-management-deploy-agent-command.png]]
29	29
30		-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.
31		-
32	32	== 4. Key takeaways ==
33	33
34		-* The eMagiz Docker agent needs to be installed to allow runtime to be installed on the on-premises server
	35	+* Grouping is beneficial when external systems go through maintenance or downtime.
	36	+* 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.
	37	+* The role naming in both grouping and failover is crucial. The whole name needs to be matched fully to make it work.
	38	+* For the infra configuration of the failover setup, we have a store item that you can use.
35	35
36	36	== 5. Suggested Additional Readings ==
37	37
38		-There are no suggested additional readings for this microlearning.)))
	42	+If you are interested in this topic and want more information, please read the help text provided by eMagiz and check out these links:
	43	+
	44	+* [[eMagiz Store (Menu)>>doc:Main.eMagiz Store.WebHome||target="blank"]]
	45	+** [[Accelerators (Navigation)>>doc:Main.eMagiz Store.Accelerators.WebHome||target="blank"]]
	46	+*** [[Active/Passive Failover (Explanation)>>doc:Main.eMagiz Store.Accelerators.Active-Passive Failover.WebHome||target="blank"]]
	47	+* [[Crash Courses (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]]
	48	+** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]]
	49	+*** [[Support objects - Introduction (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-support-objects-introduction||target="blank"]]
	50	+*** [[Promote flows to deploy (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-promote-flows-to-deploy||target="blank"]]
	51	+* [[Intermediate Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Grouping and Failover.WebHome||target="blank"]]
	52	+** [[Grouping and Failover (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Grouping and Failover.WebHome||target="blank"]]
	53	+*** [[Deploy Possibilities (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Grouping and Failover.intermediate-grouping-and-failover-deploy-possibilities.WebHome||target="blank"]]
	54	+** [[eMagiz Cloud Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Cloud Management.WebHome||target="blank"]]
	55	+* [[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"]]
	56	+)))
39	39	(((
40	40	{{toc/}}
41	41	)))