Changes for page Install Docker for Windows

Last modified by Erik Bakker on 2025/10/19 21:14

From 63.1 to 62.1

From version 62.1

edited by eMagiz
on 2023/02/07 12:26

Change comment: There is no comment for this version

To version 1.1

edited by eMagiz
on 2022/06/24 14:38

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Title

@@ -1,1 +1,1 @@
--On-premise Install Guide
++On-premises deployment new runtime architecture

Content

@@ -1,200 +1,256 @@
  {{container}}{{container layoutStyle="columns"}}(((
--In this microlearning, we will focus on how the installation requirements for on-premises deployments of eMagiz runtimes that are part of the new runtime architecture. The new runtime architecture uses a containerized approach to deploy runtimes.
++In this microlearning, we will focus on how can stay in control of your integration landscape with the help of determining the needed memory footprint for your integration landscape.
++As your integration landscape changes over time the need for more (or less) memory is evident. Therefore it is crucial to know how you can determine the memory correctly.
  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
++* Last update: February 22th 2021
++* Required reading time: 13 minutes
++
  == 1. Prerequisites ==
  * Advanced knowledge of the eMagiz platform
--* Good understanding of eMagiz runtimes in general
  == 2. Key concepts ==
--In the new runtime architecture of eMagiz, Docker technology is used to deploy runtimes. eMagiz creates specific runtime images that contain the eMagiz runtime, and can be deployed in dockerized environments.
--
--In the below section the specific operating systems and versions are discussed in a sense that the prerequisite installations are described. Once the right installation is done, refer to section 3.7 for the installation of the eMagiz agent that manages the interaction with the eMagiz platform. That agent will download the created docker images that will be deployed in the Docker environment.
--
--== 3. On-premises deployments ==
--===3.1 General requirements===
--
--These are the general requirements to allow the installation of the eMagiz Docker agent:
--* Ensure access to the following URLs is enabled
--    ** registry.emagiz.com:8443
--    ** controlplane.emagiz.com:8000
--    ** Preferably the entry should be *.emagiz.com
++This microlearning centers around determining the memory that is needed to run your complete integration landscape.
++With memory, we mean: A collection of memory types (heap, native and direct) that are needed to properly run a runtime (Java Virtual Machine)
++With integration landscape we mean: A overview of all data integrations that are used to exchange data between systems
--
--===3.2 Installation requirements Linux===
++* eMagiz will help to determine the needed memory via the Design Architecture page.
++* eMagiz works with pre-determined sizes that are represented via an S, M, L, XL structure. Every size has a certain amount of memory available
++* When you exceed such a threshold you should upgrade (or downgrade) your memory in consultation with your partner manager
++* Overhead for OS and support functionality (auto-healing, alerting, monitoring) needs to be taken into account
++* The calculations and logic described below are applicable for the Messaging, API Gateway and Event Streaming pattern
--* Whenever Linux is selected as operating system, the latest version of Ubuntu will work. Other Linux distributions will also work such as Debian or Red Hat.
--* Follow all steps in section 3.4
--* Install the eMagiz Deploy agent
--===3.3 Installation requirements Windows Server 2022 ===
++== 3. Determining Needed Memory ==
--{{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
++One of the key aspects of running a stable eMagiz solution is proper management of the needed memory to run all your integrations within your integration landscape.
++To determine what is needed you get help from eMagiz in Design Architecture.
++In the Design Architecture eMagiz tells you based on our calculations what the recommended sizing of a **machine** should be.
++If this deviates from what is configured you should take a closer look at whether you indeed need more memory.
--The steps below will install a linux subsystem under Windows. In that Linux system, Docker and Java will be installed. Please note that the Windows server needs to be able to run Virtualized (either via BIOS setting or via Nested Virtualization).
++=== 3.1 The calculation of eMagiz ===
--**Step 1: Install linux distribution**
++In this section, we will delve into that recommendation to explain to you how you should interpret this recommendation so you can make the correct determination of how much memory is needed.
--{{code language="cmd"}}
--  wsl --install -d Ubuntu
--  sudo apt-get update
--  sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
--  . /etc/os-release
--{{/code}}
++To calculate the memory eMagiz has determined that the flows that are running on the runtimes make up most of the memory.
++To calculate how much memory a single flow uses on average eMagiz uses several assumptions. These assumptions are the foundation of the recommended memory size by eMagiz.
--**Step 2: Configure linux system**
--Please see section 3.4 for these these steps
--
--**Step 3: Update wsl config file **
--In this step we need to add or update the WSL config file that manages the resources of the Linux subsystem. Important resources to manage are the assigned memory and number of processors. For memory we recommend to review the mempory settings for the runtime that need to run on this server and add 762 MB to the total value of the heap and non-heap of these runtimes. For processor we recommend to set the value to 2 - depending on the amount of processors available on that machine
++* Limited use of 'non-standard' flows. So, are the number of components within a flow comparable to the 'standard' setup (i.e. an autogenerated onramp).
++* Average message size of less than 100KbSize van de berichten
++* Standard number of consumers
++* Use of Java extensions such as Groovy Scripts
++* Limited use of complex transformations
++* Limited use of Xpath and SpEL expression related to large messages
--First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
++As long as you do not deviate from the above assumptions at all or not too much the recommended sizing of eMagiz should work for you.
--{{code language="cmd"}}
--  #Add following lines
--
--  # Settings apply across all Linux distros running on WSL 2
--  [wsl2]
--  # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
--  memory=16GB
--  # Sets the VM to use two virtual processors
--  processors=2
--{{/code}}
++Based on the above assumption we made thresholds for the number of flows.
++If you pass a threshold (i.e. 50 flows) the recommended size of that runtime and therefore the machine the runtime is running on will increase.
--
--**Step 4: Auto start the linux subsystem when Windows server restarts **
--
++All thresholds that are used by eMagiz can be found in the help text of eMagiz when checking the size status.
--===3.4 Installation steps to configure Linux subsystem ===
--
--**Step 1: Install Docker **
++On top of the calculation of needed memory based on the number of flows eMagiz also accounts for the following 'overhead'
--{{code language="cmd"}}
--  curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
--  echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
--  sudo apt update
--  sudo apt install docker-ce docker-ce-cli containerd.io
--{{/code}}
++* OS
++* Support functionality (auto-healing, alerting on infrastructure, monitoring on infrastructure)
++* Buffer
--{{info}}
-- Requires ~335 Mb space to install
--{{/info}}
++For JMS processes the default is 500MB heap and 152MB non-heap.
++In most cases, there is no reason to deviate from this number until you reach a lot of throughput on a lot of flows.
--**Step 2: Install Java **
++=== 3.2 Check size status ===
--{{code language="cmd"}}
--  wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
--  echo "deb https://packages.adoptium.net/artifactory/deb $(awk -F= '/^VERSION_CODENAME/{print$2}' /etc/os-release) main" | sudo tee /etc/apt/sources.list.d/adoptium.list
--  sudo apt update # update if you haven't already
--  sudo apt install temurin-8-jdk
--{{/code}}
++Now that we know how eMagiz calculates the needed memory based on the number of flows and certain categories of overhead we can turn our attention to the eMagiz tooling itself.
++In eMagiz, in Design Architecture you can check the recommended size status given by eMagiz.
--{{info}}
-- Requires ~335 Mb space to install
--{{/info}}
++[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-determining-needed-memory--check-size-status.png]]
--**Step 3: Ensure Docker is autostarted with WSL **
++Selecting this option will lead you to the following pop-up
--{{code language="cmd"}}
--nano .bashrc
++[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-determining-needed-memory--check-size-status-pop-up.png]]
--  #Add following lines to bashrc
--	DOCKER_DISTRO="Ubuntu"
--	DOCKER_LOG_DIR=$HOME/docker_logs
--	mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
--	/mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
--{{/code}}
++In this pop-up you see the calculation split up into three categories:
--**Step 4: Add user to Docker group **
++* Required heap memory
++* Required non-heap (native) memory
++* Required overhead
--{{code language="cmd"}}
--sudo visudo
++==== 3.2.1 Required overhead ====
--  #Add following lines
++The first segment we are going to take a look at is the required overhead. Under this category fall the following characteristics:
--  # Don't ask for password
--  %docker ALL=(ALL)  NOPASSWD: /usr/bin/dockerd
--{{/code}}
++* OS
++* Support functionality (auto-healing, alerting on infrastructure, monitoring on infrastructure)
++* Buffer
--
++Each of these characteristics has a pre-determined setting that we recommend for the proper working of eMagiz.
++We reserve 712MB for the OS, 50MB for the Support functionality, and a Buffer of 100MB **per** active runtime on a machine.
++If we tally this up for our example we end up with 962MB of overhead. Just as you can see in the pop-up:
--===3.5 Installation requirements Windows Server 2019 version 1806===
++[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-determining-needed-memory--check-size-status-pop-up-required-overhead.png]]
--{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
++==== 3.2.2 Required heap memory ====
--These are the requirements to allow the installation of the eMagiz Docker agent:
--* Enable Hyper-V in Windows Server
--  ** Go to Server Manager, Manage (top right), enable roles and features, select the desired roles and server selections. In the Features section, enable Hyper-V.
--  ** Restart windows
--* Cross check is WSL 2.0 is installed
--  ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
--* Install Docker Desktop on the Windows Server
--  ** Please refer to this link: https://www.docker.com/products/docker-desktop/
--  ** Restart windows
--* Update Docker Desktop configuration
--  ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
--  ** Restart Docker
--* Open Powershell as Administrator
--  ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
--  ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
--  ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
--  ** Execute Add-AppxPackage .\ubuntu-2004.appx
--    *** If errors occur, please consult https://learn.microsoft.com/en-us/windows/wsl/install-on-server. Rename the file to a zip, expand it, and add it to the path variable.
--* Ubuntu should now be a runnable program (press windows key, type ubuntu)
--* Open the ubuntu terminal, and finish the installation.
--  ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
--* Go to the next section around installing the eMagiz Docker agent
++As explained before the amount of memory needed is determined by the number of flows that are designed within your integration landscape.
++In eMagiz the memory allocation is divided into two parts:
--===3.6 Installation requirements Windows Server 2012 R2 ===
++* Heap memory
++* Native (non-heap) memory
--{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
++The heap memory is used to process messages and can be cleaned up via the garbage collection process.
++The native memory is used to start up your flows and keep them running. This part of the memory is allocated and not released in the same way as with heap memory.
--These are the requirements to allow the installation of the eMagiz Docker agent:
--* Install & enable Hyper-V in Windows Server
--  ** Go to Server Manager, Manage (top right), enable roles and features, select the desired roles and server selections. In the Features section, enable Hyper-V.
--  ** Restart windows
--* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
--* Create a VM in HyperV.
--  ** For this, choose Generation 1, the amount of memory you want to assign to ubuntu and thus to the containers. Please consider the overhead for memory as well (such as OS).
--  ** Configure a virtual switch.
--  ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
--  ** Install an operating system from bootable CD/DVD, ISO file
--* Install ubuntu downloaded previously on the VM
--* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
--* Go to the next section around installing the eMagiz agent
++To make it clear for you how much of which type of memory is needed we have split up the calculation into two portions.
++One for the required heap memory and the other for the required non-heap (native) memory.
--=== 3.7 eMagiz Docker agent installation ===
++Both are derived from the number of flows that are designed in your integration landscape. In our example, we have one JMS and one process container, and a total of 29 flows.
++This leads to the following calculation on heap memory:
--eMagiz needs to install a specific agent in the Docker instance that allows to download runtime images that needs to be installed on the Docker instance. The specific command to run inside the Docker instance is specific for the machine that is configured inside eMagiz Design & Deploy Architectures. It can be found inside the eMagiz iPaaS portal under Deploy Architecture. At the runtime connector, there is a right click option called Deploy Agent. That presents either the command or the location where that agent is installed.
++500 (JMS) + 580 (Process Container) = 1080MB. This is once again the same as what is calculated under check size status
--[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
++[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-determining-needed-memory--check-size-status-pop-up-required-heap-memory.png]]
--After installing the agent, you can use the Docker cheat sheet below to see if the docker containers are running and/or images are available.
++==== 3.2.3 Required non-heap memory ====
--== 4. Assignment ==
++The third part of the equation is the amount of non-heap memory that is required to run your eMagiz solution. Once again the starting point is the number of flows. In this case 29 flows.
++This leads to the following calculation on non-heap memory:
--Check out the cheatcheet for Docker command line:
++152 (JMS) + 792 (Process Container = 944MB. This is the same as what is calculated under check size status
--[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
++[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-determining-needed-memory--check-size-status-pop-up-required-non-heap-memory.png]]
++==== 3.2.4 Total recommended memory ====
++
++When you sum up these three values you arrive at the recommended size based on the current state of your Design.
++So when your Design is not representative of the truth the calculation will neither be a correct representation of the truth.
++
++In this case the total recommended memory will be:
++
++962 + 1080 + 944 = 2986MB
++
++[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-determining-needed-memory--check-size-status-pop-up-recommended-sizing.png]]
++
++=== 3.3 Comparison ===
++
++Now that we know the recommended sizing of eMagiz we can compare this to the sizing that is allocated based on the contractual agreements between eMagiz and you.
++This is the last segment of the check Size Status information in Design. In this segment you see:
++
++* The recommended size
++* The allocated size
++* The difference between recommended and allocated
++
++[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-determining-needed-memory--check-size-status-pop-up-comparison.png]]
++
++So in this example, we still have 1110MB left on our machine. If the number at the bottom would indicate that you need more size than is allocated at the moment you should take action.
++
++=== 3.4 Taking Action ===
++
++Based on this information it is time to take action. Taking action is foremost validating the calculation as given by eMagiz.
++As said before we assume certain things and based on whether part of those assumptions, all of them or none of them are met the result could differ.
++
++In this section, we will discuss some combinations and the appropriate action based on these combinations.
++
++==== 3.4.1 Valid Assumptions + Correct nr. of flows ====
++
++The first combination is the easiest of them all. This combination states that all assumptions that eMagiz has done hold truth.
++If so, trust the calculations of eMagiz and ensure that there is enough allocated room based on the recommended size by eMagiz.
++
++==== 3.4.2 Valid Assumptions + Incorrect nr. of flows ====
++
++We see a growing number of projects that have a myriad of process containers with the consequence that the assumption that all process containers run the same flows does not hold anymore.
++In these cases, you should adjust the calculations for the heap and non-heap memory allocation yourself based on the actual number of flows.
++
++If the result of that calculation still says that there is not enough room please allocate more room based on that altered calculation.
++To help you perform that calculation yourself we have devised two tables that you can use to come up with the correct values for both heap and non-heap.
++
++The table shown below is relevant for process containers on the CORE machines.
++
++| Nr. Flows | Heap | Non-heap |
++|   0-10    | 500  |   472    |
++|   11-20   | 500  |   552    |
++|   21-50   | 580  |   792    |
++|   51-75   | 820  |   992    |
++|  76-100   | 820  |   1192   |
++|  101-150  | 1220 |   1592   |
++
++The table shown below is relevant for connectors on the CONNECTOR machines.
++
++| Nr. Flows | Heap | Non-heap |
++|    0-5    | 500  |   152    |
++|   6-10    | 500  |   192    |
++|   11-15   | 500  |   232    |
++|   16-20   | 500  |   272    |
++|   21-25   | 580  |   312    |
++|   26-30   | 580  |   352    |
++|   31-35   | 580  |   392    |
++|   36-40   | 580  |   432    |
++|   41-45   | 580  |   472    |
++|   46-50   | 580  |   512    |
++|   51-55   | 820  |   552    |
++|   56-60   | 820  |   592    |
++|   61-65   | 820  |   632    |
++|   66-70   | 820  |   672    |
++|   71-75   | 820  |   712    |
++|  76-100   | 820  |   912    |
++
++==== 3.4.3 Incorrect Assumptions ====
++
++When you deviate from the assumptions made by eMagiz to determine the sizing
++you should start from scratch and determine how much you roughly deviate from the standard assumptions.
++
++Based on that estimate you should increase the heap and non-heap memory accordingly.
++This won't have any effect on the calculations for the overhead so they will stand.
++For example, when you deviate from the assumptions in a little way you could think of selecting the memory settings that are determined for one level higher.
++
++If you deviate a lot from the assumptions you should increase more drastically and test your solutions on the performance based on the expected throughput.
++
++=== 3.5 Configure the size ===
++
++Now that we know what the size should be, either by following the eMagiz calculation
++or by calculating the correct numbers ourselves with the help of components of the eMagiz calculation we can configure the size.
++
++To configure the size you enter Start Editing Mode in Design Architecture
++
++[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-determining-needed-memory--design-architecture-start-editing-mode.png]]
++
++While you are in Start Editing Mode you can alter the configured size of your eMagiz cloud machines to ensure that enough memory is available for the processes running on that machine.
++You can easily do so by switching around between S, M, L, XL, and XXL on machine level with the help of the arrows.
++After you have altered the size you can verify whether the change was enough by comparing
++it to the recommended size which is shown beside the configured size, by opening the Check Size Status pop-up for conformation or by comparing your calculation to the newly allocated memory.
++
++In case there is room left you have scaled accordingly. If there still is extra room required you should move another level up until you reach the desired level.
++
++
++
++== 4. Assignment ==
++
++Do your calculation based on what we learned in this microlearning and compare the solution to what eMagiz suggests under Check Size Status
++This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
++
  == 5. Key takeaways ==
--* eMagiz uses runtime images to deploy emagiz runtime on dockerized environments. The runtime image holds all the information and components required to run the runtime
--* eMagiz has a specific agent that manages the download of that image to the on-premises server
--* The firewall of the on-premises environment should allow outgoing traffic without any restriction. In case that is not desirable, eMagiz can provide the addresses and ports needed to setup the right firewall rules.
++* eMagiz will help to determine the needed memory via the Design Architecture page.
++* eMagiz works with pre-determined sizes that are represented via an S, M, L, XL structure. Every size has a certain amount of memory available
++* When you exceed such a threshold you should upgrade (or downgrade) your memory in consultation with your partner manager
++* Overhead for OS and support functionality (auto-healing, alerting, monitoring) needs to be taken into account
++* Calculating memory can be challenging. Always confer with others before taking action
++* You can compare your calculations with the calculations of eMagiz
++* The calculations and logic described below are applicable for the Messaging, API Gateway and Event Streaming pattern
  == 6. Suggested Additional Readings ==
--N/A
--
++If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
++
  == 7. Silent demonstration video ==
--N/A
++This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
++{{video attachment="expert-solution-architecture-determining-needed-memory.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
++
  )))((({{toc/}}))){{/container}}{{/container}}

Changes for page Install Docker for Windows

Summary

Details

Navigation