Understanding Deploy Architecture - Basic

(((

In this microlearning, we'll explore the concept of "Design Architecture" and how it can assist you in managing your integration landscape. "Design Architecture" refers to the overview of where your instances are deployed, which machines they're running on, and the resources required for deployment. By understanding this overview, you'll gain insights into where your instances are located (cloud or on-premise), the machine sizes needed, and whether you have the capacity to develop more integration solutions within your current setup.

5

6

Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].

7

8

== 1. Prerequisites ==

9

10

* Basic knowledge of the eMagiz platform

11

12

== 2. Key concepts ==

13

14

This microlearning centers around understanding what the Deploy Architecture overview is and how it can help you.

15

16

With Deploy Architecture we mean: The **realized** overview of where the instances are deployed, on which machines, and how many resources it takes to deploy these instances.

17

18

The Deploy Architecture gives you insights into:

19

20

* Where do my instances run (cloud, on-premise).

21

* What is the machine size needed to run my current model.

22

* Which routes, certificates, failover, and volume settings are used in **each** environment.

23

24

== 3. Understanding Deploy Architecture ==

25

26

The Deploy Architecture overview is accessible under Deploy. In Deploy, you can click on Architecture to get to the overview. The following Deploy Architecture could look similar to what you would see **before** the first "Apply to environment" action is executed.

27

28

[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-understanding-deploy-architecture-basic--initial-overview.png]]

29

30

The following Deploy Architecture could look similar to what you would see **after** the first "Apply to environment" action is executed.

31

32

[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-understanding-deploy-architecture-basic--standard-overview.png]]

33

34

As you can see in the overview of the architecture we have several machines within our integration landscape (i.e. Core01, Connector01, External 01, etc.) and each machine has several systems (i.e. runtimes) running on it.

35

36

=== 3.1 Core Machine ===

37

38

The machine called Core01 in this example is a so-called core machine. This machine (or machines if you scale up) plays host to the core functionalities of eMagiz:

39

40

* JMS

41

* Process Container (holds all onramps, offramps, routers, and the error process for messaging processes)

42

* Event Streaming Container (holds all onramps and offramps for event stream processes)

43

44

=== 3.2 Connector Machine(s) ===

45

46

The machines called "Connector 01", "APP-DEV04592", and "APP-DEV04593" in this example are so-called connector machines.

47

These machines are the place where you exchange data with other systems. As this is the place to connect to other systems internet connectivity is a must.

48

49

Within eMagiz we make a distinction between two types of connector machine(s):

50

51

* Connector machine(s) running in the eMagiz Cloud managed by eMagiz

52

* Connector machine(s) running on-premise in the data center of the client

53

54

On these connector machines you can configure things like:

55

56

* [[Runtime Settings>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-runtime-settings.WebHome||target="blank"]]

57

* [[Volume Mapping>>doc:Main.eMagiz Academy.Microlearnings.Novice.File based connectivity.novice-file-based-connectivity-volume-mapping-on-premise||target="blank"]]

58

* [[Memory>>||anchor="H3.3Usedandavailablesize"]].

59

60

On top of that you can execute a lot of actions on the runtimes, such as:

61

* [[Start/Stop Flows>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-start-stop-flows.WebHome||target="blank"]]

62

* [[Restart Runtime>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-restart-runtime.WebHome||target="blank"]]

63

* [[Reset Runtime>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-reset-runtime.WebHome||target="blank"]]

64

* [[Reset H2>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-reset-h2.WebHome||target="blank"]]

65

66

=== 3.3 Used and available size ===

67

68

Apart from determining where an instance (runtime) should be running (cloud or on-premise) the Deploy Architecture also tells you how much memory (i.e. size) is already claimed by the runtimes running on the machine (including machine memory) and how much is still available to be distributed or to be assigned to a new runtime.

69

70

When you open the context menu on machine level you will see the option "Details" when you are **not** in "Start Editing" mode and the options "Details", "Start machine", "Stop machine", "Restart machine", and "Redistribute leftover memory". For this you need the "Details" option.

71

72

[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-understanding-deploy-architecture-basic--machine-context-menu-details-option.png]]

73

74

Within this "Details" menu you will see a tab called "Runtimes". After selecting it you will see an overview similar to what is shown below. This overview shows the memory configuration per runtime (that can be edited while in "Start Editing" mode) and it will show whether your machine is still healthy from a memory perspective. This we do by showing a state and indicating in a bar how much of your total available memory can still be assigned.

75

76

[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-understanding-deploy-architecture-basic--runtime-memory-overview.png]]

77

78

{{info}}Note that we now block users from executing "Apply to environment" when the memory status of a machine is deemed "Unhealthy" according to eMagiz.{{/info}}

79

80

There is much more to tell about Deploy Architecture but more on that in later microlearnings.

81

82

== 4. Key takeaways ==

83

84

* Deploy Architecture gives you context on which runtimes are deployed where (on-premise or cloud)

85

* Machines are divided into so-called core and connector machines

86

* Per machine and runtime there are a lot of actions you can take on your environment.

87

88

== 5. Suggested Additional Readings ==

