Skip to Content
Last modified by Waria on 2026/07/23 09:38
From version 20.2
edited by Waria
on 2026/07/23 09:32
Change comment: Renamed back-links.
To version 1.1
edited by Erik Bakker
on 2022/06/13 08:04
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Key differences Design & Deploy Architecture
1 +Architectural Runtime Descisions
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.waria
1 +XWiki.ebakker
Content
... ... @@ -1,78 +1,58 @@
1 -{{container}}
2 -{{container layoutStyle="columns"}}
3 -(((
4 -In this microlearning, we’ll explore the differences between the Design Architecture and Deploy Architecture within eMagiz. While the Design Architecture is where integration models are initially structured and systems are assigned to either Cloud or on-premises machines, the Deploy Architecture is where these designs are brought to life. However, not all systems in the Design phase will appear in the Deploy phase due to their specific roles or configurations. Understanding these key differences will help you better manage and implement your integration architecture effectively.
1 +{{container}}{{container layoutStyle="columns"}}(((
2 +This microlearning will focus on some considerations for putting the eMagiz runtime at the right location in the architecture.
5 5  
6 -Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
4 +Should you have any questions, please contact academy@emagiz.com.
7 7  
8 -== 1. Prerequisites ==
6 +* Last update: October 20th, 2021
7 +* Required reading time: 10 minutes
9 9  
9 +== 1. Prerequisites ==
10 10  * Intermediate knowledge of the eMagiz platform
11 -* Good working experience in the Design & Deploy architecture aspects
11 +* Good working experience in the Design and Deploy Architecture phase.
12 12  
13 13  == 2. Key concepts ==
14 +In the various microlearnings until the intermediate level, we have explained the eMagiz runtime (https://emagiz.github.io/docs/microlearning/crashcourse*platform*deploy*install*local*connector). In short, it is the process that can make the flow components operational and execute the designated tasks of that flow. Please refer to these microlearnings for further information
14 14  
15 -The Design Architecture is the place where the architecture of the integration model is forged. It allows to place Systems to Cloud or On-premises connector machines so that hybrid cloud architectures are possible. The Deploy Architecture is the place where the Design architecture is effectuated. In case a system is added to a Cloud Connector machine for instance, the Deploy architecture will allows to actually deploy that runtime.
16 16  
17 -== 3. Key differences in views Deploy & Design ==
18 18  
19 -The System is the key notion for a eMagiz runtime to get created. The eMagiz runtime is a Java based application container in which flows can be made active or operational. In most cases, all Systems in Design are to be located on a machine to effectuate these runtimes on the machines.
18 +== 3. Specific eMagiz runtime considerations ==
20 20  
21 -However, in some cases the Deploy architecture looks different compared to the Design architecture. In a sense that some system don't get "created" in Deploy. These are the reasons for Systems not to appear in Deploy architecture:
20 +=== 3.1 Messaging pattern runtimes ===
22 22  
23 -* System is only used for API Gateway Access
24 -The system acts as a role and user, and no other integrations are used to and from that system. You can recognize the blue lines with blue rounded boxes containing the number of operations. These systems will be displayed in Design yet not in Deploy architecture. No runtime application is needed as no flows are supposed to run inside these systems. Multi-tenant systems that act as role (with tenants being the users) are also not displayed as system in Deploy Architecture. Below an example of such a case:
22 +For Messaging specific patterns the runtime should be placed in such a way that there is connectivity between that runtime and the sending/receiving system. The system might be located in a Cloud service or Cloud VPC that eMagiz clients are hosting. Or are located on*premises of the client. Here are the options and advice for putting the runtime.
25 25  
26 -[[image:Main.Images.Microlearning.WebHome@advanced-solution-architecture-diffs-design-deploy-1.png]]
24 +1. Sender or Receiver system is located in a public or private Cloud
25 + * Put the Runtime on a Cloud Connector machine and ensure to use the connectivity options provided in eMagiz
26 +
27 +2. Sender or Receiver system is located in a DMZ section of the client infrastructure
28 + * Put the runtime inside the same DMZ zone to keep the runtime as close to the system as possible
29 + * Ensure the management of the runtime is something workable for the client. Consider the updates that may occur as well as the fact that the runtime can no longer be managed by the eMagiz Portal
30 +
31 +=== 3.2 API Gateway pattern runtimes ===
27 27  
28 -* System that is used only for Event Streaming integrations
29 -The same applies to systems that are displayed for registering Producers and Consumers for Event Streaming. These systems are not displayed in Deploy Architecture.
33 +For these runtime the first choice is put all the Gateway Entry Flow and the Exit gates on the Cloud Connector machine. This way, the number of runtimes are kept to a minimum and there is full control over these runtime. In the exceptional case where the exit gate needs to connect to a system that is not accessible via the client firewalls, you can opt to put these exit gates only on a runtime that can be deployed on*premises. Please refer to the [microlearning around running part of the solution locally](advanced*api*management*running*part*of*your*api*gateway*solution*on*premise)
30 30  
31 -[[image:Main.Images.Microlearning.WebHome@advanced-solution-architecture-diffs-design-deploy-2.png]]
35 +=== 3.3 Event Streaming pattern runtimes ===
36 +In the case where Event processors are used in the Event Streaming solution designed, eMagiz provides a event streaming container (runtime). This runtime can only run in a Cloud-based machine, and only in the core machines of eMagiz. The key reason is that these Event Processors need to connect to the topics that are only available in the eMagiz Cloud and not accessible from outside the eMagiz VPC. Any runtime that is consuming or producing data with these topics needs to have the capability to access such topics.
32 32  
33 -* Systems accessed via Exit Gates only
34 -Applications that accessed via API Gateway operations only are also no displayed in the Deploy Architecture. Exit gates are accessing these applications (displayed as systems) yet the exit gate will run on the gateway container runtime. Therefore, these system don't require any flow to deploy on so no runtimes gets created.
35 35  
36 -[[image:Main.Images.Microlearning.WebHome@advanced-solution-architecture-diffs-design-deploy-3.png]]
37 37  
38 -There is an exception for that. In case the exit gate is required to run on the on-premises infrastructure of the client for security reasons, the runtime does get created and will be displayed therefore in the Deploy architecture. Apply to environment will not result in the physical deployment of the runtime, but's displayed so that the Deployment plan can indicate progress on deployment. The option Split Gateway needs to be checked in the Design phase
39 39  
40 -[[image:Main.Images.Microlearning.WebHome@advanced-solution-architecture-diffs-design-deploy-4.png]]
41 +== 4. Assignment ==
41 41  
42 -* Hybrid systems
43 -In case a system will contain not only a user management like integration but also another integration (i.e. Messaging) the runtime will be displayed in Deploy architecture as usual. A flow or series of flows need to be deployed on the runtime
43 +There is no specific assignment as this is more theoretical microlearning.
44 44  
45 -* Best practice for Design Architecture
46 -In Design Architecture it is adviced to create one or more on-premises machine that is toggled excluded. Each of these machine will act as a location where runtime not used in Deploy are put. So alignment between Design and Deploy is improved.
45 +== 5. Key takeaways ==
46 +Take into account the key considerations for each case to ensure the runtime is placed on the right location.
47 47  
48 -[[image:Main.Images.Microlearning.WebHome@advanced-solution-architecture-diffs-design-deploy-4.png]]
49 49  
50 -== 4. Key takeaways ==
51 51  
52 -Design and Deploy architecture can differ in view * specific reasons exit which are described in this microlearning.
50 +== 6. Suggested Additional Readings ==
53 53  
54 -== 5. Suggested Additional Readings ==
52 +There are no suggested additional readings on this topic
55 55  
56 -*
57 -** [[Fundamentals (Menu)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
58 -*** [[eMagiz Architecture (Menu)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-architecture.WebHome||target="blank"]]
59 -* [[Crash Course (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]]
60 -** [[Crash Course API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]]
61 -*** [[Setting up Exit gate (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-setting-up-exit-gate||target="blank"]]
62 -*** [[Configure Roles and Users (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-user-management||target="blank"]]
63 -** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]]
64 -*** [[Understanding Design Architecture - Basic (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-design-understanding-design-architecture-basic||target="blank"]]
65 -* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
66 -** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Solution Architecture.WebHome||target="blank"]]
67 -* [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]
68 -** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Solution Architecture.WebHome||target="blank"]]
69 -* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
70 -** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome||target="blank"]]
71 -* [[Architecture (Search Result)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=architecture||target="blank"]]
72 -)))
54 +== 7. Silent demonstration video ==
73 73  
74 -(((
75 -{{toc/}}
76 -)))
77 -{{/container}}
78 -{{/container}}
56 +There is no demonstration video of this functionality.
57 +
58 +)))((({{toc/}}))){{/container}}{{/container}}