Skip to Content
Last modified by Erik Bakker on 2026/04/21 12:15
From version 149.1
edited by Erik Bakker
on 2026/04/21 12:04
Change comment: There is no comment for this version
To version 57.1
edited by eMagiz
on 2023/02/07 11:42
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Install Docker for Windows
1 +On-premise Install Guide
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ebakker
1 +XWiki.eMagiz
Content
... ... @@ -1,5 +1,5 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -In eMagiz's current runtime architecture, Docker technology is utilized to deploy runtimes efficiently. eMagiz provides specific runtime images that can be deployed within dockerized environments. This section outlines the steps needed to prepare a Windows server for the installation of the eMagiz Deploy Agent, which is responsible for downloading these images from the eMagiz infrastructure.
2 +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.
3 3  
4 4  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
... ... @@ -9,175 +9,196 @@
9 9  * Good understanding of eMagiz runtimes in general
10 10  
11 11  == 2. Key concepts ==
12 -In the current 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.
13 -
14 -In the below section the Windows variant is described in terms of how to prepare the server to allow the [[eMagiz Deploy Agent>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]] to be installed. That agent allows to download images from the eMagiz infrastructure.
15 -
12 +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.
13 +
14 +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.
15 +
16 16  == 3. On-premises deployments ==
17 17  
18 18  ===3.1 General requirements===
19 +
20 +These are the general requirements to allow the installation of the eMagiz Docker agent:
21 +* Ensure access to the following URLs is enabled
22 + ** registry.emagiz.com:8443
23 + ** controlplane.emagiz.com:8000
24 + ** Preferably the entry should be *.emagiz.com
19 19  
20 -{{info}}It is advised to use Docker version 29.1.3 as this is the version being used in the latest eMagiz cloud template. We advise aligning the on-premise Docker version and updating it according to the release notes of the [[Cloud templates>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]].
21 -{{/info}}
22 -
23 -{{info}}
24 -* Standard configuration to ensure that communication between your server and eMagiz to ensure communication.
25 - ** registry.emagiz.com:443
26 - ** controlplane.emagiz.com:443
27 - ** controlplane-agent.emagiz.com:443
28 - ** controltower.emagiz.com:443
29 - ** controltower.kpn-dsh.com:443
30 - ** controlbus.emagiz.com:443
31 - ** {yourcloudslotid}.emagizcloud.com:8443
32 32  
33 -* Preferably we suggest to implement the following entries on DNS level.
34 - ** *.emagizcloud.com
35 - ** *.emagiz.com
36 - ** *.kpn-dsh.com{{/info}}
27 +===3.2 Installation requirements Linux===
37 37  
38 -{{warning}}
39 -* When **your** requirements force the use of **IP Whitelisting**, the following configuration is needed to communicate with our infrastructure and the specific eMagiz model(s) to which you need to connect. These IP addresses are subject to periodic change on our end.
29 +* 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.
30 +* Install latest version of the Docker engine - see for instance this link below. For other Linux distributions similar install guides are available on this link.
40 40  
41 - ** 35.158.46.28:443
42 - ** 3.74.190.88:443
43 - ** 35.158.46.28:8443
44 - ** 3.74.190.88:8443
45 - ** 35.158.46.28:8444
46 - ** 3.74.190.88:8444
47 - ** 3.74.209.20:443
48 - ** 3.76.127.155:443
49 - ** 3.74.209.20:8443
50 - ** 3.76.127.155:8443
51 - ** 3.74.209.20:8444
52 - ** 3.76.127.155:8444
53 - ** 18.199.123.240
54 - ** 18.184.211.189
55 - ** 3.123.136.31{{/warning}}
32 +{{code}}https://docs.docker.com/engine/install/ubuntu/{{/code}}
56 56  
57 57  
35 + * Install the eMagiz Deploy agent
58 58  
59 -===3.2 Installation Windows===
60 -When Windows is selected as the operating system, you need Windows Server 2022. Older Windows servers are **not** supported.
37 +===3.3 Installation requirements Windows Server 2022===
61 61  
62 -==== 3.2.1 Docker Installation ====
63 -To install Docker on your machine, execute the following commands in PowerShell with administrative rights:
39 +These are the requirements to allow the installation of the eMagiz Docker agent:
40 +* Install latest version of Docker Desktop from {{code}}https://www.docker.com/products/docker-desktop/{{/code}}
41 +* Validate if WSL 2.0 is properly installed
42 +* Go to the next section around installing the eMagiz Docker agent
64 64  
44 +===3.3 Installation requirements Windows Server 2022 (without Docker Desktop) ===
45 +
46 +**Step 1: Install linux distribution**
47 +
65 65  {{code language="cmd"}}
66 -Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Install-update-docker/install-update-docker.ps1" -o install-update-docker-ce.ps1
67 -.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
49 + wsl --install -d Ubuntu
50 + sudo apt-get update
51 + sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
52 + . /etc/os-release
68 68  {{/code}}
69 69  
70 -==== 3.2.2 Customization ====
71 71  
72 -After installing Docker, you can stick with the standard configuration or adjust specific settings. Settings that can be of particular interest include the one that defines the IP address range your Docker installation will use to run containers, and the one that defines where to store data (i.e., containers and images). To check the full list of compatible configuration options for Windows, you can check: [[Configure Docker in Windows>>https://learn.microsoft.com/en-us/virtualization/windowscontainers/manage-docker/configure-docker-daemon||target="blank"]].
56 +**Step 2: Install Docker **
73 73  
74 -{{warning}}Be aware that the customization will only take effect once you have restarted the machine.{{/warning}}
75 -
76 -===== 3.2.2.1 IP address range =====
77 -
78 -Below is the code needed to configure a different IP address range.
79 -
80 80  {{code language="cmd"}}
81 -cd C:\ProgramData\Docker\config\daemon.json
82 -#Add the following lines
83 -{"fixed-cidr": "<ip-address>"}
59 + curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
60 + echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
61 + sudo apt update
62 + sudo apt install docker-ce docker-ce-cli containerd.io
84 84  {{/code}}
85 85  
86 -===== 3.2.2.2 Data location =====
87 -
88 -Below is an example of switching from the default C directory ({{code language="cmd"}}c:\programdata\docker{{/code}}) to the D directory to store Docker data. Based on your internal configuration, you can choose the best suitable variant if needed. To do so, you can add the following attribute to the Docker daemon file:
65 +{{info}}
66 + Requires ~335 Mb space to install
67 +{{/info}}
89 89  
69 +**Step 3: Install Java **
70 +
90 90  {{code language="cmd"}}
91 -cd C:\ProgramData\Docker\config\daemon.json
92 -#Add the following lines
93 -{
94 - "data-root": "d:\\docker"
95 -}
72 + wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
73 + 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
74 + sudo apt update # update if you haven't already
75 + sudo apt install temurin-8-jdk
96 96  {{/code}}
97 97  
98 -{{warning}}Note that when you want to create multiple customizations to your configuration, the result in the daemon.json file should be a **valid** JSON structure{{/warning}}
78 +{{info}}
79 + Requires ~335 Mb space to install
80 +{{/info}}
99 99  
100 -==== 3.2.3 Check installation ====
82 +**Step 4: Ensure Docker is autostarted with WSL **
101 101  
102 -After executing the commands above, the server will restart if required. After the restart, execute the following command
103 -
104 104  {{code language="cmd"}}
105 -docker ps
85 +nano .bashrc
86 +
87 + #Add following lines to bashrc
88 + DOCKER_DISTRO="Ubuntu"
89 + DOCKER_LOG_DIR=$HOME/docker_logs
90 + mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
91 + /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
106 106  {{/code}}
107 107  
108 -If the command returns "command not found," please run the following command again.
94 +**Step 5: Add user to Docker group **
109 109  
110 110  {{code language="cmd"}}
111 -.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
97 +sudo visudo
98 +
99 + #Add following lines
100 +
101 + # Don't ask for password
102 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
112 112  {{/code}}
113 113  
114 -==== 3.2.3 Verify Docker functionality ====
105 +**Step 6: Update wsl config file **
106 +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
115 115  
116 -Execute the following command
108 +First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
117 117  
110 +
118 118  {{code language="cmd"}}
119 -docker ps
112 + #Add following lines
113 +
114 + # Settings apply across all Linux distros running on WSL 2
115 + [wsl2]
116 + # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
117 + memory=16GB
118 + # Sets the VM to use two virtual processors
119 + processors=2
120 120  {{/code}}
121 121  
122 -The result of this call should show the following:
122 +
123 +**Step 7: Auto start the linux subsystem when server restarts **
124 +
123 123  
124 -[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
126 +===3.4 Installation requirements Windows Server 2019 version >1806===
125 125  
126 -==== 3.2.4 Install eMagiz Deploy Agent ====
128 +These are the requirements to allow the installation of the eMagiz Docker agent:
129 +* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
130 +* Validate if WSL 2.0 is properly installed
131 +* Go to the next section around installing the eMagiz Docker agent
127 127  
128 -Install the eMagiz Deploy agent as described in this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
133 +===3.5 Installation requirements Windows Server 2019 version 1806===
129 129  
130 -=== 3.3 Update Docker ===
131 -When you are advised to update your Docker version, you can verify whether you are on the correct Docker version by executing the following command in PowerShell with administrative rights:
135 +These are the requirements to allow the installation of the eMagiz Docker agent:
136 +* Enable Hyper-V in Windows Server
137 + ** 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.
138 + ** Restart windows
139 +* Cross check is WSL 2.0 is installed
140 + ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
141 +* Install Docker Desktop on the Windows Server
142 + ** Please refer to this link: https://www.docker.com/products/docker-desktop/
143 + ** Restart windows
144 +* Update Docker Desktop configuration
145 + ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
146 + ** Restart Docker
147 +* Open Powershell as Administrator
148 + ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
149 + ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
150 + ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
151 + ** Execute Add-AppxPackage .\ubuntu-2004.appx
152 + *** 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.
153 +* Ubuntu should now be a runnable program (press windows key, type ubuntu)
154 +* Open the ubuntu terminal, and finish the installation.
155 + ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
156 +* Go to the next section around installing the eMagiz Docker agent
132 132  
133 -{{code language="cmd"}}
134 -docker version
135 -{{/code}}
158 +===3.6 Installation requirements Windows Server 2012 R2 ===
136 136  
137 -When this returns a version **lower** than the advised version shown under the "General requirements" section, you can update Docker on your machine. To do so, execute the following command in PowerShell with administrative rights:
160 +These are the requirements to allow the installation of the eMagiz Docker agent:
161 +* Install & enable Hyper-V in Windows Server
162 + ** 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.
163 + ** Restart windows
164 +* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
165 +* Create a VM in HyperV.
166 + ** 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).
167 + ** Configure a virtual switch.
168 + ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
169 + ** Install an operating system from bootable CD/DVD, ISO file
170 +* Install ubuntu downloaded previously on the VM
171 +* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
172 +* Go to the next section around installing the eMagiz agent
138 138  
139 -{{code language="cmd"}}
140 -.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
141 -{{/code}}
174 +=== 3.7 eMagiz Docker agent installation ===
142 142  
143 -{{warning}}It may happen that, due to the update, your containers are no longer starting up. To resolve this, please restart the containers, which can be done via a deployment plan or the deploy architecture.{{/warning}}
176 +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.
144 144  
145 -===3.4 Uninstall Docker===
146 -To uninstall Docker from your machine, execute the following commands in PowerShell with administrative rights:
178 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
147 147  
148 -{{code language="cmd"}}
149 -Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Uninstall-docker/uninstall-docker.ps1" -o uninstall-docker-ce.ps1
150 -{{/code}}
180 +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.
151 151  
152 -Example usage:
182 +== 4. Assignment ==
153 153  
154 -{{code language="cmd"}}
155 -.\uninstall-docker-ce.ps1
156 -{{/code}}
184 +Check out the cheatcheet for Docker command line:
157 157  
158 -== 4. Key takeaways ==
186 +[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
159 159  
160 -* eMagiz uses runtime images to deploy the eMagiz runtime on Dockerized environments. The runtime image holds all the information and components required to run the runtime
188 +== 5. Key takeaways ==
189 +
190 +* 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
161 161  * eMagiz has a specific agent that manages the download of that image to the on-premises server
162 -* The firewall of the on-premises environment should allow outgoing traffic without any restrictions. If that is not desirable, eMagiz can provide the addresses and ports needed to set up the appropriate firewall rules.
192 +* 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.
163 163  
164 -== 5. Suggested Additional Readings ==
165 165  
166 -* [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
167 -** [[eMagiz Runtime Generation 3 (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]]
168 -* [[Release Information (Menu)>>doc:Main.Release Information.WebHome||target="blank"]]
169 -** [[Environment Templates (Navigation)>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]]
170 -* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
171 -** [[eMagiz Runtime Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome||target="blank"]]
172 -*** [[Interpret on-premise logging (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-interpret-on-premise-logging.WebHome||target="blank"]]
173 -*** [[eMagiz Deploy agent (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
174 -* [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]
175 -** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.WebHome||target="blank"]]
176 -*** [[Impact of Runtime Image Upgrades (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.advanced-lifecycle-management-impact-of-runtime-image-upgrades.WebHome||target="blank"]]
177 -* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
178 -** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome||target="blank"]]
179 -*** [[Install Docker for Linux (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-onpremises-server-linux-installguide.WebHome||target="blank"]]
180 -* [[Install Docker (Search Result)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=install+docker||target="blank"]]
181 -* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
182 182  
196 +== 6. Suggested Additional Readings ==
197 +
198 +N/A
199 +
200 +== 7. Silent demonstration video ==
201 +
202 +N/A
203 +
183 183  )))((({{toc/}}))){{/container}}{{/container}}