Last modified by Erik Bakker on 2024/09/27 14:07

From version 28.78
edited by dfirdausy
on 2024/09/25 20:33
Change comment: There is no comment for this version
To version 12.1
edited by Erik Bakker
on 2024/02/09 14:04
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Setting up Failover - Deploy 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,49 +1,41 @@
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 4  
5 -In the previous microlearning, we discussed what needs to be done in the Create phase to enable failover for systems that are configured to have them in the Design phase. Next to that, we also discussed that setting up this failover functionality in your model requires you to execute some steps in your Design, Create, and lastly Deploy phase. Picking up from what we have toggled in the Create phase, in this microlearning, we will focus on the steps and configurations that you have to make in the Deploy phase to activate the active/passive failover functionality.
6 -
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.
10 +* 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 Deploy phase, based on what you have configured in the Design and Create 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 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**.
16 16  
17 -== 3. Deploy Phase Configuration ==
16 +== 3. eMagiz Deploy agent installation ==
18 18  
19 -== 3.1 Deploy Architecture ==
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.
20 20  
21 -After finishing up your configuration in the Create phase, you can then move to your Deploy>Architecture. Here, you will see the new router containers, which we have seen in the Design>Architecture, to be added to your external machines. When you press "Start Editing" in this page, and then press "Apply to environment", you will be faced with a pop-up page that informs you that these router containers will be created for this specific environment as shown in the screenshot below.
20 +[[image:Main.Images.Microlearning.WebHome@emagiz-runtime-management--intermediate-runtime-management-deploy-agent.png]]
22 22  
23 -[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-deploy-phase-router-containers.png]]
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.
24 24  
25 -Once you have applied the changes, when you go to the "Details" of each of those machines via right-clicking them, then you can find and set for each failover runtime the preferred machine to be the leader. As an example shown in the screenshot below, there are two runtimes that are enabled for failover and you can select whether that runtime running in that "External 01" machine is the preferred leader. Another option is to set the runtime that you select as the backup, or reset it back to "None" if you want.
24 +[[image:Main.Images.Microlearning.WebHome@emagiz-runtime-management--intermediate-runtime-management-os-selection.png]]
26 26  
27 -[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-deploy-phase-failover-preference.png]]
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.
28 28  
29 -When you have made your decision, and assuming that your machines are already deployed and running, then you can move to the other page discussed in the next section.
28 +[[image:Main.Images.Microlearning.WebHome@emagiz-runtime-management--intermediate-runtime-management-deploy-agent-command.png]]
30 30  
31 -== 3.2 Deployment Plan ==
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.
32 32  
33 -If this is the first time that you configure your failover setup, then the next step in Deploy is to check the Deployment Plan. Here, you can add a deployment step called "Balance failover", which, when executed, will trigger the failover container(s) to be running on its preferred machine as you previously configured them in Deploy>Architecture.
34 -
35 -== 3.3 Deploy Release ==
36 -
37 37  == 4. Key takeaways ==
38 38  
39 -...
34 +* The eMagiz Docker agent needs to be installed to allow runtime to be installed on the on-premises server
40 40  
41 41  == 5. Suggested Additional Readings ==
42 42  
43 -If you are interested in this topic and want more information, please read the help text provided by eMagiz and check out these links:
44 -
45 -* [[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"]]
46 -)))
38 +There are no suggested additional readings for this microlearning.)))
47 47  (((
48 48  {{toc/}}
49 49  )))