Skip to Content

eMagiz Runtime Generation 3

Last modified by Erik Bakker on 2024/08/08 15:48

This fundamental intends to share some valuable insights about the evolution of eMagiz from a local, on-premises deployment platform to a cloud-first platform. The text below delves into the transition from Generation 1 runtime to Generation 3, highlighting the utilization of Spring Boot framework, Docker technology, and the impact on the way of working.

Should you have any questions, please get in touch with academy@emagiz.com.

1. Prerequisites

  • Advanced knowledge of the eMagiz platform

2. Key concepts

The first thing to consider is the eMagiz runtime. This is the Java based application container where the generated code of eMagiz flows is deployed and put into operation. That runtime is something you can download in the Deploy -> Containers section as a zipfile, and make active on your local laptop or machine. The way to invoke the Java application container is to execute the karaf.bat (which refers to the framework we use for that). For runtimes that are deployed, the karaf.bat is the executable refered in the services of the DMZ server of the client.

This runtime play a core role in the next generation architecture.

3. Overview of the Generation 3 runtime

3.1 History of runtime

In the last few years, eMagiz has evolved from a local, on-premises deployment platform to a cloud-first platform. At the inception of the eMagiz runtime, we provided a process that could only run locally on a (dedicated) server of clients. We refer to that as Generation 1 runtime. With the requirement to deploy eMagiz runtime in the Cloud, we updated the runtime to Generation 2, including the OSGI and Karaf framework that allowed remote running runtimes. Our next step, explained below, is then referred to as Generation 3.

3.2 Spring Boot framework

The ambition of eMagiz is to work towards serverless Cloud environments where the eMagiz runtime can be made operational. A bigger portion of our platform leverages the Spring Integration framework, and the Spring Boot framework provides the required components to form a Java-based application container that can run on Docker technology. It was, therefore, logical to migrate the existing runtime to that framework, making OSGI and Karaf obsolete. Furthermore, the Spring Boot framework provides a means to measure many more things in the context of log entries and runtime metrics.

3.3 Docker technology

A more modern technology than traditional servers is using Docker containers. Docker provides containers that mimic servers in a specific way. A container is a standard unit of software that packages up code and all its dependencies so the application runs quickly and reliably from one computing environment to another. A Docker container image is a lightweight, standalone, executable package of software that includes everything needed to run an application: code, runtime, system tools, system libraries, and settings.

Container images become containers at runtime, and in the case of Docker containers, images become containers when they run on Docker Engine. From eMagiz, we provide images that represent the code that processes your messages. As Docker is agnostic in terms of OS, the solution can run in our cloud and on-premise on both Linux—and Windows-based servers. Containers isolate software from its environment and ensure that it works uniformly despite differences, for instance, between development and staging.

The eMagiz runtime can run inside a Docker, and it is made part of the Docker image. You will find other required pieces in the Docker image, such as the OS, Java, monitoring services, and more.

fundamental-runtime-generation3-2.png

Information

More information on the installation process of on-premise Docker on Linux can be found here. More information on the install process of on-premise Docker on Windows can be found here.

3.4 Impact on Way of Working Gen2 vs. Gen3

Information

See the additional readings for more detailed information on these changes and how you can migrate from the current situation to the new situation.

  • Deployment Plan
    • The deployment has a new option called Deploy runtimes. These steps will be part of a default plan or can be added as a separate line. Effectively, once a runtime is deployed as part of a Docker image, the image needs to be loaded and executed. That means the current image, including all flows, will be replaced with a new one. This makes the deployment simple and fast. The option means that all runtime on a machine will be deployed in minutes.
  • Releases
    • The release functionality defines the Docker image. Setting the release means creating a new Docker image.
  • Deploy Architecture
    • You can see the running status of a Docker image at every runtime.  The Docker image can be switched on or off, and flows can't be selectively switched on or off.
  • Runtime Overview
    • This overview shows all runtimes and their corresponding status. This is a replacement for the Runtime Dashboard.
  • Properties
    • In the previous generation of runtime, properties were loaded at the runtime level (in a way). Updating a property meant stopping and starting a flow to effectuate the property change. Now, the properties are made part of the Docker image. That results in the necessity of creating a new release once a property is changed.
  • Build number
    • The notion of build numbers no longer exists in the new runtime. Or not so explicitly as before. The Docker image will load the required libraries when creating the runtime image and always use the latest.
        It is strongly advised that all flows be on the latest build number before migrating to the next generation.
  • Error handling
    • The error handling on the flow level will change compared to the current generation. For the new generation, we will offer two options.
      • Default error handling -> eMagiz will receive the errors and show them in the Manage Dashboard
      • Custom error handling -> We have two separate options that allow you to send the error message to a custom solution and eMagiz or only to the custom solution.
        • Including sending it to eMagiz
        • Without sending it to eMagiz
  • Hosted web services
    •  In the third-generation runtime, you will need to migrate your hosted web service to a new configuration. The following will change in this new configuration.
      • All-entry will be split into separate entries
      • WSDL will be automatically generated based on your system messages
      • HTTP configuration is taken out of the flow and moved to Deploy -> Architecture
      • Configuration of endpoints is streamlined better between cloud-hosted endpoints and on-premise endpoints
  • Handling local file communication
    • As our third-generation runtime uses Docker technology, your containers are, by default, closed off from their host. This makes them more secure, but it also means that additional configuration is needed when interaction needs to happen between the host and the deployed containers.

4. Key takeaways

  • Generation 3 runtime architecture has a series of consequences for user that need to be understood well
  • The new generation architecture is the current path towards serverless, and simplyfies deployment greatly for users.

5. Suggested Additional Readings