Skip to Content
Last modified by Erik Bakker on 2024/09/27 14:07
From version 28.89
edited by dfirdausy
on 2024/09/26 10:44
Change comment: There is no comment for this version
To version 12.2
edited by Erik Bakker
on 2024/03/01 09:05
Change comment: Update document after refactoring.

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Setting up Failover - Deploy Phase
1 +intermediate-grouping-and-failover-flow-configuration
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.dfirdausy
1 +XWiki.ebakker
Content
... ... @@ -1,67 +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. 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.
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. (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).
38 -
39 -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. The idea here is that you fill in the IP address and the (open) port of the external machines. Thus, based on the example above, you can search for the keyword "external01.failover.internal-ip" and then select it. Afterward, you can set this property as global for simplicity and fill in the correct value. The screenshot below shows an example of the end result. Once you have done so, then you can do the same for the other property (i.e., "external01.failover.port") and as well as the properties for the second machine.
40 -
41 -[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-deploy-phase-failover-properties.png]]
42 -
43 -When you are done, then you can save your changes, and proceed with creating a new release. For this, you will need to create a new release from your "Create phase", in order to include all configurations that eMagiz has provided in your now failover-enabled Create phase. Once you have done this, give the release a name and save it, then you can proceed with activating the release and deploy it.
44 -
45 -== 3.3 Trigger Failover ==
46 -
47 -Once you have successfully deployed and run your release with the failover connector runtimes, then you can observe the follower and leadership status of your failover connector runtimes in your Deploy>Architecture. There, if you right-click your external machines (which have the failover connector runtimes) and select "Start/Stop flows", under the "Groups" tab, you will find the "Group name", "Failover status", as well as the "State" the connector runtime is in at the moment (whether it is now On or Off). See the screenshot below as an example.
48 -
49 -[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-deploy-phase-start-stop.png]]
50 -
51 -The example above shows that, in that moment, the first runtime instance is currently active and acting as the Leader, while the second runtime instance that acts as the Follower is Off. You can also manually switch the leadership from one to another by clicking the Play or Stop button on the right-side.
52 -
53 53  == 4. Key takeaways ==
54 54  
55 -* In the Deploy>Architecture section, users can configure the router containers and set preferred machines for failover runtime leadership. This ensures that systems are prepared to handle failover scenarios.
56 -* If users assigned the failover IP addresses and Ports properties as global properties, users must configure a "Balance failover" deployment step to trigger the failover container(s) to be running on its preferred machine as you previously configured them in Deploy>Architecture.
57 -* After deployment, users can monitor the failover status, including leadership roles, in Deploy>Architecture, and can manually switch between active (Leader) and backup (Follower) runtimes if needed.
34 +* The eMagiz Docker agent needs to be installed to allow runtime to be installed on the on-premises server
58 58  
59 59  == 5. Suggested Additional Readings ==
60 60  
61 -If you are interested in this topic and want more information, please read the help text provided by eMagiz and check out these links:
62 -
63 -* [[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"]]
64 -)))
38 +There are no suggested additional readings for this microlearning.)))
65 65  (((
66 66  {{toc/}}
67 67  )))