Changes for page Volume Mapping (On-premise)

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

From 19.1 to 20.1 From 69.1 to 70.1

From version 20.1

edited by eMagiz
on 2022/05/22 21:30

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

Raw
Rendered

Summary

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

Details

Page properties

Title

...	...	@@ -1,0 +1,1 @@
	1	+Volume Mapping (On-premise)

Parent

...	...	@@ -1,0 +1,1 @@
	1	+WebHome

Author

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

Default language

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

Content

@@ -1,97 +1,158 @@
--{{html wiki="true"}}
--<div class="ez-academy">
--    <div class="ez-academy_body">
++{{container}}{{container layoutStyle="columns"}}(((
++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.
--<div class="doc">
++Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
++== 1. Prerequisites ==
++* Basic knowledge of the eMagiz platform
--= Annotations =
++== 2. Key concepts ==
--In this microlearning, we will focus on using annotations to clarify your thought process. In the annotation, you either describe a best practice everyone should follow when they change that flow (i.e. within the asynchronous routing), describe how the (more complex) parts of the flow work or describe (parts of) of your message definitions (i.e. CDM, API Gateway Data model, system message, etc.). This will help yourself and others every time changes are needed.
++This microlearning centers around learning how to correctly set up your volume mapping so you can exchange file-based data on-premise.
--Should you have any questions, please contact academy@emagiz.com.
++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.
--* Last update: May 9th, 2021
--* Required reading time: 5 minutes
++There are several options for volume mapping for your on-premise machine.
++* Volume
++* Bind mount
++* Temporary file system
++* Named pipe
--== 1. Prerequisites ==
++== 3. Volume Mapping (On-premise) ==
--* Basic knowledge of the eMagiz platform
++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.
--== 2. Key concepts ==
++There are several options for volume mapping for your on-premise machine.
++* Machine volume
++* Bind mount
++* Network volume
++* Temporary file system
++* Named pipe
--This microlearning centers around using annotations.
--With annotations, we mean: A piece of text to explain something to yourself and others
++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.
--Annotations can be used for:
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-option-context-menu.png]]
--* Describing a best practice everyone should follow
--* Describing (more complex) parts of the flow
--* Describe (parts of) your message definitions
++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.
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-mapping-pop-up.png]]
++{{info}}Note that you should be in "Start editing" mode to make any changes to the configuration of your volume mapping.{{/info}}
--== 3. Annotations ==
++=== 3.1 Volume ===
--In this microlearning, we will focus on using annotations on the flow level to clarify our thought process. In the annotation, you either describe a best practice everyone should follow when they change that flow (i.e. within the asynchronous routing) or describe how the (more complex) parts of the flow work. This will help yourself and others every time changes are needed within the flow.
++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.
--Annotations can be used for:
++==== 3.1.1 Define Machine Volume ====
--* Describing a best practice everyone should follow
--* Describing (more complex) parts of the flow
--* Describe (parts of) your message definitions
++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 clarify the use cases let us take a look at how annotations can be added within the eMagiz platform. In our first example, we will take a look at asynchronous routing. In many eMagiz projects, a best practice is followed on how to add something to the asynchronous routing (or change something within the asynchronous routing). Because the best practice contains multiple steps it makes sense to use the annotation functionality of eMagiz to define all these steps and register them at the place you need them (i.e. the asynchronous routing). Having done so will result in something like this:
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--machine-volumes-configuration.png]]
--<p align="center">[[image:novice-devops-perspectives-annotations--annotation-best-practice-async-routing.png||]]</p>
++Once you have done so, we press "Save" and switch back to the "Runtime volumes" tab.
--The second example is about using annotations on the flow level to describe parts of the flow. In this example, we will use the annotation to describe that we use a filter to determine which messages are picked up from a local directory and how we filter. That way anyway opening the flow has to merely read the annotation to get the context. Having done so will result in something like this:
++{{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}}
--<p align="center">[[image:novice-devops-perspectives-annotations--describe-parts-of-flow.png||]]</p>
++==== 3.1.2 Define Network Volume ====
--The third example does not take place on the flow level but the message definition level. Therefore instead of going to Create, we go to Design. In Design when you navigate to the CDM, API Gateway Data model, Event Streaming Data model, message definitions, etc. you have the option to add annotations to the canvas. In this example, we want to make clear to all that make changes that a certain part of our CDM is used by a lot of integrations within eMagiz and therefore everyone should be careful and think twice before adjusting anything related to that part. Having done so will result in something like this:
++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.
--<p align="center">[[image:novice-devops-perspectives-annotations--describe-crucial-part-of-cdm.png||]]</p>
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--network-volumes-configuration.png]]
--Now that we saw some examples let us turn our attention to the how. How can I add an annotation and how can I link it. Adding the annotation is simple. You drag the annotation icon from the left context menu onto the canvas. As a result, an empty annotation will be shown on the canvas. By double-clicking on it you can type whatever you want. Note that you need to be in "Start Editing" mode to change anything, including annotations.
++Once you have done so, we press "Save" and switch back to the "Runtime volumes" tab.
--<p align="center">[[image:novice-devops-perspectives-annotations--annotation-icon-context-menu.png||]]</p>
++{{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}}
--When you are satisfied with what you have written down you can press the Save button. After you have done so you can rescale the annotation to ensure that the complete text is visible. To link the annotation to a component (on flow level) or an entity (on message definition level) you hover over the annotation until your mouse indicator changes to a + icon, execute a right-click and drag from the annotation to the component in question.
++==== 3.1.3 Link Volume ====
--Now you know what annotations are good for and how you can add them within the eMagiz platform.
++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."
--===== Practice =====
++{{info}} The relevant input fields will change based on your selection. {{/info}}
--== 4. Assignment ==
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume.png]]
--Add annotation on the flow level that describes how (a part of) a flow works.
--This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
++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."
--== 5. Key takeaways ==
++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.
--* Annotations can be used for:
--  * Describing a best practice everyone should follow
--  * Describing (more complex) parts of the flow
--  * Describe (parts of) your message definitions
--* You can add annotations by dragging and dropping the annotation icon on the canvas.
++[[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, the following small adjustment is required when writing the source/target paths:
++** 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}}
--== 6. Suggested Additional Readings ==
++=== 3.2 Bind mount ===
--There are no suggested additional readings on this topic
++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.
--== 7. Silent demonstration video ==
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-bind-mount.png]]
--This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
++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.
--<iframe width="1280" height="720" src="../../vid/microlearning/novice-devops-perspectives-annotations.mp4" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-bind-mount-filled-in.png]]
--</div>
++{{info}}Note that when you use this option, your directory reference in your flow should refer to the "target" directory configured here.{{/info}}
--</div>
--</div>
++{{warning}}
++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:
++** 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}}
--{{/html}}
++=== 3.3 Temporary file system ===
++
++{{info}}This option is only relevant when running on **Linux**.{{/info}}
++
++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 ===
++
++{{info}}This option is only relevant when running on **Windows**.{{/info}}
++
++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.
++
++*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.
++
++{{warning}}
++* 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:
++** 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}}
++
++=== 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}}

novice-devops-perspectives-annotations--annotation-best-practice-async-routing.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.marijn

Size

...	...	@@ -1,1 +1,0 @@
1		-25.7 KB

Content

novice-devops-perspectives-annotations--annotation-icon-context-menu.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.marijn

Size

...	...	@@ -1,1 +1,0 @@
1		-774 bytes

Content

novice-devops-perspectives-annotations--describe-crucial-part-of-cdm.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.marijn

Size

...	...	@@ -1,1 +1,0 @@
1		-15.5 KB

Content

novice-devops-perspectives-annotations--describe-parts-of-flow.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.marijn

Size

...	...	@@ -1,1 +1,0 @@
1		-18.9 KB

Content

Changes for page Volume Mapping (On-premise)

Summary

Details

Navigation