Skip to Content
Last modified by Erik Bakker on 2025/10/19 21:14
From version 141.1
edited by Erik Bakker
on 2025/10/19 21:14
Change comment: There is no comment for this version
To version 59.1
edited by eMagiz
on 2023/02/07 12:09
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,154 +9,205 @@
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 -{{info}}
21 -* Standard configuration to ensure that communication between your server and eMagiz to ensure communication.
22 - ** registry.emagiz.com:443
23 - ** controlplane.emagiz.com:443
24 - ** controlplane-agent.emagiz.com:443
25 - ** controltower.emagiz.com:443
26 - ** controltower.kpn-dsh.com:443
27 - ** controlbus.emagiz.com:443
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
28 28   ** Preferably the entry should be *.emagiz.com
29 - ** Preferably the entry should be *.kpn-dsh.com{{/info}}
30 30  
31 -{{warning}}
32 -* When using **IP Whitelisting**, the following configuration is needed to communicate to your JMS.
33 - ** 35.158.46.28:443
34 - ** 3.74.190.88:443
35 - ** 35.158.46.28:8443
36 - ** 3.74.190.88:8443
37 - ** 35.158.46.28:8444
38 - ** 3.74.190.88:8444
39 - ** 3.74.209.20:443
40 - ** 3.76.127.155:443
41 - ** 3.74.209.20:8443
42 - ** 3.76.127.155:8443
43 - ** 3.74.209.20:8444
44 - ** 3.76.127.155:8444
45 - ** 18.199.123.240
46 - ** 18.184.211.189
47 - ** 3.123.136.31{{/warning}}
26 +
27 +===3.2 Installation requirements Linux===
48 48  
49 -===3.2 Installation Windows===
50 -Whenever Windows is selected as operating system, you need to have a Windows Server 2022 version. Older Windows servers are **not** supported.
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.
51 51  
32 +{{code}}https://docs.docker.com/engine/install/ubuntu/{{/code}}
52 52  
53 -==== 3.2.1 Docker Installation ====
54 -To install or update docker on your machine, execute the following commands in powershell with administrative rights:
55 55  
56 -{{code language="cmd"}}
57 -Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Install-update-docker/install-update-docker.ps1" -o install-update-docker-ce.ps1
58 -.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
59 -{{/code}}
35 +* Install the eMagiz Deploy agent
60 60  
61 -{{info}}It is advised to use Docker version 24.0.7 as this is the version being used in the latest eMagiz cloud template. We advise to align the on-premise Docker version and update it according to the release notes of the [[Cloud templates>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]].
62 -{{/info}}
37 +===3.3 Installation requirements Windows Server 2022 (Docker Desktop)===
63 63  
64 -==== 3.2.2 Customization ====
39 +{{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
65 65  
66 -After installing Docker you have the option to stick with the standard configuration of Docker or you can opt to alter some specific settings. Settings that can be of particular interest are the setting that defines the IP address range your Docker installation will use to run the containers and the setting 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"]].
41 +These are the requirements to allow the installation of the eMagiz Docker agent:
42 +* Install latest version of Docker Desktop from
67 67  
68 -{{warning}}Be aware that the customization will only take effect once you have restarted the machine.{{/warning}}
44 +{{code}}https://www.docker.com/products/docker-desktop/{{/code}}
69 69  
70 -===== 3.2.2.1 IP address range =====
71 -
72 -Below you can find the code necessary to configure a different IP address range.
46 +* Validate if WSL 2.0 is properly installed
47 +* Install the eMagiz Deploy agent
73 73  
49 +===3.3 Installation requirements Windows Server 2022 (without Docker Desktop) ===
50 +
51 +{{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
52 +
53 +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).
54 +
55 +**Step 1: Install linux distribution**
56 +
74 74  {{code language="cmd"}}
75 -cd C:\ProgramData\Docker\config\daemon.json
76 -#Add following lines
77 -{"fixed-cidr": "<ip-address>"}
58 + wsl --install -d Ubuntu
59 + sudo apt-get update
60 + sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
61 + . /etc/os-release
78 78  {{/code}}
79 79  
80 -===== 3.2.2.2 Data location =====
81 -
82 -Below you can find an example of switching from the default C directory ({{code language="cmd"}}c:\programdata\docker{{/code}}) to the D directory to store data related to Docker. Based on your internal configuration you can choose the best suitable variant if that is needed. To do so you can add the following attribute to the Docker daemon file:
83 83  
65 +**Step 2: Install Docker **
66 +
84 84  {{code language="cmd"}}
85 -cd C:\ProgramData\Docker\config\daemon.json
86 -#Add following lines
87 -{
88 - "data-root": "d:\\docker"
89 -}
68 + curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
69 + echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
70 + sudo apt update
71 + sudo apt install docker-ce docker-ce-cli containerd.io
90 90  {{/code}}
91 91  
92 -{{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}}
74 +{{info}}
75 + Requires ~335 Mb space to install
76 +{{/info}}
93 93  
94 -==== 3.2.3 Check installation ====
78 +**Step 3: Install Java **
95 95  
96 -After executing the commands above, the server will restart if required. After the restart, execute the following command
80 +{{code language="cmd"}}
81 + wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
82 + 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
83 + sudo apt update # update if you haven't already
84 + sudo apt install temurin-8-jdk
85 +{{/code}}
97 97  
87 +{{info}}
88 + Requires ~335 Mb space to install
89 +{{/info}}
90 +
91 +**Step 4: Ensure Docker is autostarted with WSL **
92 +
98 98  {{code language="cmd"}}
99 -docker ps
94 +nano .bashrc
95 +
96 + #Add following lines to bashrc
97 + DOCKER_DISTRO="Ubuntu"
98 + DOCKER_LOG_DIR=$HOME/docker_logs
99 + mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
100 + /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
100 100  {{/code}}
101 101  
102 -If the command returns that the command cannot be found, please run the following command again.
103 +**Step 5: Add user to Docker group **
103 103  
104 104  {{code language="cmd"}}
105 -.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
106 +sudo visudo
107 +
108 + #Add following lines
109 +
110 + # Don't ask for password
111 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
106 106  {{/code}}
107 107  
108 -==== 3.2.3 Verify docker functionality ====
114 +**Step 6: Update wsl config file **
115 +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
109 109  
110 -Execute the following command
117 +First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
111 111  
119 +
112 112  {{code language="cmd"}}
113 -docker ps
121 + #Add following lines
122 +
123 + # Settings apply across all Linux distros running on WSL 2
124 + [wsl2]
125 + # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
126 + memory=16GB
127 + # Sets the VM to use two virtual processors
128 + processors=2
114 114  {{/code}}
115 115  
116 -The result of this call should show the following:
131 +
132 +**Step 7: Auto start the linux subsystem when server restarts **
133 +
117 117  
118 -[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
135 +===3.4 Installation requirements Windows Server 2019 version >1806===
119 119  
120 -==== 3.2.4 Install eMagiz Deploy Agent ====
137 +These are the requirements to allow the installation of the eMagiz Docker agent:
138 +* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
139 +* Validate if WSL 2.0 is properly installed
140 +* Go to the next section around installing the eMagiz Docker agent
121 121  
122 -Install the eMagiz Deploy agent as can be found in this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
142 +===3.5 Installation requirements Windows Server 2019 version 1806===
123 123  
124 -===3.3 Uninstall Docker===
125 -To uninstall docker from your machine, execute the following commands in powershell with administrative rights:
144 +These are the requirements to allow the installation of the eMagiz Docker agent:
145 +* Enable Hyper-V in Windows Server
146 + ** 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.
147 + ** Restart windows
148 +* Cross check is WSL 2.0 is installed
149 + ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
150 +* Install Docker Desktop on the Windows Server
151 + ** Please refer to this link: https://www.docker.com/products/docker-desktop/
152 + ** Restart windows
153 +* Update Docker Desktop configuration
154 + ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
155 + ** Restart Docker
156 +* Open Powershell as Administrator
157 + ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
158 + ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
159 + ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
160 + ** Execute Add-AppxPackage .\ubuntu-2004.appx
161 + *** 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.
162 +* Ubuntu should now be a runnable program (press windows key, type ubuntu)
163 +* Open the ubuntu terminal, and finish the installation.
164 + ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
165 +* Go to the next section around installing the eMagiz Docker agent
126 126  
127 -{{code language="cmd"}}
128 -Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Uninstall-docker/uninstall-docker.ps1" -o uninstall-docker-ce.ps1
129 -{{/code}}
167 +===3.6 Installation requirements Windows Server 2012 R2 ===
130 130  
131 -Example usage:
169 +These are the requirements to allow the installation of the eMagiz Docker agent:
170 +* Install & enable Hyper-V in Windows Server
171 + ** 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.
172 + ** Restart windows
173 +* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
174 +* Create a VM in HyperV.
175 + ** 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).
176 + ** Configure a virtual switch.
177 + ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
178 + ** Install an operating system from bootable CD/DVD, ISO file
179 +* Install ubuntu downloaded previously on the VM
180 +* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
181 +* Go to the next section around installing the eMagiz agent
132 132  
133 -{{code language="cmd"}}
134 -.\uninstall-docker-ce.ps1
135 -{{/code}}
183 +=== 3.7 eMagiz Docker agent installation ===
136 136  
137 -== 4. Key takeaways ==
185 +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.
138 138  
187 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
188 +
189 +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.
190 +
191 +== 4. Assignment ==
192 +
193 +Check out the cheatcheet for Docker command line:
194 +
195 +[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
196 +
197 +== 5. Key takeaways ==
198 +
139 139  * 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
140 140  * eMagiz has a specific agent that manages the download of that image to the on-premises server
141 141  * 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.
142 142  
143 -== 5. Suggested Additional Readings ==
144 144  
145 -* [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
146 -** [[eMagiz Runtime Generation 3 (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]]
147 -* [[Release Information (Menu)>>doc:Main.Release Information.WebHome||target="blank"]]
148 -** [[Environment Templates (Navigation)>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]]
149 -* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
150 -** [[eMagiz Runtime Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome||target="blank"]]
151 -*** [[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"]]
152 -*** [[eMagiz Deploy agent (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
153 -* [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]
154 -** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.WebHome||target="blank"]]
155 -*** [[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"]]
156 -* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
157 -** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome||target="blank"]]
158 -*** [[Install Docker for Linux (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-onpremises-server-linux-installguide.WebHome||target="blank"]]
159 -* [[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"]]
160 -* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
161 161  
205 +== 6. Suggested Additional Readings ==
206 +
207 +N/A
208 +
209 +== 7. Silent demonstration video ==
210 +
211 +N/A
212 +
162 162  )))((({{toc/}}))){{/container}}{{/container}}