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

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.CarlijnKokkeler
1 +XWiki.ebakker
Content
... ... @@ -1,9 +1,4 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -
3 -{{warning}}
4 -Please note that this microlearning is for the new monitoring stack only.
5 -{{/warning}}
6 -
7 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 8  
9 9  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
... ... @@ -16,7 +16,7 @@
16 16  
17 17  This microlearning centers around learning how to correctly set up your volume mapping so you can exchange file-based data on-premise.
18 18  
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.
14 +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 (1) the other party writing or reading the data can access this path or (2) when the data is only relevant within the context of eMagiz.
20 20  
21 21  There are several options for volume mapping for your on-premise machine.
22 22  * Volume
... ... @@ -35,11 +35,11 @@
35 35  * Temporary file system
36 36  * Named pipe
37 37  
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.
33 +Below, we will explain the differences between the various options available for your volume mapping. But before we do this, we explain how to set up this configuration within eMagiz. First, you must navigate to Deploy -> Architecture on the model level. This overview lets you access the Volume mapping per runtime deployed on-premise. And then, you can right-click on the runtime to access the context menu.
39 39  
40 40  [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-option-context-menu.png]]
41 41  
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.
37 +Right after 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 this volume levels later). This pop-up page 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.
43 43  
44 44  [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-mapping-pop-up.png]]
45 45  
... ... @@ -89,9 +89,8 @@
89 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 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 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
87 +* In case of mapping a volume on a windows host machine to another one on a windows docker runtime, the following small adjustment is required when writing the source/target paths:
88 +** All “\” in the source/target path should be written as “/”. For example: C:\Users\xxxx\tmp should be written as C:/Users/xxxx/tmp.
95 95  
96 96  {{/warning}}
97 97  
... ... @@ -107,8 +107,15 @@
107 107  
108 108  {{info}}Note that when you use this option, your directory reference in your flow should refer to the "target" directory configured here.{{/info}}
109 109  
104 +{{warning}}
105 +When configuring a bind mount on a windows host machine to another one on a windows docker runtime, the following small adjustment is required when writing the source/target paths:
106 +** All “\” in the source/target path should be written as “/”. For example: C:\Users\xxxx\tmp should be written as C:/Users/xxxx/tmp.
107 +{{/warning}}
108 +
110 110  === 3.3 Temporary file system ===
111 111  
111 +{{info}}This option is only relevant when running on **Linux**.{{/info}}
112 +
112 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.
113 113  
114 114  [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-temp-file-storage.png]]
... ... @@ -117,12 +117,21 @@
117 117  
118 118  [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-temp-file-storage-filled-in.png]]
119 119  
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}}
121 +{{warning}}
122 +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}}
121 121  
122 122  === 3.4 Named pipe ===
123 123  
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.
126 +{{info}}This option is only relevant when running on **Windows**.{{/info}}
125 125  
128 +A named pipe is a named, one-way or duplex pipe for communication between the pipe server and one or more pipe clients. All instances of a named pipe share the same pipe name, but each instance has its own buffers and handles, and provides a separate conduit for client/server communication. Any process can access named pipes, subject to security checks, making named pipes an easy form of communication between related or unrelated processes.
129 +
130 +*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.
131 +
132 +{{warning}}
133 +* When configuring a pipe path on a windows host machine to another one on a windows docker runtime, the following small adjustment is required when writing the source/target paths:
134 +** All “\” in the source/target path should be written as “/”. For example: C:\Users\xxxx\tmp should be written as C:/Users/xxxx/tmp.{{/warning}}
135 +
126 126  === 3.5 Deployment consequences ===
127 127  
128 128  {{warning}}