Skip to Content
Last modified by Erik Bakker on 2024/08/26 12:37
From version 46.1
edited by Erik Bakker
on 2022/10/31 11:27
Change comment: There is no comment for this version
To version 55.1
edited by Erik Bakker
on 2023/04/11 12:37
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,5 +1,9 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 2  
3 +{{warning}}
4 +Please note that this microlearning is for the new monitoring stack only.
5 +{{/warning}}
6 +
3 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.
4 4  
5 5  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
... ... @@ -25,8 +25,9 @@
25 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.
26 26  
27 27  There are several options for volume mapping for your on-premise machine.
28 -* Volume
32 +* Machine volume
29 29  * Bind mount
34 +* Network volume
30 30  * Temporary file system
31 31  * Named pipe
32 32  
... ... @@ -34,7 +34,7 @@
34 34  
35 35  [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-option-context-menu.png]]
36 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.
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 38  
39 39  [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-mapping-pop-up.png]]
40 40  
... ... @@ -42,67 +42,94 @@
42 42  
43 43  === 3.1 Volume ===
44 44  
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).
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.
46 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.
52 +==== 3.1.1 Define Machine Volume ====
48 48  
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.
55 +
49 49  [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--machine-volumes-configuration.png]]
50 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.
58 +Once you have done so, we press "Save" and switch back to the "Runtime volumes" tab.
52 52  
60 +==== 3.1.2 Define Network Volume ====
61 +
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.
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 +
68 +==== 3.1.3 Link Volume ====
69 +
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 +
72 +{{info}}Based on your selection, the relevant input fields will change.{{/info}}
73 +
53 53  [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume.png]]
54 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."
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."
56 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.
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.
58 58  
59 59  [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume-filled-in.png]]
60 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}}
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}}
62 62  
63 63  === 3.2 Bind mount ===
64 64  
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.
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.
66 66  
67 67  [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-bind-mount.png]]
68 68  
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.
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.
70 70  
71 -{{warning}}Note, that when the source directory does not exists the runtimes cannot be deployed correctly.{{/warning}}
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}}
72 72  
73 73  [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-bind-mount-filled-in.png]]
74 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}}
98 +{{info}}Note that when you use this option, your directory reference in your flow should refer to the "target" directory configured here.{{/info}}
76 76  
77 77  === 3.3 Temporary file system ===
78 78  
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.
103 +
104 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-temp-file-storage.png]]
105 +
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.
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 +
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}}
111 +
79 79  === 3.4 Named pipe ===
80 80  
81 -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.
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.
82 82  
83 83  == 4. Assignment ==
84 84  
85 -Configure an entry in which you build the archiving and the clean up of the archiving.
86 -This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
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.
87 87  
88 88  == 5. Key takeaways ==
89 89  
90 -* Archiving is used for audit purposes
91 -* Archiving is used for retry scenarios
92 -* Ensure that data is cleaned after a retention period to keep in control of the data
93 -* Don't forget the max messages per poll
123 +* File-based communication on-premise changes in the new runtime architecture
124 +* There are two ways to store **persistent** data
125 + ** Volume
126 + ** Bind mount
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.
94 94  
95 95  == 6. Suggested Additional Readings ==
96 96  
97 -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:
132 +If you are interested in this topic and want more information, please read the help text provided by eMagiz.
98 98  
99 -* [[File Archiving>>doc:Main.eMagiz Store.Accelerators.File Archiving.WebHome||target="blank"]]
100 -* [[Delete Folder(s)>>doc:Main.eMagiz Store.Accelerators.Delete Folder(s).WebHome||target="blank"]]
101 -
102 102  == 7. Silent demonstration video ==
103 103  
104 -This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
136 +This video demonstrates how you could have handled the assignment and gives context to what you have just learned.
105 105  
106 -{{video attachment="novice-file-based-connectivity-characterset.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
138 +TBA
107 107  
108 108  )))((({{toc/}}))){{/container}}{{/container}}