Changes for page Volume Mapping (On-premise)
Last modified by Erik Bakker on 2024/08/26 12:37
From version 27.2
edited by Erik Bakker
on 2022/06/10 13:08
on 2022/06/10 13:08
Change comment:
Update document after refactoring.
To version 43.1
edited by Erik Bakker
on 2022/10/31 10:25
on 2022/10/31 10:25
Change comment:
There is no comment for this version
Summary
-
Page properties (3 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 - novice-file-based-connectivity-header-line1 +Volume Mapping (On-premise) - Default language
-
... ... @@ -1,0 +1,1 @@ 1 +en - Content
-
... ... @@ -1,11 +1,9 @@ 1 1 {{container}}{{container layoutStyle="columns"}}((( 2 -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. 3 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 4 Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]]. 5 5 6 -* Last update: May 9th, 2021 7 -* Required reading time: 5 minutes 8 - 9 9 == 1. Prerequisites == 10 10 11 11 * Basic knowledge of the eMagiz platform ... ... @@ -12,66 +12,85 @@ 12 12 13 13 == 2. Key concepts == 14 14 15 -This microlearning centers around using annotations. 16 -With annotations, we mean: A piece of text to explain something to yourself and others 13 +This microlearning centers around learning how to set up your volume mapping correctly so you can exchange file-based data on-premise. 17 17 18 - Annotationscanbeused for:15 +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. 19 19 20 -* Describing a best practice everyone should follow 21 -* Describing (more complex) parts of the flow 22 -* Describe (parts of) your message definitions 17 +There are several options for volume mapping for your on-premise machine. 18 +* Volume 19 +* Bind mount 20 +* Temporary file system 21 +* Named pipe 23 23 24 -== 3. Annotations ==23 +== 3. Volume Mapping (On-premise) == 25 25 26 - In thismicrolearning,wewillfocusonusingannotationsontheflowleveltoclarifyour thoughtprocess.Inheannotation,youeither describeabest practiceeveryone shouldfollowwhenthey changethat flow(i.e. withinthe asynchronous routing)ordescribehowthe(morecomplex) parts of the flow work. Thiswill helpyourselfand others everytimechanges areneeded within theflow.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. 27 27 28 -Annotations can be used for: 27 +There are several options for volume mapping for your on-premise machine. 28 +* Volume 29 +* Bind mount 30 +* Temporary file system 31 +* Named pipe 29 29 30 -* Describing a best practice everyone should follow 31 -* Describing (more complex) parts of the flow 32 -* Describe (parts of) your message definitions 33 +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. 33 33 34 - To clarify the use cases let us take a look at how annotations can be added within the eMagiz platform.n our first example, we will takea look at asynchronous routing.In many eMagiz projects, a best practice is followed on how toadd something to the asynchronous routing(or changesomething within the asynchronous routing). Becausethe best practice contains multiplesteps it makessense touse the annotation functionalityfeMagiz todefine all these steps andregister them at the place youneed them(i.e. the asynchronous routing). Having doneso will resultin somethinglike this:35 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-option-context-menu.png]] 35 35 36 - [[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--annotation-best-practice-async-routing.png]]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. 37 37 38 - The second exampleisabout usingnnotations on theflow level to describeparts of the flow. Inthisexample, we will use the annotation to describethat we use afilter to determine which messagesarepickedup from a local directory and how wefilter. That wayanywayopening the flow has tomerely read the annotationtoget the context. Having donesowill result in somethinglike this:39 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-mapping-pop-up.png]] 39 39 40 - [[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--describe-parts-of-flow.png]]41 +{{info}}Note that you should be in "Start editing" mode to make any changes to the configuration of your volume mapping.{{/info}} 41 41 42 - Thethird 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. youhave 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:43 +=== 3.1 Volume === 43 43 44 - [[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--describe-crucial-part-of-cdm.png]]45 +The first type available to you is Volume. With this option you create one or more folders on docker that is relevant for that runtime to read and/or write persistent data. To configure this type you need to link the runtime volume to a machine volume that you can create within the same pop-up. This means that you can re-use a "Machine volume" over multiple runtimes (i.e. containers). 45 45 46 - Nowthat wesaw some examplesletus turn ourattention to thehow.How canI add an annotation andhowcan I linkit.Addingtheannotation is simple. Youdragtheannotationiconfromtheleftcontextmenuonto thecanvas.Asaresult,anptyannotationwillbeshownonthecanvas. By double-clicking on it youcan typewhateverouwant.Notethatyouneedtobein "StartEditing" modeto changeanything,includingannotations.47 +So, at first we open the tab called "Machine volume". By pressing the "New" button we can define a new "Machine volume". In the pop-up that follows we can define the name of a machine volume and tell whether the volume already exists on your docker installation or not. 47 47 48 -[[image:Main.Images.Microlearning.WebHome@novice- devops-perspectives-annotations--annotation-icon-context-menu.png]]49 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--machine-volumes-configuration.png]] 49 49 50 - Whenyou aresatisfied with whatyou havewrittendownyoucanpresstheSavebutton.Afteryouhavedonesoyoucan rescale theannotation toensurethatthecompletetextisvisible.To linktheannotationtoacomponent(onflowlevel)oran entity(onmessageefinitionlevel)youhoveroverthe annotationuntil yourmouseindicatorchangesto a + icon,executea right-clickanddrag fromthe annotation to thecomponent inquestion.51 +Once you have done so we press "Save" and switch back to the "Runtime volumes" tab. In here we press the "New" button to create a new "Runtime volume". In the pop-up that follows 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. 51 51 52 - Now you know whatannotationsaregoodforandhowyoucanadd themwithinheMagiz platform.53 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume.png]] 53 53 55 +The first thing we need to select is the "Machine volume". Once we have selected our "Machine volume" we need to select the Target that is 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." 56 + 57 +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. 58 + 59 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume-filled-in.png]] 60 + 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 need 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 + 63 +=== 3.2 Bind mount === 64 + 65 +=== 3.3 Temporary file system === 66 + 67 +=== 3.4 Named pipe === 68 + 54 54 == 4. Assignment == 55 55 56 - Addannotationon theflowlevelthat describeshow(a partof)aflow works.71 +Configure an entry in which you build the archiving and the clean up of the archiving. 57 57 This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment. 58 58 59 59 == 5. Key takeaways == 60 60 61 -* Annotations can be used for: 62 - * Describing a best practice everyone should follow 63 - * Describing (more complex) parts of the flow 64 - * Describe (parts of) your message definitions 65 -* You can add annotations by dragging and dropping the annotation icon on the canvas. 76 +* Archiving is used for audit purposes 77 +* Archiving is used for retry scenarios 78 +* Ensure that data is cleaned after a retention period to keep in control of the data 79 +* Don't forget the max messages per poll 66 66 67 67 == 6. Suggested Additional Readings == 68 68 69 - Thereare no suggested additional readingson thistopic83 +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: 70 70 85 +* [[File Archiving>>doc:Main.eMagiz Store.Accelerators.File Archiving.WebHome||target="blank"]] 86 +* [[Delete Folder(s)>>doc:Main.eMagiz Store.Accelerators.Delete Folder(s).WebHome||target="blank"]] 87 + 71 71 == 7. Silent demonstration video == 72 72 73 73 This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned. 74 74 75 -{{video attachment="novice- devops-perspectives-annotations.mp4" reference="Main.Videos.Microlearning.WebHome"/}}92 +{{video attachment="novice-file-based-connectivity-characterset.mp4" reference="Main.Videos.Microlearning.WebHome"/}} 76 76 77 77 )))((({{toc/}}))){{/container}}{{/container}}