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 66.2
edited by eMagiz
on 2023/02/07 12:42
Change comment: Update document after refactoring.

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Install Docker for Windows
1 +expert-solution-architecture-onpremises-server-installguide
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.CarlijnKokkeler
1 +XWiki.eMagiz
Content
... ... @@ -1,5 +1,5 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -In this microlearning, we will focus on how an on-premises server can be prepared for a eMagiz Deploy agent installation.
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  
... ... @@ -10,131 +10,188 @@
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 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
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 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
26 +
27 +===3.2 Installation requirements Linux===
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
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 +**Step 1: Install linux distribution**
31 +Follow all steps in section 3.4
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 +**Step 2: Install eMagiz Deploy Agent**
34 +Install the eMagiz Deploy agent as can be found here
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.
36 +===3.3 Installation requirements Windows Server 2022 ===
53 53  
38 +{{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
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:
40 +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).
57 57  
42 +**Step 1: Install linux distribution**
43 +
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
45 + wsl --install -d Ubuntu
46 + sudo apt-get update
47 + sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
48 + . /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}}
51 +**Step 2: Configure linux system**
52 +Please see section 3.4 for these these steps
53 +
54 +**Step 3: Update wsl config file **
55 +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"]].
57 +First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
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}}
59 +{{code language="cmd"}}
60 + #Add following lines
61 +
62 + # Settings apply across all Linux distros running on WSL 2
63 + [wsl2]
64 + # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
65 + memory=16GB
66 + # Sets the VM to use two virtual processors
67 + processors=2
68 +{{/code}}
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:
70 +
71 +**Step 4: Auto start the linux subsystem when Windows server restarts **
72 +
73 +**Step 5: Install eMagiz Deploy Agent**
74 +Install the eMagiz Deploy agent as can be found here
75 +
76 +
77 +===3.4 Installation steps to configure Linux subsystem ===
78 +
79 +**Step 1: Install Docker **
76 76  
77 77  {{code language="cmd"}}
78 -{
79 - "data-root": "d:\\docker"
80 -}
82 + curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
83 + echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
84 + sudo apt update
85 + sudo apt install docker-ce docker-ce-cli containerd.io
81 81  {{/code}}
82 82  
83 -If not specified, the default is {{code language="cmd"}}c:\programdata\docker{{/code}}.
84 -
88 +{{info}}
89 + Requires ~335 Mb space to install
85 85  {{/info}}
86 86  
87 -==== 3.2.2 Check installation ====
92 +**Step 2: Install Java **
88 88  
89 -After executing the commands above, the server will restart if required. After the restart, execute the following command
90 -
91 91  {{code language="cmd"}}
92 -docker ps
95 + wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
96 + 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
97 + sudo apt update # update if you haven't already
98 + sudo apt install temurin-8-jdk
93 93  {{/code}}
94 94  
95 -If the command returns that the command cannot be found, please run the following command again.
101 +{{info}}
102 + Requires ~335 Mb space to install
103 +{{/info}}
96 96  
105 +**Step 3: Ensure Docker is autostarted with WSL **
106 +
97 97  {{code language="cmd"}}
98 -.\install-docker-ce.ps1
108 +nano .bashrc
109 +
110 + #Add following lines to bashrc
111 + DOCKER_DISTRO="Ubuntu"
112 + DOCKER_LOG_DIR=$HOME/docker_logs
113 + mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
114 + /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
99 99  {{/code}}
100 100  
101 -==== 3.2.3 Verify docker functionality ====
117 +**Step 4: Add user to Docker group **
102 102  
103 -Execute the following command
104 -
105 105  {{code language="cmd"}}
106 -docker ps
120 +sudo visudo
121 +
122 + #Add following lines
123 +
124 + # Don't ask for password
125 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
107 107  {{/code}}
108 108  
109 -The result of this call should show the following:
128 +
110 110  
111 -[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
130 +===3.5 Installation requirements Windows Server 2019 version 1806===
112 112  
113 -==== 3.2.4 Install eMagiz Deploy Agent ====
132 +{{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"]]
134 +These are the requirements to allow the installation of the eMagiz Docker agent:
135 +* Enable Hyper-V in Windows Server
136 + ** 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.
137 + ** Restart windows
138 +* Cross check is WSL 2.0 is installed
139 + ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
140 +* Install Docker Desktop on the Windows Server
141 + ** Please refer to this link: https://www.docker.com/products/docker-desktop/
142 + ** Restart windows
143 +* Update Docker Desktop configuration
144 + ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
145 + ** Restart Docker
146 +* Open Powershell as Administrator
147 + ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
148 + ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
149 + ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
150 + ** Execute Add-AppxPackage .\ubuntu-2004.appx
151 + *** 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.
152 +* Ubuntu should now be a runnable program (press windows key, type ubuntu)
153 +* Open the ubuntu terminal, and finish the installation.
154 + ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
155 +* Go to the next section around installing the eMagiz Docker agent
116 116  
117 -===3.3 Uninstall Docker===
118 -To uninstall docker from your machine, execute the following commands in powershell with administrative rights:
157 +===3.6 Installation requirements Windows Server 2012 R2 ===
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}}
159 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
123 123  
124 -Example usage:
161 +These are the requirements to allow the installation of the eMagiz Docker agent:
162 +* Install & enable Hyper-V in Windows Server
163 + ** 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.
164 + ** Restart windows
165 +* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
166 +* Create a VM in HyperV.
167 + ** 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).
168 + ** Configure a virtual switch.
169 + ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
170 + ** Install an operating system from bootable CD/DVD, ISO file
171 +* Install ubuntu downloaded previously on the VM
172 +* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
173 +* Go to the next section around installing the eMagiz agent
125 125  
126 -{{code language="cmd"}}
127 -.\uninstall-docker-ce.ps1
128 -{{/code}}
175 +== 4. Assignment ==
129 129  
130 -== 4. Key takeaways ==
177 +Check out the cheatcheet for Docker command line:
131 131  
179 +[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
180 +
181 +== 5. Key takeaways ==
182 +
132 132  * 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
133 133  * eMagiz has a specific agent that manages the download of that image to the on-premises server
134 134  * 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.
135 135  
136 -== 5. Suggested Additional Readings ==
137 137  
138 -* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
139 139  
189 +== 6. Suggested Additional Readings ==
190 +
191 +N/A
192 +
193 +== 7. Silent demonstration video ==
194 +
195 +N/A
196 +
140 140  )))((({{toc/}}))){{/container}}{{/container}}