Skip to Content
Last modified by dfirdausy on 2024/09/27 09:18
From version 11.1
edited by Erik Bakker
on 2024/02/08 16:39
Change comment: There is no comment for this version
To version 37.1
edited by BoukeReitsma
on 2024/03/22 13:48
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -eMagiz Deploy agent
1 +Deploy Possibilities
Parent
... ... @@ -1,1 +1,1 @@
1 -Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome
1 +Main.eMagiz Academy.Microlearnings.Intermediate Level.Grouping and Failover.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ebakker
1 +XWiki.BoukeReitsma
Content
... ... @@ -1,8 +1,12 @@
1 1  {{container}}
2 2  {{container layoutStyle="columns"}}
3 3  (((
4 -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.
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 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 +
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 +
6 6  Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
7 7  
8 8  == 1. Prerequisites ==
... ... @@ -11,27 +11,36 @@
11 11  
12 12  == 2. Key concepts ==
13 13  
14 -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-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.
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.
15 15  
16 -== 3. eMagiz Deploy agent installation ==
20 +== 3. Group Deployment Step ==
17 17  
18 -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.
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.
19 19  
20 -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.
24 +[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-deploy-possibilities-group-deployment-step.png]]
21 21  
22 -[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
26 +{{info}}Note that when you activate the stop action in a failover setup (on the leader container), it will activate the failover behaviour on the follower container{{/info}}
23 23  
24 -== 4. Key takeaways ==
28 +== 4. Failover Deployment Step ==
25 25  
26 -* The eMagiz Docker agent needs to be installed to allow runtime to be installed on the on-premises server
30 +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 makes the inbounds of the selected container stop. On top of that it will disable the failover, so if there is a follower configured it will **not** take over. Instead, from this point were are running in a dubble setup in which we have single node leaders.
27 27  
28 -== 5. Suggested Additional Readings ==
32 +[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-deploy-disabled-failover.png]]
29 29  
30 -No suggested additional readings for this microlearning.
34 +The start group step with failover will activate the current container as the leader of the failover setup. Therefore, resembling group names on other containers will become the followers. If these flows were running, they will be stopped.
31 31  
36 +[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-deploy-possibilities-failover-deployment-step.png]]
32 32  
33 -)))
38 +== 5. Key takeaways ==
34 34  
40 +* Grouping is beneficial when external systems go through maintenance or downtime.
41 +* 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
42 +* The role naming in both grouping and failover is crucial. The group name needs to match **exactly** to make it work.
43 +* You can control group and failover steps from the deployment plan
44 +
45 +== 6. Suggested Additional Readings ==
46 +
47 +There are no suggested additional readings for this microlearning.)))
35 35  (((
36 36  {{toc/}}
37 37  )))