Wiki source code of Volume Mapping (On-premise)

Version 56.1 by Erik Bakker on 2023/04/11 12:39

version	line-number	content
21.1	1	{{container}}{{container layoutStyle="columns"}}(((
40.1	2
50.1	3	{{warning}}
	4	Please note that this microlearning is for the new monitoring stack only.
	5	{{/warning}}
	6
38.1	7	When you need to read and write files from an on-premise disk, you need to know the path in which the data is stored and make sure that the docker container in your runtime(s) running has access to this path. There are several ways of dealing with this challenge. First, this microlearning will discuss the various alternatives and best approaches in these scenarios.
1.1	8
21.1	9	Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
1.1	10
	11	== 1. Prerequisites ==
	12
	13	* Basic knowledge of the eMagiz platform
	14
	15	== 2. Key concepts ==
	16
38.1	17	This microlearning centers around learning how to set up your volume mapping correctly so you can exchange file-based data on-premise.
1.1	18
38.1	19	By volume mapping, we mean: Creating a configuration through which the docker container can read and write data on a specific path on an on-premise machine.
1.1	20
38.1	21	There are several options for volume mapping for your on-premise machine.
	22	* Volume
	23	* Bind mount
	24	* Temporary file system
	25	* Named pipe
1.1	26
38.1	27	== 3. Volume Mapping (On-premise) ==
1.1	28
38.1	29	When you need to read and write files from an on-premise disk, you need to know the path in which the data is stored and make sure that the docker container in your runtime(s) running has access to this path. There are several ways of dealing with this challenge. First, this microlearning will discuss the various alternatives and best approaches in these scenarios.
1.1	30
38.1	31	There are several options for volume mapping for your on-premise machine.
54.1	32	* Machine volume
38.1	33	* Bind mount
54.1	34	* Network volume
38.1	35	* Temporary file system
	36	* Named pipe
1.1	37
38.1	38	Below we will explain the differences between the various options available for your volume mapping. But before we do, we first explain how to set up this configuration within eMagiz. Then, you must navigate to Deploy -> Architecture on the model level. In this overview, you can access the Volume mapping per runtime deployed on-premise. To do so, you can right-click on the runtime to access the context menu.
	39
	40	[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-option-context-menu.png]]
	41
54.1	42	When you click this option, you will see the following pop-up. In this pop-up, you can define the machine-level, runtime-level volumes and network-level volumes. More on that later. This is the starting point for configuring your volume mapping. We will walk through each available option and explain how they work and should be configured.
38.1	43
	44	[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-mapping-pop-up.png]]
	45
41.1	46	{{info}}Note that you should be in "Start editing" mode to make any changes to the configuration of your volume mapping.{{/info}}
38.1	47
	48	=== 3.1 Volume ===
	49
55.1	50	The first Type available to you is Volume. With this option, you create one or more folders on Docker relevant to that runtime to read and write persistent data. To configure this Type, you need to link the runtime volume to a machine volume (or network volume) you can create within the same pop-up. This means you can re-use a "Machine volume" or a "Network volume" over multiple runtimes (i.e., containers). To do so we first need to define a machine (or network) volume. Once we have done that we can learn how to link the volume to the machine or network volume.
43.1	51
55.1	52	==== 3.1.1 Define Machine Volume ====
54.1	53
49.1	54	So, we first open the tab called "Machine volume." Then, by pressing the "New" button, we can define a new "Machine volume." In the pop-up that follows, we can specify the name of a machine volume and tell whether the Volume already exists on your docker installation or not.
43.1	55
	56	[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--machine-volumes-configuration.png]]
	57
54.1	58	Once you have done so, we press "Save" and switch back to the "Runtime volumes" tab.
43.1	59
55.1	60	==== 3.1.2 Define Network Volume ====
54.1	61
55.1	62	So, we first open the tab called "Network volume." Then, by pressing the "New" button, we can define a new "Network volume." In the pop-up that follows, we can specify the name of a machine volume and configure the relevant information for a network volume. In most cases a CIFS is used and the only relevant options that need to be filled in are the host, port, username and password.
54.1	63
	64	[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--network-volumes-configuration.png]]
	65
	66	Once you have done so, we press "Save" and switch back to the "Runtime volumes" tab.
	67
55.1	68	==== 3.1.3 Link Volume ====
54.1	69
55.1	70	In the "Runtime volumes" tab, we push the "New" button to create a new "Runtime volume." In the following pop-up, we first need to select the Type we want to use. For this example, we use the Type called "Volume."
	71
