Changes for page Failover - Deploy Possibilities

Summary

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

Details

Page properties

Content

...	...	@@ -18,58 +18,50 @@
18	18
19	19	== 3.1 Deploy Architecture ==
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. Note that what you see below is a typical situation where you already have two external machines deployed. Please refer to these microlearnings if you want to know more about deploying on-premise machine(s) and apply to environment.
	21	+After finishing up your configuration in the Design phase, you can then go to the Settings page on the top right corner of the Create phase. In this page, under the "Failover systems" tab in the "Transfer settings from design" section, you will find the system connector(s) that you can transfer the failover settings from Design. Please check the screenshot below as an example.
22	22
23		-[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-deploy-phase-router-containers.png]]
	23	+[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-create-phase-create-settings.png]]
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.
	25	+By pressing the "Transfer failover" button, eMagiz will regenerate the connector infra flow of that system as well as update the exit and entry flows connected to that system with the required settings. We will discuss these required settings and what components are affected in the following section.
26	26
27		-[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-deploy-phase-failover-preference.png]]
	27	+== 3.2 Flow Configurations ==
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.
	29	+As mentioned just now, by pressing that button in Create>Settings, eMagiz will configure the correct settings for you, so then you do not have to configure them manually by yourself. With that being said, this section focuses on showing you the components that are affected and keep you informed of the required components for the failover functionality to work correctly.
30	30
31		-== 3.2 Deployment Plan ==
	31	+The first setting that eMagiz configures for you takes place in the connector infra flow of the system that you enable for failover from the previous step. The configuration in this infra flow requires of at least three separate support objects. Two support objects will be added here, which are the Infinispan Cache Manager and Clustered Lock Registry. From the screenshot below, you can see that eMagiz, by default, will give the "Cluster name" in the Infinispan Cache Manager as {{code}}failover-<system technical name>{{/code}}. The other one that is also added is the Leader Initiator support object, which is required per unique group that you will have within the context of your runtime. eMagiz also automatically provides the "Role" name in this support object. It will be filled in with the same value as the "Cluster name" later when you have moved to the Deploy phase (e.g., {{code}}failover-xctnln{{/code}} in the example below).
32	32
33		-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.
	33	+[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-create-phase-connector-infra.png]]
34	34
35		-[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-deploy-phase-balance-failover.png]]
	35	+The second setting that eMagiz configures for you happens in the exit and entry flows that are connected to that system. Here, eMagiz configures for you (parts of) your flow(s) with the required setting to enable grouping for the failover functionality on the flow level. The configurations for grouping consist of the "Group" name and "Auto startup", which are available for all inbound components. See the screenshot below as an example of an inbound component that has its "Group" name and "Auto startup" configured by eMagiz automatically when enabling the failover functionality.
36	36
37		-To make sure that this functionality works correctly, then this step should be placed at the end of your deployment plan (i.e., after the deployment of all runtimes). This is to ensure that all of the failover connector runtimes are running and reachable before electing the preferred runtime to be the leader and turning off the follower runtime. See the screenshot below as an example.
	37	+{{info}}The grouping functionality here is relevant when faced with maintenance and outages of systems connected to your model.{{/info}}
38	38
39		-[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-deploy-phase-deployment-plan.png]]
	39	+[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-create-phase-exit-entry.png]]
40	40
41		-== 3.3 Deploy Release ==
	41	+Again, in this part, you do not have to make any changes yourself. Once you are satisfied with the settings that eMagiz has configured for you, then you are finished in the Create phase and can move on to the Deploy phase that will be discussed in the next microlearning.
42	42
43		-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).
44		-
45		-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.
46		-
47		-[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-deploy-phase-failover-properties.png]]
48		-
49		-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.
50		-
51		-== 3.3 Trigger Failover ==
52		-
53		-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.
54		-
55		-[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-setting-up-failover-deploy-phase-start-stop.png]]
56		-
57		-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.
58		-
59	59	== 4. Key takeaways ==
60	60
61		-* By enabling multiple runtimes across different machines, you can configure groups to operate in active/passive failover mode, ensuring continued operation during connection failures, system maintenances, or outages.
62		-* 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.
63		-* 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.
64		-* 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.
	45	+* Grouping is beneficial when external systems go through maintenance or downtime.
	46	+* 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.
	47	+* The role naming in both grouping and failover is crucial. The whole name needs to be matched fully to make it work.
	48	+* For the infra configuration of the failover setup, we have a store item that you can use.
65	65
66	66	== 5. Suggested Additional Readings ==
67	67
68	68	If you are interested in this topic and want more information, please read the help text provided by eMagiz and check out these links:
69	69
70		-* [[Intermediate Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
71		-** [[eMagiz Runtime Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome||target="blank"]]
72		-*** [[Start/Stop Flows (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-start-stop-flows.WebHome||target="blank"]]
	54	+* [[eMagiz Store (Menu)>>doc:Main.eMagiz Store.WebHome||target="blank"]]
	55	+** [[Accelerators (Navigation)>>doc:Main.eMagiz Store.Accelerators.WebHome||target="blank"]]
	56	+*** [[Active/Passive Failover (Explanation)>>doc:Main.eMagiz Store.Accelerators.Active-Passive Failover.WebHome||target="blank"]]
	57	+* [[Crash Courses (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]]
	58	+** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]]
	59	+*** [[Support objects - Introduction (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-support-objects-introduction||target="blank"]]
	60	+*** [[Promote flows to deploy (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-promote-flows-to-deploy||target="blank"]]
	61	+* [[Intermediate Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Grouping and Failover.WebHome||target="blank"]]
	62	+** [[Grouping and Failover (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Grouping and Failover.WebHome||target="blank"]]
	63	+*** [[Deploy Possibilities (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Grouping and Failover.intermediate-grouping-and-failover-deploy-possibilities.WebHome||target="blank"]]
	64	+** [[eMagiz Cloud Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Cloud Management.WebHome||target="blank"]]
73	73	* [[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"]]
74	74	)))
75	75	(((