Wiki source code of Key differences Design & Deploy Architecture
Last modified by Erik Bakker on 2024/09/02 16:06
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
1.1 | 1 | {{container}}{{container layoutStyle="columns"}}((( |
| |
19.1 | 2 | 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.1 | 3 | |
| |
12.1 | 4 | Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]]. |
| |
1.1 | 5 | |
| 6 | == 1. Prerequisites == | ||
| |
8.1 | 7 | * Intermediate knowledge of the eMagiz platform |
| |
11.1 | 8 | * Good working experience in the Design & Deploy architecture aspects |
| |
1.1 | 9 | |
| 10 | == 2. Key concepts == | ||
| |
11.1 | 11 | 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. |
| |
1.1 | 12 | |
| |
11.1 | 13 | == 3. Key differences in views Deploy & Design == |
| |
1.1 | 14 | |
| |
11.1 | 15 | 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. |
| |
9.1 | 16 | |
| |
11.1 | 17 | 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: |
| |
1.1 | 18 | |
| |
11.1 | 19 | * System is only used for API Gateway Access |
| 20 | 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: | ||
| |
1.1 | 21 | |
| |
11.1 | 22 | [[image:Main.Images.Microlearning.WebHome@advanced-solution-architecture-diffs-design-deploy-1.png]] |
| |
1.1 | 23 | |
| |
11.1 | 24 | * System that is used only for Event Streaming integrations |
| 25 | The same applies to systems that are displayed for registering Producers and Consumers for Event Streaming. These systems are not displayed in Deploy Architecture. | ||
| |
1.1 | 26 | |
| |
11.1 | 27 | [[image:Main.Images.Microlearning.WebHome@advanced-solution-architecture-diffs-design-deploy-2.png]] |
| |
1.1 | 28 | |
| |
11.1 | 29 | * Systems accessed via Exit Gates only |
| 30 | 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. | ||
| |
1.1 | 31 | |
| |
11.1 | 32 | [[image:Main.Images.Microlearning.WebHome@advanced-solution-architecture-diffs-design-deploy-3.png]] |
| |
1.1 | 33 | |
| |
11.1 | 34 | 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 |
| |
1.1 | 35 | |
| |
11.1 | 36 | [[image:Main.Images.Microlearning.WebHome@advanced-solution-architecture-diffs-design-deploy-4.png]] |
| |
2.1 | 37 | |
| |
11.1 | 38 | * Hybrid systems |
| 39 | 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 | ||
| |
2.1 | 40 | |
| |
11.1 | 41 | * Best practice for Design Architecture |
| 42 | 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. | ||
| |
2.1 | 43 | |
| |
11.1 | 44 | [[image:Main.Images.Microlearning.WebHome@advanced-solution-architecture-diffs-design-deploy-4.png]] |
| |
2.1 | 45 | |
| |
13.1 | 46 | == 4. Key takeaways == |
| |
11.1 | 47 | Design and Deploy architecture can differ in view * specific reasons exit which are described in this microlearning. |
| |
1.1 | 48 | |
| |
13.1 | 49 | == 5. Suggested Additional Readings == |
| |
18.1 | 50 | ** [[Fundamentals (Menu)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]] |
| 51 | *** [[eMagiz Architecture (Menu)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-architecture.WebHome||target="blank"]] | ||
| |
14.1 | 52 | * [[Crash Course (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]] |
| 53 | ** [[Crash Course API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]] | ||
| |
15.1 | 54 | *** [[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"]] |
| 55 | *** [[Configure Roles and Users (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-configure-roles-and-users||target="blank"]] | ||
| |
17.1 | 56 | ** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]] |
| 57 | *** [[Understanding Design Architecture - Basic (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-design-understanding-design-architecture-basic||target="blank"]] | ||
| |
18.1 | 58 | * [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]] |
| 59 | ** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Solution Architecture.WebHome||target="blank"]] | ||
| 60 | * [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]] | ||
| 61 | ** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Solution Architecture.WebHome||target="blank"]] | ||
| 62 | * [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]] | ||
| 63 | ** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome||target="blank"]] | ||
| |
20.1 | 64 | * [[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"]] |
| |
18.1 | 65 | |
| |
15.1 | 66 | )))((({{toc/}}))){{/container}}{{/container}} |