Changes for page Grouping - Deploy Possibilities

Summary

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

Details

Page properties

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.dfirdausy
	1	+XWiki.BoukeReitsma

Content

...	...	@@ -1,13 +1,13 @@
1	1	{{container}}
2	2	{{container layoutStyle="columns"}}
3	3	(((
4		-eMagiz flows, or more specifically, the flow's inbound component(s), can be grouped. Configuring this is explained [[here>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Grouping and Failover.intermediate-grouping-and-failover-flow-configuration.WebHome||target="blank"]]. This functionality is mainly beneficial when faced with substantial maintenance or outage of systems connected to your eMagiz model.
	4	+eMagiz flows, or more specifically, the flow's inbound component(s), can be grouped. How to configure this is explained [[here>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Grouping and Failover.intermediate-grouping-and-failover-flow-configuration.WebHome||target="blank"]]. This functionality is mainly beneficial when faced with substantial maintenance or outage of systems connected to your eMagiz model.
5	5
6		-Building on this functionality, you can even configure the group to run in an active/passive failover mode when you activate the multiple runtimes option on your runtime, and each separate runtime is deployed on another machine. The failover functionality is relevant not only in cases of server maintenance but also in that it can assist you when you want to exchange data with a system that allows only one active connection. Should this connection be business-critical, you can use this failover functionality to create a passive failover situation that will take over when the active connection breaks down (regardless of the reason).
	6	+Building on this functionality, you can even configure the group to run in an active/passive failover mode when you activate the multiple runtimes option on your runtime, and each separate runtime is deployed on another machine. The failover functionality is not only relevant in cases of server maintenance. It can also assist you when you want to exchange data with a system that allows only one active connection. Should this connection be business-critical, you can use this failover functionality to create a passive failover situation that will take over when the active connection breaks down (regardless of the reason).
7	7
8		-This microlearning will focus on configuring the deployment plan to control various inbound components in a typical group and failover configuration.
	8	+In this microlearning, we will focus on configuring the deployment plan to control various inbound compoments in a normal and in a failover configuration.
9	9
10		-If you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
	10	+Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
11	11
12	12	== 1. Prerequisites ==
13	13
...	...	@@ -15,63 +15,74 @@
15	15
16	16	== 2. Key concepts ==
17	17
18		-This microlearning describes how to configure (parts of) your deployment plan to set up the grouping and, if needed, the failover functionality. The grouping functionality is relevant when faced with maintenance and outages of systems connected to your model. The failover functionality assists and allows you to have a fallback option on an active connection.
	18	+This microlearning describes how to configure (parts of) your deployment plan to set up the grouping and, if needed, the failover functionality. The grouping 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.
19	19
20		-== 3. Deploy Possibilities ==
21		-=== 3.1. Group Deployment Step ===
	20	+== 3. Group Deployment Step ==
22	22
23		-To configure a Group deployment step, add a new one and choose Step type "Group". More information is required to configure the step. A container should be selected for which the inbounds will be stopped. The second requirement is the **exact** name of the group that should be affected by the deployment step. An action should be picked for the selected group. The options for a "Group" deployment step are to start or stop the inbound components within the group. Optionally, a description can be added.
	22	+To configure a Group deployment step, you need to add a new deployment step and choose Step type "Group". To configure the step more information is required. A container should be chosen for which the inbounds will be stopped. The second requirement is the **exact** name of the group that should be affected by the deployment step. An action should be picked for the selected group. For a "Group" deployment step the options are to start or to stop the inbound components within the groupname. Optionally, a description can be added.
24	24
25	25	[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-deploy-possibilities-group-deployment-step.png]]
26	26
27		-{{info}}Note that when you activate the stop action in a failover setup (on the leader container), it will trigger the failover behavior on the follower container{{/info}}
	26	+== 4. Failover Deployment Step ==
28	28
29		-=== 3.2. Failover Deployment Step ===
	28	+If you want to expand the grouping functionality to include an active/passive failover component, you need to change the settings on the inbound component. Apart from specifying the group name, you need to configure the auto-startup option on "No" so the failover configuration can take the correct actions in all situations.
30	30
31		-The configuration for a failover deployment step is the same as for the group deployment step. The only difference is the action you can activate. The stop group action stops the inbounds of the selected container. It will also disable the failover, so if a follower is configured, it will **not** take over. Instead, from this point, we are running in a standard multi-container setup with single-node leaders (See 3.2.1).
	30	+[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-failover-example-group.png]]
32	32
33		-[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-deploy-disabled-failover.png]]
	32	+[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-failover-other-group.png]]
