Skip to Content
Last modified by Erik Bakker on 2025/04/18 13:54
From version 128.1
edited by Carlijn Kokkeler
on 2024/09/03 09:48
Change comment: There is no comment for this version
To version 76.1
edited by eMagiz
on 2023/02/07 14:52
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
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.CarlijnKokkeler
1 +XWiki.eMagiz
Content
... ... @@ -10,139 +10,194 @@
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.
22 - ** registry.emagiz.com:443
19 +These are the general requirements to allow the installation of the eMagiz Docker agent:
20 +* Ensure access to the following URLs is enabled
21 + ** registry.emagiz.com:8443
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 all 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
50 +
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
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"]].
54 +First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
69 69  
70 -**Example usage of the Docker daemon file**: You maybe want the Docker daemon to keep images and containers in an alternate path (D:
71 -drive for example). To do so you can add the following attribute to the Docker daemon file:
72 -
73 73  {{code language="cmd"}}
74 -{
75 - "data-root": "d:\\docker"
76 -}
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
77 77  {{/code}}
78 78  
79 -If not specified, the default is {{code language="cmd"}}c:\programdata\docker{{/code}}.
67 +
68 +**Step 4: Auto start the linux subsystem when Windows server restarts **
80 80  
81 -{{/info}}
70 +{{code language="cmd"}}
71 +Press Windows+R
72 +Type shell:startup and press enter
82 82  
83 -==== 3.2.2 Check installation ====
74 + wsl sudo /usr/bin/dockerd
84 84  
85 -After executing the commands above, the server will restart if required. After the restart, execute the following command
76 + {{/code}}
86 86  
87 -{{code language="cmd"}}
88 -docker ps
89 -{{/code}}
78 +
79 +**Step 5: Install eMagiz Deploy Agent**
80 +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"]].
81 +
82 +
83 +===3.4 Installation steps to configure Linux subsystem ===
90 90  
91 -If the command returns that the command cannot be found, please run the following command again.
85 +**Step 1: Install Docker **
92 92  
93 93  {{code language="cmd"}}
94 -.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
88 + curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
89 + echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
90 + sudo apt update
91 + sudo apt install docker-ce docker-ce-cli containerd.io
95 95  {{/code}}
96 96  
97 -==== 3.2.3 Verify docker functionality ====
94 +{{info}}
95 + Requires ~335 Mb space to install
96 +{{/info}}
98 98  
99 -Execute the following command
98 +**Step 2: Install Java **
100 100  
101 101  {{code language="cmd"}}
102 -docker ps
101 + wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
102 + 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
103 + sudo apt update # update if you haven't already
104 + sudo apt install temurin-8-jdk
103 103  {{/code}}
104 104  
105 -The result of this call should show the following:
107 +{{info}}
108 + Requires ~335 Mb space to install
109 +{{/info}}
106 106  
107 -[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
111 +**Step 3: Ensure Docker is autostarted with WSL **
108 108  
109 -==== 3.2.4 Install eMagiz Deploy Agent ====
113 +{{code language="cmd"}}
114 +nano .bashrc
110 110  
111 -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"]]
116 + #Add following lines to bashrc
117 + DOCKER_DISTRO="Ubuntu"
118 + DOCKER_LOG_DIR=$HOME/docker_logs
119 + mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
120 + /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
121 +{{/code}}
112 112  
113 -===3.3 Uninstall Docker===
114 -To uninstall docker from your machine, execute the following commands in powershell with administrative rights:
123 +**Step 4: Add user to Docker group **
115 115  
116 116  {{code language="cmd"}}
117 -Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Uninstall-docker/uninstall-docker.ps1" -o uninstall-docker-ce.ps1
118 -{{/code}}
126 +sudo visudo
119 119  
120 -Example usage:
128 + #Add following lines
121 121  
122 -{{code language="cmd"}}
123 -.\uninstall-docker-ce.ps1
130 + # Don't ask for password
131 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
124 124  {{/code}}
125 125  
126 -== 4. Key takeaways ==
134 +
127 127  
136 +===3.5 Installation requirements Windows Server 2019 version 1806===
137 +
138 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
139 +
140 +These are the requirements to allow the installation of the eMagiz Docker agent:
141 +* Enable Hyper-V in Windows Server
142 + ** 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.
143 + ** Restart windows
144 +* Cross check is WSL 2.0 is installed
145 + ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
146 +* Install Docker Desktop on the Windows Server
147 + ** Please refer to this link: https://www.docker.com/products/docker-desktop/
148 + ** Restart windows
149 +* Update Docker Desktop configuration
150 + ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
151 + ** Restart Docker
152 +* Open Powershell as Administrator
153 + ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
154 + ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
155 + ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
156 + ** Execute Add-AppxPackage .\ubuntu-2004.appx
157 + *** 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.
158 +* Ubuntu should now be a runnable program (press windows key, type ubuntu)
159 +* Open the ubuntu terminal, and finish the installation.
160 + ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
161 +* Go to the next section around installing the eMagiz Docker agent
162 +
163 +===3.6 Installation requirements Windows Server 2012 R2 ===
164 +
165 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
166 +
167 +These are the requirements to allow the installation of the eMagiz Docker agent:
168 +* Install & enable Hyper-V in Windows Server
169 + ** 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.
170 + ** Restart windows
171 +* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
172 +* Create a VM in HyperV.
173 + ** 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).
174 + ** Configure a virtual switch.
175 + ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
176 + ** Install an operating system from bootable CD/DVD, ISO file
177 +* Install ubuntu downloaded previously on the VM
178 +* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
179 +* Go to the next section around installing the eMagiz agent
180 +
181 +== 4. Assignment ==
182 +
183 +Check out the cheatcheet for Docker command line:
184 +
185 +[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
186 +
187 +== 5. Key takeaways ==
188 +
128 128  * 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
129 129  * eMagiz has a specific agent that manages the download of that image to the on-premises server
130 130  * 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.
131 131  
132 -== 5. Suggested Additional Readings ==
133 133  
134 -* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
135 -** [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
136 -*** [[eMagiz Runtime Generation 3 (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]]
137 -* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
138 -** [[eMagiz Runtime Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome||target="blank"]]
139 -*** [[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"]]
140 -** [[eMagiz Deploy agent (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
141 -* [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]
142 -** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.WebHome||target="blank"]]
143 -*** [[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"]]
144 -* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
145 -** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome||target="blank"]]
146 -*** [[Install Docker for Linux (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-onpremises-server-linux-installguide.WebHome||target="blank"]]
147 147  
195 +== 6. Suggested Additional Readings ==
196 +
197 +N/A
198 +
199 +== 7. Silent demonstration video ==
200 +
201 +N/A
202 +
148 148  )))((({{toc/}}))){{/container}}{{/container}}