54.1	72	{{info}}Based on your selection, the relevant input fields will change.{{/info}}
	73
	74	[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume.png]]
	75
55.1	76	The first thing we need to select is the "Volume." Once we have chosen our "Volume," we must set the Target specific for this runtime. This target defines the second part of the path to which the runtime will gain access. For example, when you fill in "/target", we can combine this with the "Volume" name to arrive at the correct directory from which eMagiz needs to read data (or write data to). So in our case in which we link the volume to the machine volume we created earlier, this would be "/file-directory/target."
54.1	77
	78	The last setting we need to configure is to define which rights we will grant our runtime on the Volume we are creating. The default setting is read/write rights for the runtime, which is sufficient in most cases. The result of following these steps will be the following.
	79
	80	[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume-filled-in.png]]
	81
49.1	82	{{warning}}Note that when you use the Volume option, the external system with which you exchange data on-premise via a file-based method needs to be able to write or read the data from the Volume (i.e., directory) you have configured in Docker. Should this be a problem, the Bind mount alternative discussed below should be considered.{{/warning}}
43.1	83
42.1	84	=== 3.2 Bind mount ===
1.1	85
49.1	86	An alternative option to read and write persistent data is to use the "Bind mount" option. In general, we advise using the "Volume" option because they have better performance, and bind mounts depend on the host machine's directory structure and OS. However, only some external systems can adapt to this that easily. For example, the "Bind mount" option can interest your use case.
44.1	87
46.1	88	[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-bind-mount.png]]
	89
49.1	90	To configure a "Bind mount," you need to define a source and a target directory linked to each other. The source directory represents the directory on your local system (that might already be used currently to exchange files). The target directory defines a directory on your docker installation that the runtime can access.
44.1	91
51.1	92	{{warning}}Note that when the source directory does not exist, the runtimes cannot be deployed correctly. One of the following two configurations displayed below are needed to find the source directory:
	93	* /mnt/host/{local-directory}
	94	* /run/desktop/mnt/host/{local-directory}{{/warning}}
46.1	95
	96	[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-bind-mount-filled-in.png]]
	97
49.1	98	{{info}}Note that when you use this option, your directory reference in your flow should refer to the "target" directory configured here.{{/info}}
46.1	99
42.1	100	=== 3.3 Temporary file system ===
1.1	101
49.1	102	The temporary file system option is for you if you do not want to work with persistent data but require non-persistent data. This way, you can increase the container's performance by avoiding writing into the container's writable layer.
47.1	103
	104	[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-temp-file-storage.png]]
	105
49.1	106	To configure this option, you need a target location. On top of that, you can define the maximum size of the temporary file system.
47.1	107
	108	[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-temp-file-storage-filled-in.png]]
	109
49.1	110	{{warning}}We strongly advise you to define this number so that you can limit the potential impact this solution can have on the stability of your machine.{{/warning}}
47.1	111
42.1	112	=== 3.4 Named pipe ===
1.1	113
49.1	114	The named pipe option can be selected, but we yet have to see a valid use case within the context of eMagiz for using this option. Therefore we won't discuss this option further in this microlearning.
45.1	115
1.1	116	== 4. Assignment ==
	117
49.1	118	Navigate to Deploy -> Architecture and look at the Volume mapping options, read the help texts, and play around with the settings (if it is not a customer environment).
	119	This assignment can be completed with the help of the (Academy) project you created/used in the previous assignment.
1.1	120
	121	== 5. Key takeaways ==
	122
49.1	123	* File-based communication on-premise changes in the new runtime architecture
48.1	124	* There are two ways to store persistent data
	125	** Volume
	126	** Bind mount
49.1	127	* The Volume option is considered the best alternative because they have better performance, and bind mounts are dependent on the directory structure and OS of the host machine
	128	* When you want to deal with non-persistent data, the Temporary file storage option is the way to go.
1.1	129
	130	== 6. Suggested Additional Readings ==
	131
49.1	132	If you are interested in this topic and want more information, please read the help text provided by eMagiz.
1.1	133
	134	== 7. Silent demonstration video ==
	135
49.1	136	This video demonstrates how you could have handled the assignment and gives context to what you have just learned.
1.1	137
48.1	138	TBA
1.1	139
21.1	140	)))((({{toc/}}))){{/container}}{{/container}}

Wiki source code of Volume Mapping (On-premise)

Navigation