Changes for page Impact of Runtime Image Upgrades
Last modified by Erik Bakker on 2024/09/03 08:14
From version 19.1
edited by Erik Bakker
on 2024/06/25 14:07
on 2024/06/25 14:07
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 -Impact of Runtime ImageUpgrades1 +Impact of Runtime image upgrades - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki.e bakker1 +XWiki.eMagiz - Content
-
... ... @@ -1,58 +1,63 @@ 1 1 {{container}}{{container layoutStyle="columns"}}((( 2 -In this microlearning, we will focus on helping you to assess the impact of upgrading to anew image.2 +In this microlearning, we will focus on the helping you to assess the impact of upgrading to new buildnumbers. 3 3 4 - Ifyou have any questions, pleasecontact [[academy@emagiz.com>>mailto:academy@emagiz.com]].4 +Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]]. 5 5 6 6 == 1. Prerequisites == 7 7 8 8 * Advanced knowledge of the eMagiz platform 9 +* Complete the microlearning that explains how to upgrade to a new buildnumber 9 9 10 10 == 2. Key concepts == 11 - 12 -With runtime image, we mean the template used to create runtime-specific (docker) images. That image is used to deploy an eMagiz container and contains all required software components to let the eMagiz container function properly. One of the critical requirements is to load the necessary libraries used by runtime flows. A library in this context is a software component that performs a specific, often technical function in the eMagiz runtime. These libraries are based on Java and many open-source frameworks, such as Spring and Artemis. Given that these frameworks also continuously develop, it means that from time to time, we need to upgrade the versions of these underlying frameworks. 13 13 14 - ==3.Assessing the impact ofruntime images==13 +With buildnumbers we mean the piece of software that used by a flow to make it operational inside the runtime. Several eMagiz libraries are loaded together with the flow components XML into the runtime (Java container). In essence that means that a new buildnumber means the flow is technically speaking different from the previous buildnumber. 15 15 16 - As mentioned, the runtime image is a template (i.e., blueprint), which effectively means that all specific eMagizcontainerimages are createdfromthis template.Thetemplateholds all the latest softwareupdates and librariesthat theintegrationflows require. eMagiz followsthe strategy of updating theserequired librariesfrequently toensurevulnerabilities can be fixed quickly andew functionality is availableon a needed basis.Furthermore, havinga singletemplate available allowsall eMagiz containerstooperate onthesame software base across all eMagiz clients.This way, a single mixoflibraries can bemade availableto thecommunity and testedcorrectly andcoherently. There canbeno othermixofsoftwarecomponentsthatbehave differently(as we hadin our legacy runtimearchitecture).15 +eMagiz works hard to limit the number of buildnumbers. The general approach for buildnumber is that these are backwards compatible, so the impact of moving to the next buildnumber poses a minimal impact and risk. 17 17 18 - Inessence, any container image consists of three layers.The first (foundational) layer comprisesa wide array of open-source code heavenly rootedinthe Springand Java frameworks. The secondary layer consists of your collection of flows that should run on a container(i.e., runtime). This layer is built upby the various flow designercomponentsused in your release'sflowversions. The third layer is theconfiguration layer in the form of (application) properties, memory configuration, and other configuration elements (i.e. route,deployment location, volumes, runtime settings). Below, you see a picture that illustrates this concept in an abstract form. IneMagiz, as well as in the image, you see that the layersform one construct that facilitates the purpose of the object. For eMagiz, this purpose is handling data via integrations.17 +== 3. Assessing the impact of changing buildnumbers == 19 19 20 - [[image:Main.Images.Microlearning.WebHome@advanced-lifecycle-management-impact-of-runtime-image-upgrades--runtime-layers.png]]19 +=== 3.1 Release notes & impact assessment === 21 21 22 - ===3.1Overal deploymentstrategy===21 +These can be found [[here>>doc:Main.Release Information.Build numbers.WebHome||target="blank"]]. Once the release notes are properly read, assess the impact. This effectively means that the key notes around the model components can be used. 23 23 24 - Whenthepreparerelease stepistriggered,theruntimeimagewill createpecificruntimeimagestodeployeMagiz containers.Whenwereleaseanew runtime(base)image,eMagizwilltriggerthegenerationofanewcontainerimage foreachruntime(i.e.,container)capturedwithin thefirstreleasecreated**after** we releaseour new runtime image.FormoreinformationonwheneMagiz createsanewcontainerimage,pleasecheckoutthis [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.CrashCourse.CrashCourse Platform.crashcourse-platform-deploy-execute-deployment-plan-gen3.WebHome||target="blank"]].23 +You see often a list of libraries that are updated, and when these are the only notes that means that the impact is slim to none. Then make sure to read the notes above around the model components touched. These will help to asses the impact. Some model components have additional capability, and some have a limited capability or a fix. 25 25 26 -=== 3.2 Release notes & impact assessment === 27 - 28 -Release notes for runtime images can be found [[here>>doc:Main.Release Information.Runtime Images.WebHome||target="blank"]]. Please consult these regularly or at the moment when unexpected behavior is observed. In the strategy of eMagiz, very frequent updates are made to the Runtime Image so that the delta in the software components is incremental. In this way, the risk of unwanted side effects is minimalized. The risk is also mitigated by all flows inside the runtime adhering to the same version of libraries inside the docker image. All this means that the release notes are relevant to understand an issue better. 25 +**Example** 26 +Flows containing a Jetty server (support object), primarily used to host REST and SOAP web services, require some special attention when deploying because not all combinations of build number 50 (and higher) and 48 (and lower) flows will work correctly: 29 29 30 -{{info}}Should an issue occur, we want to be informed of this to take action. If it turns out that a rollback is needed to an earlier image, you can facilitate this via our "disaster recovery" mechanism described below.{{/info}} 28 +* After installing any build 50 (or higher) flow, build 48 (or lower) flows containing a Jetty server on the same runtime cannot be started anymore. If it is really necessary to still install/start a build 48 (or lower) Jetty server flow: uninstall all build 50 (or higher) flows on that runtime first, then install/start the build 48 (or lower) Jetty server flow, and finally re-install the build 50 (or higher) flows. 29 +* When deploying a flow containing a Jetty server, the infra flow of that runtime must have a matching build number, that is: if the the Jetty server flow is build 48 (or lower) the infra needs to be build 48 (or lower) as well, if the Jetty server flow is build 50 (or higher) the infra needs to be 50 (or higher) as well. 31 31 32 - ===3.3Approach===31 +**Impact**: review the runtimes that have flows with a Jetty component and ensure that matching buildnumbers are inside these runtimes for all flows. 33 33 34 - Westrongly advise updating your Test and Acceptance environment first before moving to Production.This will avoidpotential problems appearingin a Production environment beforeany other environment. To better anticipate when a new runtime image will be released, wewill inform our customer base along the following timelines.33 +=== 3.2 Upgrade === 35 35 36 -* High impact 37 -** As part of the release notes of **three** releases ahead of us releasing the new runtime image. 38 -** This information is shared with the whole community upfront through this release notes. 39 -* Medium impact 40 -** As part of the release notes of **one** release ahead of us releasing the new runtime image. 41 -** This information is shared with the whole community upfront through this release notes. 42 -* Low impact 43 -** As part of the release notes for the current release, 44 -** This information is shared upfront with key users. 35 +Use the designed options in eMagiz to upgrade the flows to the new buildnumber. See the relevant microlearnings for that. 45 45 46 -=== 3.3 Disasterrecovery runtimes ===37 +=== 3.3 Functional changes === 47 47 48 - In particular cases, aruntimemaynotfunction properly aftera specific releaseisdone. Thatmeans the flows inthatruntime arenot100% compatiblewiththe runtimeimageused tocreatethe containerimages.As a result,action is neededat eMagizto updatetheruntimeimageorassist youas aclientin resolvingthe issuewithintheconstraintsofthe newruntimeimage.Thissituationisexpectedtobeveryexceptional.We atMagizneedto be informed if youencountersuch a situation. As part ofour regular processand agreementswithour partnersand clients,weneed aregisteredticketfromour Supportdepartmenttoact uponthis.39 +Before an environment is updates to the flows with the latest releases, it is adviced to first check which flows have functional changes. These flows need to be tested and put into production first so that you can isolate issues in case they occur. Once these flows are tested and live, only then move the flows with the new buildnumbers from test to production. 49 49 50 -== 4.Key takeaways==41 +=== 3.4 Approach === 51 51 52 -* A runtime image is the foundational layer of a container image. 53 -* Based on the assessed impact, we communicate sooner or later. 54 -* Read the release notes for runtime images carefully to assess the impact. 43 +It is usually best to update the test and acceptance environment first and leave that running for a certain grace period. So that in case potential issues can be fixed still. 55 55 56 -== 5.SuggestedAdditional Readings==45 +== 4. Assignment == 57 57 58 -If you are interested in this topic and want more information on it, please read the [[release notes>>doc:Main.Release Information.Runtime Images.WebHome||target="blank"]] provided by eMagiz.)))((({{toc/}}))){{/container}}{{/container}} 47 +Take a look at the release notes in the eMagiz Portal to ensure you know where to look. 48 + 49 +== 5. Key takeaways == 50 + 51 +* Keep as close to the latest buildnumber as possible for the entire environment 52 +* The best option is to have the entire environment run on the same buildnumber 53 +* A mix of buildnumbers in a runtime is not a good plan - conflicting behaviors may occur. 54 +* Read the release notes for builnumbers carefully to assess the impact - in case the impact is minimal proceed with the upgrade 55 +* Make the buildnumber upgrades planable so the release schedule takes these actions into account. 56 + 57 +== 6. Suggested Additional Readings == 58 + 59 +If you are interested in this topic and want more information on it, please read the release notes provided by eMagiz 60 + 61 +== 7. Silent demonstration video == 62 + 63 +There is no video available as this is more a theoretical microlearning.)))((({{toc/}}))){{/container}}{{/container}}