Skip to Content
Last modified by Erik Bakker on 2024/08/26 12:37
From version 49.1
edited by Erik Bakker
on 2022/10/31 15:23
Change comment: There is no comment for this version
To version 54.1
edited by Erik Bakker
on 2023/04/11 12:31
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,14 +42,20 @@
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 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 you can create within the same pop-up. This means 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).
46 46  
52 +==== 3.1.1 Link to Machine Volume ====
53 +
47 47  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.
48 48  
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. Then, 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." 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 +In here, 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."
61 +
62 +{{info}}Based on your selection, the relevant input fields will change.{{/info}}
63 +
53 53  [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume.png]]
54 54  
55 55  The first thing we need to select is the "Machine volume." Once we have chosen our "Machine 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 "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."
... ... @@ -58,6 +58,26 @@
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  
72 +==== 3.1.2 Link to Network Volume ====
73 +
74 +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.
75 +
76 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--network-volumes-configuration.png]]
77 +
78 +Once you have done so, we press "Save" and switch back to the "Runtime volumes" tab.
79 +
80 +In here, 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."
81 +
82 +{{info}}Based on your selection, the relevant input fields will change.{{/info}}
83 +
84 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume.png]]
85 +
86 +The first thing we need to select is the "Machine volume." Once we have chosen our "Machine 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 "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."
87 +
88 +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.
89 +
90 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume-filled-in.png]]
91 +
61 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 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 ===
... ... @@ -68,7 +68,9 @@
68 68  
69 69  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 exist, the runtimes cannot be deployed correctly.{{/warning}}
102 +{{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:
103 +* /mnt/host/{local-directory}
104 +* /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