Skip to Content
Last modified by Erik Bakker on 2024/09/27 14:07
From version 30.1
edited by Erik Bakker
on 2024/09/27 14:07
Change comment: There is no comment for this version
To version 29.13
edited by Danniar Firdausy
on 2024/09/27 09:46
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ebakker
1 +XWiki.dfirdausy
Content
... ... @@ -16,23 +16,21 @@
16 16  
17 17  == 3. Deploy Phase Possibilities ==
18 18  
19 -=== 3.1 Deploy Architecture ===
19 +== 3.1 Deploy Architecture ==
20 20  
21 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.
22 22  
23 23  {{info}}**Note**: Here, we assume a typical situation where you have already two external machines deployed. Please refer to these microlearnings if you want to know more about [[deploy architecture>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-deploy-understanding-deploy-architecture-basic||target="blank"]], [[deploying on-premise machine(s)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]], and [[apply to environment>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Cloud Management.intermediate-emagiz-cloud-management-apply-to-environment||target="blank"]].{{/info}}
24 24  
25 -=== 3.2 Failover Balancing Preference ===
25 +== 3.2 Failover Balancing Preference ==
26 26  
27 -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.
27 +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.
28 28  
29 -{{warning}}If you do not set the leadership balancing preference here (i.e., leave the "Preferred machine" to None), then, when deploying your release later, both failover connector runtimes will be active and assume leadership.{{/warning}}
30 -
31 31  [[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-deploy-phase-failover-preference.png]]
32 32  
33 -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. 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.
31 +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.
34 34  
35 -=== 3.3 Deployment Plan ===
33 +== 3.3 Deployment Plan ==
36 36  
37 37  If this is the first time that you configure your failover setup, then the next step in Deploy is to check your 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. See the screenshot below.
38 38  
... ... @@ -42,7 +42,7 @@
42 42  
43 43  [[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-deploy-phase-deployment-plan.png]]
44 44  
45 -=== 3.4 Deploy Release ===
43 +== 3.4 Deploy Release ==
46 46  
47 47  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". Thus, 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). If you are unsure on how to do this, please refer to this [[Property Management>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-deploy-property-management-new.WebHome||target="blank"]] microlearning.
48 48  
... ... @@ -52,7 +52,7 @@
52 52  
53 53  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", 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.
54 54  
55 -=== 3.5 Runtime Failover Status ===
53 +== 3.5 Runtime Failover Status ==
56 56  
57 57  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">>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-start-stop-flows.WebHome||target="blank"]], under the "Groups" tab, you will find the "Group name", "Failover status", as well as the "State" the connector runtime is in at that moment (whether it is now On or Off). See the screenshot below as an example.
58 58  
... ... @@ -60,23 +60,23 @@
60 60  
61 61  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.
62 62  
63 -==== 3.5.1 Failover Status Explained ====
61 +=== 3.5.1 Failover Status Explained ===
64 64  
65 65  Within a failover setup, each inbound can have one of the distinct states listed below. This section explains briefly the meaning of each state.
66 66  
67 -===== 3.5.1.1 Leader Status =====
65 +==== 3.5.1.1 Leader Status ====
68 68  
69 69  If the leader status is shown, it means that this container is the Leader of this group. As a result, all inbound components with the same group name in this container are actively running.
70 70  
71 -===== 3.5.1.2 Follower Status =====
69 +==== 3.5.1.2 Follower Status ====
72 72  
73 73  The follower status is closely tied to the leader status. Inbounds with this status act as the backup. When the active Leader stops, the followers will take the Leader status. By default, the starting status of these inbounds is stopped (grey lightbulb).
74 74  
75 -===== 3.5.1.3 Disabled Status =====
73 +==== 3.5.1.3 Disabled Status ====
76 76  
77 77  If the container inbounds have the status disabled, the failover is inactive. This means that the components are stopped (grey lightbulb) but will not react if the Leader stops working. To continue failover behavior, please use the steps above in Deploy -> Architecture.
78 78  
79 -===== 3.5.1.4 Leader (single node) Status =====
77 +==== 3.5.1.4 Leader (single node) Status ====
80 80  
81 81  The last possible status is Leader (single node). This means the inbound acts as a separate normal inbound with no (failover) connectivity to other containers with a similar configured group name. Suppose this status occurs in a failover setup. In that case, there is a problem in the inbounds' configuration, most likely in the cache manager or port configuration.
82 82