Wiki source code of Volume Mapping (On-premise)

Version 47.1 by Erik Bakker on 2022/10/31 15:15

version	line-number	content
21.1	1	{{container}}{{container layoutStyle="columns"}}(((
40.1	2
38.1	3	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	4
21.1	5	Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
1.1	6
	7	== 1. Prerequisites ==
	8
	9	* Basic knowledge of the eMagiz platform
	10
	11	== 2. Key concepts ==
	12
38.1	13	This microlearning centers around learning how to set up your volume mapping correctly so you can exchange file-based data on-premise.
1.1	14
38.1	15	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	16
38.1	17	There are several options for volume mapping for your on-premise machine.
	18	* Volume
	19	* Bind mount
	20	* Temporary file system
	21	* Named pipe
1.1	22
38.1	23	== 3. Volume Mapping (On-premise) ==
1.1	24
38.1	25	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	26
38.1	27	There are several options for volume mapping for your on-premise machine.
	28	* Volume
	29	* Bind mount
	30	* Temporary file system
	31	* Named pipe
1.1	32
38.1	33	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.
	34
	35	[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-option-context-menu.png]]
	36
	37	When you click this option, you will see the following pop-up. In this pop-up, you can define the machine-level and runtime-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
	39	[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-mapping-pop-up.png]]
	40
41.1	41	{{info}}Note that you should be in "Start editing" mode to make any changes to the configuration of your volume mapping.{{/info}}
38.1	42
	43	=== 3.1 Volume ===
	44
44.1	45	The first type available to you is Volume. With this option you create one or more folders on docker that is relevant for that runtime to read and/or write persistent data. To configure this type you need to link the runtime volume to a machine volume that you can create within the same pop-up. This means that you can re-use a "Machine volume" over multiple runtimes (i.e. containers).
43.1	46
	47	So, at first we open the tab called "Machine volume". By pressing the "New" button we can define a new "Machine volume". In the pop-up that follows we can define the name of a machine volume and tell whether the volume already exists on your docker installation or not.
	48
	49	[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--machine-volumes-configuration.png]]
	50
	51	Once you have done so we press "Save" and switch back to the "Runtime volumes" tab. In here we press the "New" button to create a new "Runtime volume". In the pop-up that follows we first need to select the Type we want to use. For this example we use the type called "Volume". Based on your selection the relevant input fields will change.
	52
	53	[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume.png]]
	54
	55	The first thing we need to select is the "Machine volume". Once we have selected our "Machine volume" we need to select the Target that is 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 "Machine volume" name to arrive at the correct directory from which eMagiz needs to read data (or write data to). So in our case this would be "/file-directory/target."
	56
	57	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.
	58
	59	[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume-filled-in.png]]
	60
	61	{{warning}}Note, that when you use the Volume option the external system with which you exchange data on-premise via a file based method need 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}}
	62
42.1	63	=== 3.2 Bind mount ===
1.1	64
44.1	65	An alternative option to read and write persistent data is to use the "Bind mount" option avaiable. In general we advice to use the "Volume" option because they have better performance and bind mounts are dependent on the directory structure and OS of the host machine. Having said that not all external systems can adapt to this that easily. That is why the "Bind mount" option can be of interest in your use case.
	66
46.1	67	[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-bind-mount.png]]
	68
44.1	69	To configure a "Bind mount" you need to define a source and a target directory that are linked to each other. The source directory defines the directory on your local system (that might already be in use currently to exchange files). The target directory defines a directory on your docker installation that can be accessed by the runtime.
	70
46.1	71	{{warning}}Note, that when the source directory does not exists the runtimes cannot be deployed correctly.{{/warning}}
	72
	73	[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-bind-mount-filled-in.png]]
	74
	75	{{info}}Note, that when you use this option your directory reference in your flow should refer to the "target" directory configured here.{{/info}}
	76
42.1	77	=== 3.3 Temporary file system ===
1.1	78
47.1	79	If you do not want to work with persistent data but have a need for non-persistent data the temporary file system option is for you. This way you can increase the container’s performance by avoiding writing into the container’s writable layer.
	80
	81	[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-temp-file-storage.png]]
	82
	83	To configure this option you need a target location. On top of that you can define the maximum size of the temporary file system.
	84
	85	[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-temp-file-storage-filled-in.png]]
	86
	87	{{warning}}We strongly advice to define this number as that way you can limit the potential impact this solution can have on the stability of your machine.{{/warning}}
	88
42.1	89	=== 3.4 Named pipe ===
1.1	90
45.1	91	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.
	92
1.1	93	== 4. Assignment ==
	94
33.1	95	Configure an entry in which you build the archiving and the clean up of the archiving.
1.1	96	This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
	97
	98	== 5. Key takeaways ==
	99
33.1	100	* Archiving is used for audit purposes
	101	* Archiving is used for retry scenarios
	102	* Ensure that data is cleaned after a retention period to keep in control of the data
	103	* Don't forget the max messages per poll
1.1	104
	105	== 6. Suggested Additional Readings ==
	106
33.1	107	If you are interested in this topic and want more information on it please read the help text provided by eMagiz and check out the following store content:
1.1	108
36.1	109	* [[File Archiving>>doc:Main.eMagiz Store.Accelerators.File Archiving.WebHome\|\|target="blank"]]
	110	* [[Delete Folder(s)>>doc:Main.eMagiz Store.Accelerators.Delete Folder(s).WebHome\|\|target="blank"]]
31.1	111
1.1	112	== 7. Silent demonstration video ==
	113
	114	This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
	115
32.1	116	{{video attachment="novice-file-based-connectivity-characterset.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
1.1	117
21.1	118	)))((({{toc/}}))){{/container}}{{/container}}

Wiki source code of Volume Mapping (On-premise)

Navigation