Changes for page Volume Mapping (On-premise)

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

From 28.1 to 27.2 From 61.1 to 60.1

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 28.1

edited by Erik Bakker
on 2022/06/10 13:12

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Title

@@ -1,1 +1,1 @@
--Volume Mapping (On-premise)
++Header line

Author

@@ -1,1 +1,1 @@
--XWiki.CarlijnKokkeler
++XWiki.ebakker

Default language

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

Content

@@ -1,13 +1,11 @@
  {{container}}{{container layoutStyle="columns"}}(((
++In this microlearning, we will learn how you can define a header line in which you specify the naming of the various columns. Some external systems require a header line when you supply them with data via a flat file that is placed somewhere.
--{{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]].
++* Last update: May 28th, 2021
++* Required reading time: 5 minutes
++
  == 1. Prerequisites ==
  * Basic knowledge of the eMagiz platform
@@ -14,135 +14,59 @@
  == 2. Key concepts ==
--This microlearning centers around learning how to correctly set up your volume mapping so you can exchange file-based data on-premise.
++This microlearning centers around learning how to place a header line on a flat-file output.
--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.
++By header line we mean: A line in the output that defines the naming of the various columns
--There are several options for volume mapping for your on-premise machine.
--* Volume
--* Bind mount
--* Temporary file system
--* Named pipe
++Some external parties require that the first line in the flat file output (i.e. CSV) is filled with column names (i.e. headers). In eMagiz, we call this line a header line.
--== 3. Volume Mapping (On-premise) ==
++== 3. Header line ==
--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.
++In this microlearning, we will learn how you can define a header line in which you specify the naming of the various columns. Some external systems require a header line when you supply them with data via a flat file that is placed somewhere. The header line is the first line in the flat file output. Within this line, the various column names are specified for clarity.
--There are several options for volume mapping for your on-premise machine.
--* Machine volume
--* Bind mount
--* Network volume
--* Temporary file system
--* Named pipe
++To add such a header line in eMagiz you need to navigate to the Create phase of eMagiz and open the exit flow in which you want to drop the file to a certain location. Within the context of this flow, we need to add functionality that will ensure that a header line is written to the output before any functional lines are added. To do so first enter "Start Editing" mode on flow level. After you have done so please add a file outbound channel adapter to the flow including an input channel. We will use this component to write our header line to the flat file output.
--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.
++Ensure that the directory to which you reference is the same as in your functional file outbound channel adapter.
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-option-context-menu.png]]
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--file-outbound-channel-header-line.png]]
--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.
++Now it is time to turn our attention to the Advanced tab. For the Mode select Ignore. Select this option to ensure that the header line is only written down once when there is no output created yet and not somewhere in the middle, in the end, or every time. Furthermore, select the option Append New Line to ensure that the remainder of the information is not appended to the same line.
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-mapping-pop-up.png]]
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--file-outbound-channel-header-line-advanced.png]]
--{{info}}Note that you should be in "Start editing" mode to make any changes to the configuration of your volume mapping.{{/info}}
++After you have done so we need to add a standard transformer that defines the various column names to be written to the flat file output. To do so add the standard transformer component to the canvas including an input channel. After you have done so define the relevant SpEL expression. In this case, we advise using a property value that represents a string of column names. The value of the property should be something as follows:
--=== 3.1 Volume ===
++'Header1;Header2;Header3;Header4'
--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.
++Do note that the separator, in this case, needs to match the requirements of the external system. At the flow configuration level, the standard transformer should look as follows.
--==== 3.1.1 Define Machine Volume ====
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--define-columns-names.png]]
--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.
++Our last step is to ensure that this piece of logic is tied to the main flow and is executed before writing the functional line(s) to the output file. To make that happen we need to add a wiretap to the flow. With the help of this functionality, you can define which part of the logic takes precedence over another part of the logic. To do so double click on the channel on which you want to place a wiretap, select the option wiretap and select the correct wiretap channel. After you have done this the result should be something as follows:
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--machine-volumes-configuration.png]]
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--wiretap-result.png]]
--Once you have done so, we press "Save" and switch back to the "Runtime volumes" tab.
++With these couple of steps, you have now successfully added logic to your flow that will ensure that a header line is added before any functional line(s) are written to the output file.
--{{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}}
++== 4. Assignment ==
--==== 3.1.2 Define Network Volume ====
++Configure an exit in which you define and write a header line to a flat-file output before adding functional lines.
++This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
--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.
++== 5. Key takeaways ==
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--network-volumes-configuration.png]]
++* The header line contains the names of the columns of the flat file output
++* Use the Ignore mode to ensure the header line is created once
++* Use the wiretap to ensure the header line is created first
--Once you have done so, we press "Save" and switch back to the "Runtime volumes" tab.
++== 6. Suggested Additional Readings ==
--{{warning}}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.{{/warning}}
++There are no suggested additional readings on this topic
--==== 3.1.3 Link Volume ====
++== 7. Silent demonstration video ==
--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."
++This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
--{{info}} The relevant input fields will change based on your selection. {{/info}}
++{{video attachment="novice-file-based-connectivity-header-line.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume.png]]
--
--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."
--
--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.
--
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume-filled-in.png]]
--
--{{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.
--* 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:
--** In the source/target path:
--a.	All “\” in the path should be written as “/”. Example: C:\Users\xxxx\tmp should be written as C:/Users/xxxx/tmp
--
--{{/warning}}
--
--=== 3.2 Bind mount ===
--
--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.
--
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-bind-mount.png]]
--
--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