Impact of Runtime image upgrades

With runtime image we mean the template that is used to create runtime specific docker images. That image is used to spin up docker containers and contains all required software components to let the docker container function properly. One of the key requirements is to load the required libraries that are used by flows of a runtime. A library in this context is a software component that performs a specific, often technical function in the eMagiz runtime. These libraries are Java based and different versions exist of these libraries.

13

14

== 3. Assessing the impact of runtime images ==

15

16

As mentioned the runtime image is a template which effectively means that all specific docker images that are created from this template. The template holds all latest software updates and libraries that the integration flows require. eMagiz follows the strategy to update these required libraries on a frequent basis to ensure vulnerabilities can be fixed quickly and new functionality is available on a needed basis. Furthermore, by having a single template available all runtime are operating on exactly the same software base across all eMagiz clients. This way, a single mix of libraries can be made available to the community that is tested properly and coherent. There can be no other mix of software components that behave each differently.

17

18

=== 3.1 Overal deployment strategy ===

19

20

At the moment when a release is set as active, the runtime image will be used to create specific runtime images that are used to deploy Docker containers. Effectively that means that for every release, a specific docker image is created and that docker image will be used at the moment when the deployment plan is run. That also means that at each and every deployment, all docker containers will be replaced with a new docker container based on that docker image created of the release.

21

22

=== 3.2 Release notes & impact assessment ===

23

24

Release notes for runtime images can be found [[here>>doc:Main.Release Information.Runtime Images.WebHome||target="blank"]]. Please consult these at a regular basis 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 are incremental. In this way, risk of unwanted side effects is minimalized. The risk is also mitigated by the fact that all flows inside the runtime will adhere to the same version of libraries inside the docker image. All and all this means that the release notes are relevant to better understand an issue. At that moment, the option below is available to deal with this specific scenario.

25

26

=== 3.2 Disaster recovery runtimes ===

27

28

In very specific cases, a runtime may not function properly after a specific release is done. That means that the flows in that runtime are not 100% compatible with the runtime image used to create the docker images from. This may happen in cases when there hasn't been a deployment for many months, and the new runtime images will contain large changes. Effectively that means that the Runtime Image as delivered by eMagiz is incompatible with the flows in that runtime. And action is needed on eMagiz side to update the runtime image. This situation is expected to be very expectional. It requires that a ticket is to be opened with the Support department of eMagiz or Partner Support team.

29

30

Whenever this situation occurs, a user can navigate to the Deploy architecture of the model. The details of the specific runtime (right-click option) can be opened and a release can be selected. That release should be the previous release where the runtime was operating normally. Once selected, press Save and choose the Deploy Runtime option (right-click option) on machine level. This will force that specific runtime to load the previous docker image.

31

32

[[image:Main.Images.Microlearning.WebHome@assessing_impact_runtime_images_disaster_recovery.png]]

=== 3.4 Approach ===

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.

== 4. Assignment ==

Take a look at the release notes in the eMagiz Portal to ensure you know where to look.

41

42

== 5. Key takeaways ==

43

44

* Keep as close to the latest buildnumber as possible for the entire environment

45

* The best option is to have the entire environment run on the same buildnumber

46

* A mix of buildnumbers in a runtime is not a good plan - conflicting behaviors may occur.

47

* Read the release notes for builnumbers carefully to assess the impact - in case the impact is minimal proceed with the upgrade

48

* Make the buildnumber upgrades planable so the release schedule takes these actions into account.

49

50

== 6. Suggested Additional Readings ==

51

52

If you are interested in this topic and want more information on it, please read the release notes provided by eMagiz

53

54

== 7. Silent demonstration video ==

55

56

There is no video available as this is more a theoretical microlearning.)))((({{toc/}}))){{/container}}{{/container}}

Wiki source code of Impact of Runtime image upgrades

Navigation