Skip to Content
Last modified by dfirdausy on 2024/09/27 09:18
From version 12.1
edited by Erik Bakker
on 2024/02/09 14:04
Change comment: There is no comment for this version
To version 43.1
edited by Erik Bakker
on 2024/03/29 13:39
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
Content
... ... @@ -1,10 +1,14 @@
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 +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.
5 5  
6 -Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
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).
7 7  
8 +This microlearning will focus on configuring the deployment plan to control various inbound components in a typical group and failover configuration.
9 +
10 +If you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
11 +
8 8  == 1. Prerequisites ==
9 9  
10 10  * Intermediate knowledge of the eMagiz platform
... ... @@ -11,30 +11,56 @@
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 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**.
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.
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 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.
22 +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.
19 19  
20 -[[image:Main.Images.Microlearning.WebHome@emagiz-runtime-management--intermediate-runtime-management-deploy-agent.png]]
24 +[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-deploy-possibilities-group-deployment-step.png]]
21 21  
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.
26 +{{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}}
23 23  
24 -[[image:Main.Images.Microlearning.WebHome@emagiz-runtime-management--intermediate-runtime-management-os-selection.png]]
28 +== 4. Failover Deployment Step ==
25 25  
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.
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 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 4.1).
27 27  
28 -[[image:Main.Images.Microlearning.WebHome@emagiz-runtime-management--intermediate-runtime-management-deploy-agent-command.png]]
32 +[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-deploy-disabled-failover.png]]
29 29  
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.
34 +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.
31 31  
32 -== 4. Key takeaways ==
36 +[[image:Main.Images.Microlearning.WebHome@grouping-and-failover--intermediate-grouping-and-failover-deploy-possibilities-failover-deployment-step.png]]
33 33  
34 -* The eMagiz Docker agent needs to be installed to allow runtime to be installed on the on-premises server
38 +=== 4.1 Failover Status Explained ===
35 35  
36 -== 5. Suggested Additional Readings ==
40 +Within a failover setup, each inbound can have one of the distinct states listed below. This section explains briefly the meaning of each state.
37 37  
42 +=== 4.1.1 Leader Status ===
43 +
44 +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.
45 +
46 +=== 4.1.2 Follower Status ===
47 +
48 +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).
49 +
50 +=== 4.1.3 Disabled Status ===
51 +
52 +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.
53 +
54 +=== 4.1.4 Leader (single node) Status ===
55 +
56 +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.
57 +
58 +== 5. Key takeaways ==
59 +
60 +* Grouping is beneficial when external systems go through maintenance or downtime.
61 +* 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
62 +* The role naming in both grouping and failover is crucial. The group name needs to match **exactly** to make it work.
63 +* You can control group and failover steps from the deployment plan.
64 +* Container inbounds can have a different failover status.
65 +
66 +== 6. Suggested Additional Readings ==
67 +
38 38  There are no suggested additional readings for this microlearning.)))
39 39  (((
40 40  {{toc/}}