Skip to Content
Last modified by Erik Bakker on 2024/09/27 14:07
From version 28.80
edited by dfirdausy
on 2024/09/25 20:50
Change comment: There is no comment for this version
To version 9.1
edited by etorken
on 2023/09/20 14:36
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.etorken
Content
... ... @@ -1,53 +1,32 @@
1 -{{container}}
2 -{{container layoutStyle="columns"}}
3 -(((
1 +{{container}}{{container layoutStyle="columns"}}(((
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.
3 +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.
6 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.
9 +* 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.
13 +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-installguide.WebHome||target="blank"]].
16 16  
17 -== 3. Deploy Phase Configuration ==
15 +== 3. eMagiz Deploy agent installation ==
18 18  
19 -== 3.1 Deploy Architecture ==
17 +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.
18 +
19 +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.
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.
21 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
22 22  
23 -[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-deploy-phase-router-containers.png]]
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. Next to that, notice that here you can find the "Internal IP address" and "Failover port" fields, which have been pre-filled in with property placeholders. We will comeback to these properties later in the following sections.
26 -
27 -[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-deploy-phase-failover-preference.png]]
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.
30 -
31 -== 3.2 Deployment Plan ==
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. (Next to that, you can also find the "Group" deployment step. Discuss this step here.)
34 -
35 -== 3.3 Deploy Release ==
36 -
37 -Once you have configured your Deployment Plan, then it is time to create a new release for your updated flows in the Deploy>Release page. As you might have noticed in the Deploy>Architecture earlier when opening the "Failover" tab in your machines' "Details", there are properties regarding the machines' "Internal IP address" and "Failover port". It is then becomes natural that you first need to fill in these property values in the environment that you are working on at the moment (i.e., Testing, Acceptance, Production). To do this, you can click the "wrench" icon on the right hand side beside the "Create phase" release and then press "New". In the pop-up presented to you, you can click the "Name" input field and then search for the property placeholder names that you saw earlier. Based on the example above, then you can search for {{code}}external01.failover.{{/code}} as shown in the example below.
38 -
39 39  == 4. Key takeaways ==
40 40  
41 -...
25 +* The eMagiz Docker agent needs to be installed to allow runtime to be installed on the on-premises server
42 42  
43 43  == 5. Suggested Additional Readings ==
44 44  
45 -If you are interested in this topic and want more information, please read the help text provided by eMagiz and check out these links:
29 +No suggested additional readings for this microlearning.
46 46  
47 -* [[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"]]
48 -)))
49 -(((
50 -{{toc/}}
51 -)))
52 -{{/container}}
53 -{{/container}}
31 +
32 +)))((({{toc/}}))){{/container}}{{/container}}