34	34
35		-The start group step with failover will activate the current container as the Leader of the failover setup. Therefore, group names resembling those on other containers will become the followers. If these flows were running, they would be stopped.
	34	+{{info}}Note that each group within a single runtime that you want to treat differently needs to have a **unique** name.{{/info}}
36	36
37		-[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-deploy-possibilities-failover-deployment-step.png]]
	36	+== 3.3 Failover Infra ==
38	38
39		-=== 3.2.1 Failover Status Explained ===
	38	+The configuration of the infra flow of the runtime for which you want to configure the failover is detailed and only works if you configure all support objects correctly. Although we explain the various steps in the documentation, we advise utilizing the store item we created for this that will guide you in setting this up correctly.
40	40
41		-Within a failover setup, each inbound can have one of the distinct states listed below. This section explains briefly the meaning of each state.
	40	+The configuration consists of at least three separate support objects. Two are needed once (infinispan cache manager and clustered lock registry), whereas the other is required per unique group you have defined within the context of your runtime. So, if you have two unique group names within the runtime, you need two leader initiator support objects.
42	42
43		-==== 3.2.1.1 Leader Status ====
	42	+=== 3.3.1 Infinispan Cache Manager ===
44	44
45		-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.
	44	+Given this, let us first look at the Infinispan cache manager. You can add this support object in the [[standard manner>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-support-objects-introduction||target="blank"]] by searching for "infinispan cache manager."
46	46
47		-==== 3.2.1.2 Follower Status ====
	46	+[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-cache-manager-search-result.png]]
48	48
49		-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).
	48	+Once found, give it a name and fill in a cluster name.
50	50
51		-==== 3.2.1.3 Disabled Status ====
	50	+[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-cache-manager-basic.png]]
52	52
53		-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.
	52	+Once done, switch to the "Advanced" tab, select the option "TCP Ping," and fill in the "Host address" and "Other host addresses". Once filled in, press Save to keep your changes.
54	54
55		-==== 3.2.1.4 Leader (single node) Status ====
	54	+[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-cache-manager-advanced.png]]
56	56
57		-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.
	56	+=== 3.3.2 Clustered Lock Registry ===
58	58
59		-== 4. Key takeaways ==
	58	+Now that we have the cache manager, we can configure the next support object on our list, the clustered lock registry. You can add this support object in the [[standard manner>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-support-objects-introduction||target="blank"]] by searching for "lock registry."
60	60
	60	+[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-lock-registry-search-result.png]]
	61	+
	62	+Once found, name it and select the cache manager support object you created.
	63	+
	64	+[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-lock-registry-basic.png]]
	65	+
	66	+=== 3.3.3 Leader Initiator ===
	67	+
	68	+Lastly, we need to configure a leader initiator for each **unique** group we have defined within the context of the runtime, and that uses the failover functionality. You can add this support object in the [[standard manner>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-support-objects-introduction||target="blank"]] by searching for "leader."
	69	+
	70	+[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-leader-initiator-search-result.png]]
	71	+
	72	+Once found, give it a name, define the role name (which should **exactly** match the name you gave in the inbound components), and link it to the lock registry.
	73	+
	74	+[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-flow-configuration-leader-initiator-basic.png]]
	75	+
	76	+== 5. Key takeaways ==
	77	+
61	61	* Grouping is beneficial when external systems go through maintenance or downtime.
62	62	* 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
63		-* The role naming in both grouping and failover is crucial. The group name needs to match **exactly** to make it work.
64		-* You can control group and failover steps from the deployment plan.
65		-* Container inbounds can have a different failover status.
	80	+* The role naming in both grouping and failover is crucial. The whole name needs to be matched fully to make it work.
	81	+* For the infra configuration of the failover setup, we have a store item that you can use.
66	66
67		-== 5. Suggested Additional Readings ==
	83	+== 6. Suggested Additional Readings ==
68	68
69		-If you are interested in this topic and want more information, please read the help text provided by eMagiz and check out these links:
70		-
71		-* [[Crash Courses (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]]
72		-** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]]
73		-*** [[Deploy a release (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-deploy-execute-deployment-plan-gen3.WebHome||target="blank"]]
74		-*** [[Setting up a deployment plan (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-deploy-setup-deployment-plan-gen3||target="blank"]])))
	85	+There are no suggested additional readings for this microlearning.)))
75	75	(((
76	76	{{toc/}}
77	77	)))