89

90

* [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]

91

** [[eMagiz Architecture (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-architecture.WebHome||target="blank"]]

92

** [[eMagiz Cloud (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-cloud-inner-workings||target="blank"]]

93

* [[Novice (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]]

94

** [[File Based Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.File based connectivity.WebHome||target="blank"]]

95

*** [[Volume Mapping (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.File based connectivity.novice-file-based-connectivity-volume-mapping-on-premise||target="blank"]]

96

** [[eMagiz Cloud Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.eMagiz Cloud Management.WebHome||target="blank"]]

97

* [[Intermediate Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]

98

** [[eMagiz Runtime Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome||target="blank"]]

99

*** [[Runtime Settings (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-runtime-settings.WebHome||target="blank"]]

100

*** [[Start/Stop Flows (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-start-stop-flows.WebHome||target="blank"]]

101

*** [[Restart Runtime (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-restart-runtime.WebHome||target="blank"]]

102

*** [[Reset Runtime (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-reset-runtime.WebHome||target="blank"]]

103

*** [[Reset H2 (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-reset-h2.WebHome||target="blank"]]

104

* [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]

105

** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Solution Architecture.WebHome||target="blank"]]

106

*** [[Architectural Runtime Decisions (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Solution Architecture.advanced-solution-architecture-runtime-decision.WebHome||target="blank"]]

107

*** [[Key differences Design & Deploy Architecture (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Solution Architecture.advanced-solution-architecture-diffs-design-deploy.WebHome||target="blank"]]

108

*** [[Consequences Of Cloud Size (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Solution Architecture.advanced-solution-architecture-consequence-size-cloud.WebHome||target="blank"]]

109

* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]

110

** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome||target="blank"]]

111

*** [[How to Determine Needed Memory (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-determining-needed-memory||target="blank"]]

112

* [[Deploy Architecture (Search Result)>>url:https://docs.emagiz.com/bin/view/Main/Search?text=%22deploy%20architecture%22&f_type=DOCUMENT&f_space_facet=0%2FMain.&f_locale=en&f_locale=&f_locale=en&r=1||target="blank"]]

)))

(((

)))

author	version	line-number	content
		1	{{container}}
		2	{{container layoutStyle="columns"}}
		3	(((
		4	In this microlearning, we'll explore the concept of "Design Architecture" and how it can assist you in managing your integration landscape. "Design Architecture" refers to the overview of where your instances are deployed, which machines they're running on, and the resources required for deployment. By understanding this overview, you'll gain insights into where your instances are located (cloud or on-premise), the machine sizes needed, and whether you have the capacity to develop more integration solutions within your current setup.
		5
		6	Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
		7
		8	== 1. Prerequisites ==
		9
		10	* Basic knowledge of the eMagiz platform
		11
		12	== 2. Key concepts ==
		13
		14	This microlearning centers around understanding what the Deploy Architecture overview is and how it can help you.
		15
		16	With Deploy Architecture we mean: The realized overview of where the instances are deployed, on which machines, and how many resources it takes to deploy these instances.
		17
		18	The Deploy Architecture gives you insights into:
		19
		20	* Where do my instances run (cloud, on-premise).
		21	* What is the machine size needed to run my current model.
		22	* Which routes, certificates, failover, and volume settings are used in each environment.
		23
		24	== 3. Understanding Deploy Architecture ==
		25
		26	The Deploy Architecture overview is accessible under Deploy. In Deploy, you can click on Architecture to get to the overview. The following Deploy Architecture could look similar to what you would see before the first "Apply to environment" action is executed.
		27
		28	[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-understanding-deploy-architecture-basic--initial-overview.png]]
		29
		30	The following Deploy Architecture could look similar to what you would see after the first "Apply to environment" action is executed.
		31
		32	[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-understanding-deploy-architecture-basic--standard-overview.png]]
		33
		34	As you can see in the overview of the architecture we have several machines within our integration landscape (i.e. Core01, Connector01, External 01, etc.) and each machine has several systems (i.e. runtimes) running on it.
		35
		36	=== 3.1 Core Machine ===
		37
		38	The machine called Core01 in this example is a so-called core machine. This machine (or machines if you scale up) plays host to the core functionalities of eMagiz:
		39
		40	* JMS
		41	* Process Container (holds all onramps, offramps, routers, and the error process for messaging processes)
		42	* Event Streaming Container (holds all onramps and offramps for event stream processes)
		43
		44	=== 3.2 Connector Machine(s) ===
		45
		46	The machines called "Connector 01", "APP-DEV04592", and "APP-DEV04593" in this example are so-called connector machines.
		47	These machines are the place where you exchange data with other systems. As this is the place to connect to other systems internet connectivity is a must.
		48
		49	Within eMagiz we make a distinction between two types of connector machine(s):
		50
		51	* Connector machine(s) running in the eMagiz Cloud managed by eMagiz
		52	* Connector machine(s) running on-premise in the data center of the client
		53
		54	On these connector machines you can configure things like:
		55
		56	* [[Runtime Settings>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-runtime-settings.WebHome\|\|target="blank"]]
		57	* [[Volume Mapping>>doc:Main.eMagiz Academy.Microlearnings.Novice.File based connectivity.novice-file-based-connectivity-volume-mapping-on-premise\|\|target="blank"]]
		58	* [[Memory>>\|\|anchor="H3.3Usedandavailablesize"]].
		59
		60	On top of that you can execute a lot of actions on the runtimes, such as:
		61	* [[Start/Stop Flows>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-start-stop-flows.WebHome\|\|target="blank"]]
		62	* [[Restart Runtime>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-restart-runtime.WebHome\|\|target="blank"]]
		63	* [[Reset Runtime>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-reset-runtime.WebHome\|\|target="blank"]]
		64	* [[Reset H2>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-reset-h2.WebHome\|\|target="blank"]]
		65
		66	=== 3.3 Used and available size ===
		67
		68	Apart from determining where an instance (runtime) should be running (cloud or on-premise) the Deploy Architecture also tells you how much memory (i.e. size) is already claimed by the runtimes running on the machine (including machine memory) and how much is still available to be distributed or to be assigned to a new runtime.
		69
		70	When you open the context menu on machine level you will see the option "Details" when you are not in "Start Editing" mode and the options "Details", "Start machine", "Stop machine", "Restart machine", and "Redistribute leftover memory". For this you need the "Details" option.
		71
		72	[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-understanding-deploy-architecture-basic--machine-context-menu-details-option.png]]
		73
		74	Within this "Details" menu you will see a tab called "Runtimes". After selecting it you will see an overview similar to what is shown below. This overview shows the memory configuration per runtime (that can be edited while in "Start Editing" mode) and it will show whether your machine is still healthy from a memory perspective. This we do by showing a state and indicating in a bar how much of your total available memory can still be assigned.
		75
		76	[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-understanding-deploy-architecture-basic--runtime-memory-overview.png]]
		77
		78	{{info}}Note that we now block users from executing "Apply to environment" when the memory status of a machine is deemed "Unhealthy" according to eMagiz.{{/info}}
		79
		80	There is much more to tell about Deploy Architecture but more on that in later microlearnings.
		81
		82	== 4. Key takeaways ==
		83
		84	* Deploy Architecture gives you context on which runtimes are deployed where (on-premise or cloud)
		85	* Machines are divided into so-called core and connector machines
		86	* Per machine and runtime there are a lot of actions you can take on your environment.
		87
		88	== 5. Suggested Additional Readings ==
		89
		90	* [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome\|\|target="blank"]]
		91	** [[eMagiz Architecture (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-architecture.WebHome\|\|target="blank"]]
		92	** [[eMagiz Cloud (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-cloud-inner-workings\|\|target="blank"]]
		93	* [[Novice (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome\|\|target="blank"]]
		94	** [[File Based Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.File based connectivity.WebHome\|\|target="blank"]]
		95	*** [[Volume Mapping (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.File based connectivity.novice-file-based-connectivity-volume-mapping-on-premise\|\|target="blank"]]
		96	** [[eMagiz Cloud Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.eMagiz Cloud Management.WebHome\|\|target="blank"]]
		97	* [[Intermediate Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome\|\|target="blank"]]
		98	** [[eMagiz Runtime Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome\|\|target="blank"]]
		99	*** [[Runtime Settings (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-runtime-settings.WebHome\|\|target="blank"]]
		100	*** [[Start/Stop Flows (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-start-stop-flows.WebHome\|\|target="blank"]]
		101	*** [[Restart Runtime (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-restart-runtime.WebHome\|\|target="blank"]]
		102	*** [[Reset Runtime (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-reset-runtime.WebHome\|\|target="blank"]]
		103	*** [[Reset H2 (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-reset-h2.WebHome\|\|target="blank"]]
		104	* [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome\|\|target="blank"]]
		105	** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Solution Architecture.WebHome\|\|target="blank"]]
		106	*** [[Architectural Runtime Decisions (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Solution Architecture.advanced-solution-architecture-runtime-decision.WebHome\|\|target="blank"]]
		107	*** [[Key differences Design & Deploy Architecture (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Solution Architecture.advanced-solution-architecture-diffs-design-deploy.WebHome\|\|target="blank"]]
		108	*** [[Consequences Of Cloud Size (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Solution Architecture.advanced-solution-architecture-consequence-size-cloud.WebHome\|\|target="blank"]]
		109	* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome\|\|target="blank"]]
		110	** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome\|\|target="blank"]]
		111	*** [[How to Determine Needed Memory (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-determining-needed-memory\|\|target="blank"]]
		112	* [[Deploy Architecture (Search Result)>>url:https://docs.emagiz.com/bin/view/Main/Search?text=%22deploy%20architecture%22&f_type=DOCUMENT&f_space_facet=0%2FMain.&f_locale=en&f_locale=&f_locale=en&r=1\|\|target="blank"]]
		113	)))
		114
		115	(((
		116	{{toc/}}
		117	)))
		118	{{/container}}
		119	{{/container}}

Wiki source code of Understanding Deploy Architecture - Basic

Navigation