Skip to Content
Last modified by Erik Bakker on 2024/08/26 12:37
From version 47.1
edited by Erik Bakker
on 2022/10/31 15:15
Change comment: There is no comment for this version
To version 60.1
edited by Carlijn Kokkeler
on 2023/11/20 15:08
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ebakker
1 +XWiki.CarlijnKokkeler
Content
... ... @@ -1,7 +1,11 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 2  
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.
3 +{{warning}}
4 +Please note that this microlearning is for the new monitoring stack only.
5 +{{/warning}}
4 4  
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 ensure that the docker container in your runtime(s) running has access to this path. There are several ways of dealing with this challenge. This microlearning will discuss the various alternatives and best approaches in these scenarios.
8 +
5 5  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
6 6  
7 7  == 1. Prerequisites ==
... ... @@ -10,9 +10,9 @@
10 10  
11 11  == 2. Key concepts ==
12 12  
13 -This microlearning centers around learning how to set up your volume mapping correctly so you can exchange file-based data on-premise.
17 +This microlearning centers around learning how to correctly set up your volume mapping so you can exchange file-based data on-premise.
14 14  
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.
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. Note that the data can also be stored inside the docker container when the other party writing or reading the data can access this path or when the data is only relevant within the context of eMagiz.
16 16  
17 17  There are several options for volume mapping for your on-premise machine.
18 18  * Volume
... ... @@ -22,19 +22,20 @@
22 22  
23 23  == 3. Volume Mapping (On-premise) ==
24 24  
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.
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 ensure that the docker container in your runtime(s) running has access to this path. There are several ways of dealing with this challenge. 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  
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.
38 +Below, we will explain the differences between the various options available for your volume mapping. But before we do, we explain how to set up this configuration within eMagiz. Then, you must navigate to Deploy -> Architecture on the model level. This overview lets you 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 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, 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,77 +42,102 @@
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). We first need to define a machine (or network) volume to do so. 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 following pop-up, we can specify the name of a machine volume and tell whether the volume already exists on your docker installation.
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 +{{info}}When stating that the machine volume already exists, you can re-use the same machine volume across multiple runtimes (i.e., containers). This is especially useful when archiving data. You can create a central volume in which the data is stored, and through the linkage of the volume to the machine volume, you can subsequently structure your archiving folder. The paths will then look as follows, "/archive/runtimename"{{/info}}
61 +
62 +==== 3.1.2 Define Network Volume ====
63 +
64 +So, we first open the tab called "Network volume." Then, by pressing the "New" button, we can define a new "Network volume." In the following pop-up, 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 pertinent options that need to be filled in are the host, path, username, and password.
65 +
66 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--network-volumes-configuration.png]]
67 +
68 +Once you have done so, we press "Save" and switch back to the "Runtime volumes" tab.
69 +
70 +{{warning}}When configuring a network volume, the following information is relevant to know:
71 +* When you create a network volume to a folder that contains sub-folders, all sub-folders are shared automatically and can be accessed from the flow level
72 +* When dealing with multiple hosts, you must create a specific entry per host, as this follows the guiding security principles of the underlying infrastructure.{{/warning}}
73 +
74 +==== 3.1.3 Link Volume ====
75 +
76 +In the "Runtime volumes" tab, we push the "New" button to create a new "Runtime volume." In the following pop-up, we must select the Type we want to use. For this example, we use the Type called "Volume."
77 +
78 +{{info}} The relevant input fields will change based on your selection. {{/info}}
79 +
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."
82 +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.
84 +The last setting we need to configure is to define the rights we will grant our runtime on the volume we create. The default setting is read/write rights for the runtime, which is usually sufficient. 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}}
88 +{{warning}}Note the following when considering using the Volume option:
89 +* In the case of using the Volume option in combination with a Machine volume, 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. Should this be a problem, the Bind mount alternative discussed below should be considered.
90 +* The Volume option and Machine volume combination can also be used for eMagiz-only information that needs to be persistable, such as archiving.
91 +* In the case of using the Volume option in combination with a Network volume, the path to read and write from becomes what you define in the target field.
92 +* In case of mapping a volume on a windows host machine to another one on a windows docker runtime when writing the source/target paths, the following small adjustment is required:
93 +** In the source/target path:
94 +a. All “\” in the path should be written as “/”. Example: C:\Users\xxxx\tmp should be written as C:/Users/xxxx/tmp
62 62  
96 +{{/warning}}
97 +
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.
100 +An alternative option to read and write **persistent** data is the "Bind mount" option. We generally advise using the "Volume" option because they perform better, 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.
104 +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}}
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}}
108 +{{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  
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.
112 +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.
80 80  
81 81  [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-temp-file-storage.png]]
82 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.
116 +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 84  
85 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 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}}
120 +{{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}}
88 88  
89 89  === 3.4 Named pipe ===
90 90  
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.
124 +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 92  
93 -== 4. Assignment ==
126 +=== 3.5 Deployment consequences ===
94 94  
95 -Configure an entry in which you build the archiving and the clean up of the archiving.
96 -This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
128 +{{warning}}
129 +* Note that the runtimes cannot be deployed correctly when the source directory **does not exist**. Consequently, no runtime on that machine will start up. One of the following two configurations displayed below are needed to find the source directory:
130 +** /mnt/host/{local-directory}
131 +** /run/desktop/mnt/host/{local-directory}
132 +* When the source directory can be found but the user has no access, the deployment will **fail** for the specific runtime in question with the volume mapping configured. All other runtimes (i.e., containers) will start up (pending other configuration issues).{{/warning}}
97 97  
98 -== 5. Key takeaways ==
134 +== 4. Key takeaways ==
99 99  
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
136 +* File-based communication on-premise changes in the new runtime architecture
137 +* There are two ways to store **persistent** data
138 + ** Volume
139 + ** Bind mount
140 +* 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
141 +* Before deploying, ensure that the various sources in your configuration exist and that access is granted to avoid problems while deploying.
142 +* The Temporary file storage option is the way to go when dealing with **non-persistent** data.
104 104  
105 -== 6. Suggested Additional Readings ==
144 +== 5. Suggested Additional Readings ==
106 106  
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:
146 +If you are interested in this topic and want more information, please read the help text provided by eMagiz.
108 108  
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"]]
111 -
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 -
116 -{{video attachment="novice-file-based-connectivity-characterset.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
117 -
118 118  )))((({{toc/}}))){{/container}}{{/container}}