Skip to Content

Changes for page API Gateway Architecture

Last modified by Erik Bakker on 2024/09/02 16:04
From version 23.1
edited by Erik Bakker
on 2024/09/02 16:04
Change comment: There is no comment for this version
To version 14.1
edited by Erik Bakker
on 2023/01/23 10:55
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,5 +1,5 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -In this microlearning, we’ll explore key architectural considerations for setting up API Gateways within eMagiz. We'll cover the basic concepts of single-lane and double-lane setups, which refer to the number of runtimes used and their role in ensuring system reliability. Additionally, we'll look at different architecture configurations, including how to position runtimes in the Cloud and on-premises environments, and the memory requirements for these setups. Understanding these aspects will help you design a robust and efficient API Gateway architecture.
2 +This microlearning will focus on describing the general architecture of the API Gateway. After this microlearning, the background of the API GW architecture should be clear
3 3  
4 4  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
... ... @@ -23,11 +23,11 @@
23 23  
24 24  Key notes
25 25  * Gateway runtime
26 -** The Gateway has a separate runtime where the associated gateway flows are deployed in. The exit gates and all entry flow are the typical flow types present in this runtime, next to the usual infrastructure flow
26 +**The Gateway has a separate runtime where the associated gateway flows are deployed in. The exit gates and all entry flow are the typical flow types present in this runtime, next to the usual infrastructure flow
27 27  * Location runtime
28 -** The Gateway runtime is located in a Cloud machine, and is specifically put on the Connector machine. The Connector machine has the ability to allow incoming data (secured) traffic from outside the Virtual Private Cloud that each client has. The Core machine does not have this option due to security reasons. The eMagiz Cloud handles the proper and secure routing to the API gateway.
28 +**The Gateway runtime is located in a Cloud machine, and is specifically put on the Connector machine. The Connector machine has the ability to allow incoming data (secured) traffic from outside the Virtual Private Cloud that each client has. The Core machine does not have this option due to security reasons. The eMagiz Cloud handles the proper and secure routing to the API gateway.
29 29  * Gateway only runtime
30 -** These are system that act as application user of 1 or more operations made available in the API Gateway. In case the system is only connected in the Design phase as such an application user, than that system only acts as input for User Management. The system doesn't need to be deployed as a runtime on the Connector machine, and should therefore be placed on an excluded machine. In the picture above, Exact online is such a system.
30 +**These are system that act as application user of 1 or more operations made available in the API Gateway. In case the system is only connected in the Design phase as such an application user, than that system only acts as input for User Management. The system doesn't need to be deployed as a runtime on the Connector machine, and should therefore be placed on an excluded machine. In the picture above, Exact online is such a system.
31 31  
32 32  === 3.2 Single lane Cloud setup ===
33 33  
... ... @@ -53,30 +53,30 @@
53 53  
54 54  === 3.4 Hybrid Cloud setup ===
55 55  
56 -In the [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.API Management.advanced-api-management-running-part-of-your-api-gateway-solution-on-premise||target="blank"]] you can find the reasons and configuration for running the exit gates in on-premises runtimes. A view of such a architecture is displayed here:
56 +In the [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.API Management.advanced-api-management-running-part-of-your-api-gateway-solution-on-premise.WebHome||target="blank"]] you can find the reasons and configuration for running the exit gates in on-premises runtimes. A view of such a architecture is displayed here:
57 57  
58 58  [[image:Main.Images.Microlearning.WebHome@advanced-solution-architecture-apigw-architecture-4.png]]
59 59  
60 60  === 3.5 Memory ===
61 61  
62 -For now the memory requirements for API Gateway are the same as for Messaging flows. Please refer to the [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-determining-needed-memory||target="blank"]].
62 +For now the memory requirements for API Gateway are the same as for Messaging flows. Please refer to the [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-determining-needed-memory.WebHome||target="blank"]].
63 63  
64 -== 4. Key takeaways ==
64 +== 4. Assignment ==
65 65  
66 -* API Gateways can be part of a hybrid landscape that combines the available integration patterns.
67 -* A single lane setup is usually sufficient for most cases.
68 -* Hybrid setups are possbible but please be sure the ask the right questions before implementing such.
66 +There is no specific assignment for now. The correct use of the Design architecture is explained in this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-design-understanding-design-architecture-basic.WebHome||target="blank"]].
69 69  
70 -== 5. Suggested Additional Readings ==
68 +== 5. Key takeaways ==
71 71  
72 -If you are interested in this topic and want more information on it please read the help text provided by eMagiz and read the following links:
73 -* [[Crash Course (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]]
74 -** [[Crash Course API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]]
75 -*** [[API Gateway - Introduction (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-introduction||target="blank"]]
76 -*** [[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"]]
77 -* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
78 -** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome||target="blank"]]
79 -*** [[How to Determine Needed Memory (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-determining-needed-memory||target="blank"]]
80 -* [[API Gateway (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=api+gateway||target="blank"]]
70 +* API Gateways can be part of a mixed landscape of Messaging, Event Streaming and API Gateways
71 +* A single lane setup is usually sufficient for most cases
72 +* Hybrid setups are possbible but please be sure the ask the right questions before implementing such
81 81  
74 +== 6. Suggested Additional Readings ==
75 +
76 +There are no suggested additional readings on this topic
77 +
78 +== 7. Silent demonstration video ==
79 +
80 +There is no demonstration video of this functionality.
81 +
82 82  )))((({{toc/}}))){{/container}}{{/container}}