Skip to Content

Changes for page API Gateway Architecture

Last modified by Erik Bakker on 2024/09/02 16:04
From version 9.1
edited by Erik Bakker
on 2022/06/13 08:23
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,11 +1,8 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -This micro-learning will focus on describing the general architecture of the API Gateway. After this microlearning, the background of the API GW architecture should be clear
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 -Should you have any questions, please contact academy@emagiz.com.
4 +Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
6 -* Last update: October 20th, 2021
7 -* Required reading time: 10 minutes
8 -
9 9  == 1. Prerequisites ==
10 10  * Intermediate knowledge of the eMagiz platform
11 11  * Good working experience in the Design phase Architecture and Deploy Architecture
... ... @@ -16,9 +16,6 @@
16 16  * Single lane -> Single runtime per types
17 17  * Double lane -> Two or more runtime per type to handle failover setups
18 18  
19 -
20 -
21 -
22 22  == 3. Architecture considerations ==
23 23  
24 24  === 3.1 Architecture components API Gateway ===
... ... @@ -28,19 +28,19 @@
28 28  [[image:Main.Images.Microlearning.WebHome@advanced-solution-architecture-apigw-architecture-1.png]]
29 29  
30 30  Key notes
31 -1. Gateway runtime
32 -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
33 -2. Location runtime
34 -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.
35 -3. Gateway only runtime
36 -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.
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
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.
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.
37 37  
38 38  === 3.2 Single lane Cloud setup ===
39 39  
40 40  Single lane setup in eMagiz means that all runtimes are provided once in the architecture diagram * there is no failover or clustered approach for the runtimes. For the API Gateway, this means that you have the following machines available. In this example, you have the messaging patterns components as well with the objective to see such cases as well.
41 41  
42 -* Core 01 --> holds the JMS Server and the messaging process container
43 -* Connnector 01 --> holds the API Gateway container and the messaging runtimes
36 +* Core 01 -> holds the JMS Server and the messaging process container
37 +* Connnector 01 -> holds the API Gateway container and the messaging runtimes
44 44  
45 45  [[image:Main.Images.Microlearning.WebHome@advanced-solution-architecture-apigw-architecture-2.png]]
46 46  
... ... @@ -48,10 +48,10 @@
48 48  
49 49  Double lane setup in eMagiz means that all runtimes are provided at least twice in the architecture diagram * there is a failover for the JMS runtimes and gateway containers. For the API Gateway, this means that you have the following machines available. In this case you need to make sure that the flows are duplicated properly across the containers in Deploy * Containers. By default eMagiz will spread all flows over both gateway containers.
50 50  
51 -* Core 01 --> holds the JMS Server and the 1st messaging process container
52 -* Core 02 --> holds the backup JMS Server and the 2nd messaging process container
53 -* Connnector 01 --> holds the 1st API Gateway container
54 -* Connnector 02 --> holds the 2nd API Gateway container
45 +* Core 01 -> holds the JMS Server and the 1st messaging process container
46 +* Core 02 -> holds the backup JMS Server and the 2nd messaging process container
47 +* Connnector 01 -> holds the 1st API Gateway container
48 +* Connnector 02 -> holds the 2nd API Gateway container
55 55  
56 56  The choice to create a double lane API gateway is to be done where there is a requirement for very high performance around response times and throughput. Please contact eMagiz to discuss such options.
57 57  
... ... @@ -59,29 +59,24 @@
59 59  
60 60  === 3.4 Hybrid Cloud setup ===
61 61  
62 -In the [microlearning](advanced-api-management-running-part-of-your-api-gateway-solution-on-premise.md) 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:
63 63  
64 64  [[image:Main.Images.Microlearning.WebHome@advanced-solution-architecture-apigw-architecture-4.png]]
65 65  
66 66  === 3.5 Memory ===
67 67  
68 -For now the memory requirements for API Gateway are the same as for Messaging flows. Please refer to the [microlearning](expert-solution-architecture-determining-needed-memory.md).
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"]].
69 69  
70 -
71 -
72 -
73 73  == 4. Assignment ==
74 74  
75 -There is no specific assignment for now. The correct use of the Design architecture is explained in this [microlearning](crashcourse-platform-design-understanding-design-architecture-basic.md).
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"]].
76 76  
77 77  == 5. Key takeaways ==
78 78  
79 -1. API Gateways can be part of a mixed landscape of Messaging, Event Streaming and API Gateways
80 -2. A single lane setup is usually sufficient for most cases
81 -3. Hybrid setups are possbible but please be sure the ask the right questions before implementing such
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
82 82  
83 -
84 -
85 85  == 6. Suggested Additional Readings ==
86 86  
87 87  There are no suggested additional readings on this topic