Skip to Content
Last modified by Erik Bakker on 2025/04/18 13:54
From version 126.1
edited by Carlijn Kokkeler
on 2024/03/29 16:48
Change comment: There is no comment for this version
To version 93.1
edited by Carlijn Kokkeler
on 2023/12/07 11:23
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Install Docker for Windows
1 +Pre-requisite installation of on-premises server
Content
... ... @@ -10,122 +10,186 @@
10 10  
11 11  == 2. Key concepts ==
12 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 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 -
13 +
14 +In the below section the Windows and Linux variants are described in terms of how to prepare the server to allow the eMagiz Deploy agent to be installed. That agent allows to download images from the eMagiz infrastructure.
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.
19 +These are the general requirements to allow the installation of the eMagiz Docker agent:
20 +* Ensure access to the following URLs is enabled
22 22   ** registry.emagiz.com:443
23 23   ** controlplane.emagiz.com:8000
24 - ** controltower.kpn-dsh.com:443
25 25   ** Preferably the entry should be *.emagiz.com
26 - ** Preferably the entry should be *.kpn-dsh.com{{/info}}
27 27  
28 -{{warning}}
29 -* In case of a very strict firewall configuration, additional configuration is needed to communicate to the eMagiz infrastructure.
30 - ** controltower.emagiz.com:443
31 - ** controltower.kpn-dsh.com:443
32 - ** controlbus.emagiz.com:443
33 - ** controlplane.emagiz.com:443
25 +===3.2 Installation requirements Linux===
26 +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.
27 +**Step 1: Install linux distribution**
28 +Follow the relevant steps in section 3.4
34 34  
35 -* When using cloudslot number **equal to or below** 125, the following configuration is needed to communicate to your JMS.
36 - ** 35.158.46.28:443
37 - ** 3.74.190.88:443
38 - ** 35.158.46.28:8443
39 - ** 3.74.190.88:8443
40 - ** 35.158.46.28:8444
41 - ** 3.74.190.88:8444
30 +**Step 2: Install eMagiz Deploy Agent**
31 +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"]]
42 42  
43 -* When using a cloudslot number **above** 125, the following configuration is needed to communicate to your JMS.
44 - ** 3.74.209.20:443
45 - ** 3.76.127.155:443
46 - ** 3.74.209.20:8443
47 - ** 3.76.127.155:8443
48 - ** 3.74.209.20:8444
49 - ** 3.76.127.155:8444{{/warning}}
33 +===3.3 Installation requirements Windows Server 2022 ===
50 50  
51 -===3.2 Installation Windows===
52 -Whenever Windows is selected as operating system, you need to have a Windows Server 2022 version. Older Windows servers are **not** supported.
35 +{{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
53 53  
37 +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 54  
55 -==== 3.2.1 Docker Installation ====
56 -To install or update docker on your machine, execute the following commands in powershell with administrative rights:
39 +**Step 1: Install linux distribution**
57 57  
58 58  {{code language="cmd"}}
59 -Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Install-update-docker/install-update-docker.ps1" -o install-update-docker-ce.ps1
60 -.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
42 + wsl --install -d Ubuntu
43 + sudo apt-get update
44 + sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
45 + . /etc/os-release
61 61  {{/code}}
62 62  
63 -{{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"]].
64 -{{/info}}
48 +**Step 2: Configure linux system**
49 +Please see section 3.4 for these these steps
65 65  
66 -{{info}}
67 -By default the docker daemon configuration file is located in the docker data path at {{code language="cmd"}}C:\ProgramData\docker\config\daemon.json{{/code}}.
68 -To check the configuration options and compatible options with Windows you can check: [[Configure Docker in Windows>>https://learn.microsoft.com/en-us/virtualization/windowscontainers/manage-docker/configure-docker-daemon||target="blank"]].
51 +**Step 3: Update wsl config file **
52 +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
69 69  
70 -{{warning}}
71 -Ignore the Uninstall section as it is outdated (For Windows Server 2016), instead refer to the previous section to Uninstall docker
72 -{{/warning}}
54 +First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
73 73  
74 -**Example usage of the Docker daemon file**: You maybe want the Docker daemon to keep images and containers in an alternate path (D:
75 -drive for example). To do so you can add the following attribute to the Docker daemon file:
76 -
77 77  {{code language="cmd"}}
78 -{
79 - "data-root": "d:\\docker"
80 -}
57 + #Add following lines
58 +
59 + # Settings apply across all Linux distros running on WSL 2
60 + [wsl2]
61 + # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
62 + memory=16GB
63 + # Sets the VM to use two virtual processors
64 + processors=2
81 81  {{/code}}
82 82  
83 -If not specified, the default is {{code language="cmd"}}c:\programdata\docker{{/code}}.
67 +**Step 4: Auto start the linux subsystem when Windows server restarts **
84 84  
69 +{{code language="cmd"}}
70 +* Press Windows+R
71 +* Type shell:startup and press enter
72 +* Add or update file start_wsl.bat
73 +* Add following line into the document and save file
74 + * wsl sudo /usr/bin/dockerd
75 + {{/code}}
76 +
77 +**Step 5: Install eMagiz Deploy Agent**
78 +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"]].
79 +
80 +===3.4 Installation steps to configure Linux subsystem ===
81 +
82 +**Step 1: Install Docker **
83 +
84 +{{code language="cmd"}}
85 + curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
86 + echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
87 + sudo apt update
88 + sudo apt install docker-ce docker-ce-cli containerd.io
89 +{{/code}}
90 +
91 +{{info}}
92 + Requires ~335 Mb space to install
85 85  {{/info}}
86 86  
87 -==== 3.2.2 Check installation ====
95 +**Step 3: Ensure Docker is autostarted with WSL **
88 88  
89 -After executing the commands above, the server will restart if required. After the restart, execute the following command
97 +{{info}}
98 +This remark is valid for Windows based installations only
99 +{{/info}}
90 90  
91 91  {{code language="cmd"}}
92 -docker ps
102 +nano .bashrc
103 +
104 + #Add following lines to bashrc
105 + DOCKER_DISTRO="Ubuntu"
106 + DOCKER_LOG_DIR=$HOME/docker_logs
107 + mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
108 + /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
93 93  {{/code}}
94 94  
95 -If the command returns that the command cannot be found, please run the following command again.
111 +**Step 4: Add user to Docker group **
96 96  
97 97  {{code language="cmd"}}
98 -.\install-docker-ce.ps1
114 +sudo visudo
115 +
116 + #Add following lines
117 +
118 + # Don't ask for password
119 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
99 99  {{/code}}
100 100  
101 -==== 3.2.3 Verify docker functionality ====
122 +**Step 5: Ensure safe IP range for WSL **
102 102  
103 -Execute the following command
124 +{{info}}
125 +This remark is valid for Windows based installations only
126 +{{/info}}
104 104  
128 +This step ensures that the IP address range of the machine doesn't conflict with any IP address of the Linux subsystem. Below the recommended values depending on the range which can be filled in the value <ip-address> below:
129 +* 10.0.0.1/8
130 + ** advised value 10.25.0.1/16
131 +* 172.16.0.1/12
132 + ** advised value 172.16.0.1/16
133 +* 192.168.0.1/16
134 + ** advised value 192.168.0.1/16
135 +
105 105  {{code language="cmd"}}
106 -docker ps
137 +sudo nano /etc/docker/daemon.json
138 +
139 + #Add following lines
140 +
141 + {"bip": "<ip-address>"}
107 107  {{/code}}
108 108  
109 -The result of this call should show the following:
110 110  
111 -[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
145 +===3.5 Installation requirements Windows Server 2019 version 1806===
112 112  
113 -==== 3.2.4 Install eMagiz Deploy Agent ====
147 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
114 114  
115 -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"]]
149 +These are the requirements to allow the installation of the eMagiz Docker agent:
150 +* Enable Hyper-V in Windows Server
151 + ** 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.
152 + ** Restart windows
153 +* Cross check is WSL 2.0 is installed
154 + ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
155 +* Please follow the instructions for preparing a Windows 2022 installation in section 3.3
116 116  
117 -===3.3 Uninstall Docker===
118 -To uninstall docker from your machine, execute the following commands in powershell with administrative rights:
157 +{{info}}
158 + * Install Docker Desktop on the Windows Server
159 + ** Please refer to this link: https://www.docker.com/products/docker-desktop/
160 + ** Restart windows
161 +* Update Docker Desktop configuration
162 + ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
163 + ** Restart Docker
164 +* Open Powershell as Administrator
165 + ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
166 + ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
167 + ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
168 + ** Execute Add-AppxPackage .\ubuntu-2004.appx
169 + *** 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.
170 +* Ubuntu should now be a runnable program (press windows key, type ubuntu)
171 +* Open the ubuntu terminal, and finish the installation.
172 + ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
173 +* Go to the next section around installing the eMagiz Docker agent
174 +{{/info}}
119 119  
120 -{{code language="cmd"}}
121 -Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Uninstall-docker/uninstall-docker.ps1" -o uninstall-docker-ce.ps1
122 -{{/code}}
176 +===3.6 Installation requirements Windows Server 2012 R2 ===
123 123  
124 -Example usage:
178 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
125 125  
126 -{{code language="cmd"}}
127 -.\uninstall-docker-ce.ps1
128 -{{/code}}
180 +These are the requirements to allow the installation of the eMagiz Docker agent:
181 +* Install & enable Hyper-V in Windows Server
182 + ** 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.
183 + ** Restart windows
184 +* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
185 +* Create a VM in HyperV.
186 + ** 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).
187 + ** Configure a virtual switch.
188 + ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
189 + ** Install an operating system from bootable CD/DVD, ISO file
190 +* Install ubuntu downloaded previously on the VM
191 +* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
192 +* Go to the next section around installing the eMagiz agent
129 129  
130 130  == 4. Key takeaways ==
131 131