Changes for page Volume Mapping (On-premise)

Last modified by Erik Bakker on 2024/08/26 12:37

From 36.1 to 37.1 From 58.1 to 59.1

From version 37.1

edited by Erik Bakker
on 2022/08/22 14:24

Change comment: There is no comment for this version

To version 58.1

edited by Erik Bakker
on 2023/11/16 07:06

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

@@ -1,1 +1,1 @@
--Archiving
++Volume Mapping (On-premise)

Default language

...	...	@@ -1,0 +1,1 @@
	1	+en

Content

@@ -1,6 +1,11 @@
  {{container}}{{container layoutStyle="columns"}}(((
--In most cases, the customer wants some kind of insurance policy to determine whether a file has entered or left eMagiz. One way of supplying such functionality for file-based data exchange is through the use of archiving functionality. With the help of this functionality can you easily write the file as received (or about to be sent) to a separate location. By ensuring that the data stays in that location for a certain amount of time and by giving the customer and yourself access you have a sort of audit trail that details the messages that have been exchanged. This archive could also be used to analyze problems in case things go wrong. In this microlearning, we will learn how you can set up that archiving and learn how to clean up the archiving to ensure that data is only kept for a limited period.
++{{warning}}
++Please note that this microlearning is for the new monitoring stack only.
++{{/warning}}
++
++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.
++
  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
  == 1. Prerequisites ==
@@ -9,81 +9,131 @@
  == 2. Key concepts ==
--This microlearning centers around learning how to archive correctly.
++This microlearning centers around learning how to correctly set up your volume mapping so you can exchange file-based data on-premise.
--By archiving, we mean: Temporarily storing data for audit purposes and possible retry scenarios.
++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.
--* Archiving is used for audit purposes
--* Archiving is used for retry scenarios
--* Ensure that data is cleaned after a retention period to keep in control of the data
++There are several options for volume mapping for your on-premise machine.
++* Volume
++* Bind mount
++* Temporary file system
++* Named pipe
--== 3. Archiving ==
++== 3. Volume Mapping (On-premise) ==
--In most cases, the customer wants some kind of insurance policy to determine whether a file has entered or left eMagiz. One way of supplying such functionality for file-based data exchange is through the use of archiving functionality. With the help of this functionality can you easily write the file as received (or about to be sent) to a separate location. By ensuring that the data stays in that location for a certain amount of time and by giving the customer and yourself access you have a sort of audit trail that details the messages that have been exchanged. This archive could also be used to analyze problems in case things go wrong. In this microlearning, we will learn how you can set up that archiving and learn how to clean up the archiving to ensure that data is only kept for a limited period.
++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.
--=== 3.1 Archiving itself ===
++There are several options for volume mapping for your on-premise machine.
++* Machine volume
++* Bind mount
++* Network volume
++* Temporary file system
++* Named pipe
--To make this work in eMagiz you need to navigate to the Create phase of eMagiz and open the entry flow in which you want to archive the files. Within the context of this flow, we need to add functionality that will ensure that each input file is archived and cleaned up when older than three days. To do so first enter "Start Editing" mode on flow level. The first decision we have to take is how we are going to name the files within the archiving. The best practice, in this case, is the original filename + the current time as a suffix. You can define this by dragging a format file name generator (support object) to the canvas.
++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.
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--file-name-generator.png]]
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-option-context-menu.png]]
--After we have done this please add a file outbound channel adapter to the flow including an input channel. Ensure that you use a property for the directory that references another directory compared to the input directory to prevent creating an infinite loop.
++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.
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--archiving-config-file-outbound-basic.png]]
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-mapping-pop-up.png]]
--Now that we have configured the basics let us turn our attention to the advanced configuration. In the advanced tab of this component, we need to select the file name generator to ensure that the files are named correctly. In case you process each line separately you have to choose whether to save them as separate files in the archive or by appending them again. This can be achieved by selecting the correct Mode. In most cases, however, the default Mode of Replace will suffice.
++{{info}}Note that you should be in "Start editing" mode to make any changes to the configuration of your volume mapping.{{/info}}
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--archiving-config-file-outbound-advanced.png]]
++=== 3.1 Volume ===
--The moment you are satisfied press Save. Now that we have configured this it becomes time to determine how we get the needed input to write to our archive. In the example we are using here we want to archive our input file so we need to ensure that the data we received is written to the archive as soon as possible. To do so place a wiretap on the first channel after retrieving the file. This will make sure that the message is archived before processed further. The result should be something as shown below. Note that this same piece of logic could be applied in other flows within the eMagiz platform in a similar manner.
++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.
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--archiving-result.png]]
++==== 3.1.1 Define Machine Volume ====
--=== 3.2 Clean up the Archive ===
++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.
--To ensure that the data is not kept indefinitely we need to clean up the archive. We do so to prevent problems with disk space but also to prevent data leaks of old data that could impact the privacy of others. Before we can set up the logic in eMagiz we need to talk to the customer to see what an acceptable term is within which the data is kept. In most cases, this is a week or two weeks. In this example, we have chosen three days.
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--machine-volumes-configuration.png]]
--Now that we know the limit it is time to configure the components. We start with a composite file filter (support object). Within this filter, we at least define how old a file must be before it can be deleted (in milliseconds). If we turn three days into milliseconds we get 259200000. Furthermore, we at least define that we only want to delete regular files.
++Once you have done so, we press "Save" and switch back to the "Runtime volumes" tab.
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--file-list-filter-for-archive-cleanup.png]]
++{{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}}
--Having done so we can add a file inbound channel adapter to the canvas including an output channel. Ensure that the property reference for the directory matches the one you have used before in the outbound channel adapter. Furthermore link the filter to the component and define the poller according to the best practice.
++==== 3.1.2 Define Network Volume ====
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--file-inbound-archive-cleanup.png]]
++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.
--One thing we should not forget within this configuration is to set the Max messages per poll on the Advanced tab of the poller-configuration to a sufficiently high number (i.e. 50). If you forget to do so and you only check once a day it will mean that only one message will be deleted that day.
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--network-volumes-configuration.png]]
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--file-inbound-archive-cleanup-max-messages-per-poll.png]]
++Once you have done so, we press "Save" and switch back to the "Runtime volumes" tab.
--Now eMagiz will check on a set time interval whether there are files that are older than three days that are ready for deletion. One last step to go. This last step will ensure that all files that fit the bill will be deleted from the archive. Simply add a standard service activator to the canvas and define the following SPeL expression within the component: payload.delete().
++{{info}}When configuring a network volume, the following information is relevant to know:
++* 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
++* When dealing with multiple hosts, you must create a specific entry per host, as this follows the guiding security principles of the underlying infrastructure.{{/info}}
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--archive-cleanup-deletion.png]]
++==== 3.1.3 Link Volume ====
--This will ensure that each file that is retrieved will indeed be deleted from the archive.
++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."
--== 4. Assignment ==
++{{info}} The relevant input fields will change based on your selection. {{/info}}
--Configure an entry in which you build the archiving and the clean up of the archiving.
--This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume.png]]
--== 5. Key takeaways ==
++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."
--* Archiving is used for audit purposes
--* Archiving is used for retry scenarios
--* Ensure that data is cleaned after a retention period to keep in control of the data
--* Don't forget the max messages per poll
++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.
--== 6. Suggested Additional Readings ==
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume-filled-in.png]]
--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:
++{{warning}}Note the following when considering using the Volume option:
++* 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.
++* The Volume option and Machine volume combination can also be used for eMagiz-only information that needs to be persistable, such as archiving.
++* 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.
++{{/warning}}
--* [[File Archiving>>doc:Main.eMagiz Store.Accelerators.File Archiving.WebHome||target="blank"]]
--* [[Delete Folder(s)>>doc:Main.eMagiz Store.Accelerators.Delete Folder(s).WebHome||target="blank"]]
++=== 3.2 Bind mount ===
--== 7. Silent demonstration video ==
++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.
--This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-bind-mount.png]]
--{{video attachment="novice-file-based-connectivity-characterset.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
++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.
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-bind-mount-filled-in.png]]
++
++{{info}}Note that when you use this option, your directory reference in your flow should refer to the "target" directory configured here.{{/info}}
++
++=== 3.3 Temporary file system ===
++
++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.
++
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-temp-file-storage.png]]
++
++To configure this option, you need a target location. On top of that, you can define the maximum size of the temporary file system.
++
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-temp-file-storage-filled-in.png]]
++
++{{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}}
++
++=== 3.4 Named pipe ===
++
++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.
++
++=== 3.5 Deployment consequences ===
++
++{{warning}}
++* 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:
++** /mnt/host/{local-directory}
++** /run/desktop/mnt/host/{local-directory}
++* 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}}
++
++== 4. Key takeaways ==
++
++* File-based communication on-premise changes in the new runtime architecture
++* There are two ways to store **persistent** data
++  ** Volume
++  ** Bind mount
++* 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
++* Before deploying, ensure that the various sources in your configuration exist and that access is granted to avoid problems while deploying.
++* The Temporary file storage option is the way to go when dealing with **non-persistent** data.
++
++== 5. Suggested Additional Readings ==
++
++If you are interested in this topic and want more information, please read the help text provided by eMagiz.
++
  )))((({{toc/}}))){{/container}}{{/container}}

Changes for page Volume Mapping (On-premise)

Summary

Details

Navigation