Wiki source code of Volume Mapping (On-premise)
Version 53.1 by Erik Bakker on 2023/04/11 12:22
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
21.1 | 1 | {{container}}{{container layoutStyle="columns"}}((( |
| |
40.1 | 2 | |
| |
50.1 | 3 | {{warning}} |
| 4 | Please note that this microlearning is for the new monitoring stack only. | ||
| 5 | {{/warning}} | ||
| 6 | |||
| |
38.1 | 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 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 | 8 | |
| |
21.1 | 9 | Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]]. |
| |
1.1 | 10 | |
| 11 | == 1. Prerequisites == | ||
| 12 | |||
| 13 | * Basic knowledge of the eMagiz platform | ||
| 14 | |||
| 15 | == 2. Key concepts == | ||
| 16 | |||
| |
38.1 | 17 | This microlearning centers around learning how to set up your volume mapping correctly so you can exchange file-based data on-premise. |
| |
1.1 | 18 | |
| |
38.1 | 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. |
| |
1.1 | 20 | |
| |
38.1 | 21 | There are several options for volume mapping for your on-premise machine. |
| 22 | * Volume | ||
| 23 | * Bind mount | ||
| 24 | * Temporary file system | ||
| 25 | * Named pipe | ||
| |
1.1 | 26 | |
| |
38.1 | 27 | == 3. Volume Mapping (On-premise) == |
| |
1.1 | 28 | |
| |
38.1 | 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 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 | 30 | |
| |
38.1 | 31 | There are several options for volume mapping for your on-premise machine. |
| 32 | * Volume | ||
| 33 | * Bind mount | ||
| 34 | * Temporary file system | ||
| 35 | * Named pipe | ||
| |
1.1 | 36 | |
| |
38.1 | 37 | 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 | |||
| 39 | [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-option-context-menu.png]] | ||
| 40 | |||
| 41 | 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 | |||
| 43 | [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-mapping-pop-up.png]] | ||
| 44 | |||
| |
41.1 | 45 | {{info}}Note that you should be in "Start editing" mode to make any changes to the configuration of your volume mapping.{{/info}} |
| |
38.1 | 46 | |
| 47 | === 3.1 Volume === | ||
| 48 | |||
| |
49.1 | 49 | 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). |
| |
43.1 | 50 | |
| |
49.1 | 51 | 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. |
| |
43.1 | 52 | |
| 53 | [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--machine-volumes-configuration.png]] | ||
| 54 | |||
| |
49.1 | 55 | 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. |
| |
43.1 | 56 | |
| 57 | [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume.png]] | ||
| 58 | |||
| |
49.1 | 59 | 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." |
| |
43.1 | 60 | |
| |
49.1 | 61 | 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. |
| |
43.1 | 62 | |
| 63 | [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume-filled-in.png]] | ||
| 64 | |||
| |
49.1 | 65 | {{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}} |
| |
43.1 | 66 | |
| |
42.1 | 67 | === 3.2 Bind mount === |
| |
1.1 | 68 | |
| |
49.1 | 69 | 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. |
| |
44.1 | 70 | |
| |
46.1 | 71 | [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-bind-mount.png]] |
| 72 | |||
| |
49.1 | 73 | 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. |
| |
44.1 | 74 | |
| |
51.1 | 75 | {{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: |
| 76 | * /mnt/host/{local-directory} | ||
| 77 | * /run/desktop/mnt/host/{local-directory}{{/warning}} | ||
| |
46.1 | 78 | |
| 79 | [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-bind-mount-filled-in.png]] | ||
| 80 | |||
| |
49.1 | 81 | {{info}}Note that when you use this option, your directory reference in your flow should refer to the "target" directory configured here.{{/info}} |
| |
46.1 | 82 | |
| |
42.1 | 83 | === 3.3 Temporary file system === |
| |
1.1 | 84 | |
| |
49.1 | 85 | 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. |
| |
47.1 | 86 | |
| 87 | [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-temp-file-storage.png]] | ||
| 88 | |||
| |
49.1 | 89 | To configure this option, you need a target location. On top of that, you can define the maximum size of the temporary file system. |
| |
47.1 | 90 | |
| 91 | [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-temp-file-storage-filled-in.png]] | ||
| 92 | |||
| |
49.1 | 93 | {{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}} |
| |
47.1 | 94 | |
| |
42.1 | 95 | === 3.4 Named pipe === |
| |
1.1 | 96 | |
| |
49.1 | 97 | 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. |
| |
45.1 | 98 | |
| |
1.1 | 99 | == 4. Assignment == |
| 100 | |||
| |
49.1 | 101 | 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). |
| 102 | This assignment can be completed with the help of the (Academy) project you created/used in the previous assignment. | ||
| |
1.1 | 103 | |
| 104 | == 5. Key takeaways == | ||
| 105 | |||
| |
49.1 | 106 | * File-based communication on-premise changes in the new runtime architecture |
| |
48.1 | 107 | * There are two ways to store **persistent** data |
| 108 | ** Volume | ||
| 109 | ** Bind mount | ||
| |
49.1 | 110 | * 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 |
| 111 | * When you want to deal with **non-persistent** data, the Temporary file storage option is the way to go. | ||
| |
1.1 | 112 | |
| 113 | == 6. Suggested Additional Readings == | ||
| 114 | |||
| |
49.1 | 115 | If you are interested in this topic and want more information, please read the help text provided by eMagiz. |
| |
1.1 | 116 | |
| 117 | == 7. Silent demonstration video == | ||
| 118 | |||
| |
49.1 | 119 | This video demonstrates how you could have handled the assignment and gives context to what you have just learned. |
| |
1.1 | 120 | |
| |
48.1 | 121 | TBA |
| |
1.1 | 122 | |
| |
21.1 | 123 | )))((({{toc/}}))){{/container}}{{/container}} |