Changes for page Install Docker for Windows

Summary

• Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-Pre-requisite installation of on-premises server
	1	+Install Docker for Windows

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.eMagiz
	1	+XWiki.etorken

Content

...	...	@@ -10,197 +10,84 @@
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 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		-
	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	+
16	16	== 3. On-premises deployments ==
17	17
18	18	===3.1 General requirements===
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
	19	+
	20	+{{info}}
	21	+* Standard configuration to ensure that communication between your server and eMagiz to ensure communication.
	22	+ ** registry.emagiz.com:443
22	22	** controlplane.emagiz.com:8000
23		- ** Preferably the entry should be *.emagiz.com
	24	+ ** Preferably the entry should be *.emagiz.com{{/info}}
24	24
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
	26	+{{warning}}
	27	+* In case of a very strict firewall configuration, additional configuration is needed.
	28	+ ** controltower.emagiz.com:443
	29	+ ** controlbus.emagiz.com:443
	30	+ ** controlplane.emagiz.com:443
	31	+ ** controlplane.emagiz.com:8000
29	29
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"]]
	33	+* When using cloudslot number 125 or less, the following configuration is needed.
	34	+ ** 35.158.46.28:443
	35	+ ** 3.74.190.88:443
	36	+ ** 35.158.46.28:8443
	37	+ ** 3.74.190.88:8443
	38	+ ** 35.158.46.28:8444
	39	+ ** 3.74.190.88:8444 {{/warning}}
32	32
33		-===3.3 Installation requirements Windows Server 2022 ===
	41	+===3.2 Installation Windows===
	42	+Whenever Windows is selected as operating system, you need to have a Windows Server 2022 version or a 2019 version (> 1806). Older Windows servers are **not** supported.
34	34
35		-{{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
36	36
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).
	45	+==== 3.2.1 Docker Installation ====
	46	+In powershell with administrative rights, execute the following commands
38	38
39		-**Step 1: Install linux distribution**
40		-
41	41	{{code language="cmd"}}
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
	49	+Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/microsoft/Windows-Containers/Main/helpful_tools/Install-DockerCE/install-docker-ce.ps1" -o install-docker-ce.ps1
	50	+.\install-docker-ce.ps1
46	46	{{/code}}
47	47
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
	53	+==== 3.2.2 Check installation ====
53	53
54		-First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
	55	+After executing the commands above, the server will restart if required. After the restart, execute the following command
55	55
56	56	{{code language="cmd"}}
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
	58	+docker ps
65	65	{{/code}}
66	66
67		-
68		-**Step 4: Auto start the linux subsystem when Windows server restarts **
	61	+If the command returns that the command cannot be found, please run the following command again.
69	69
70	70	{{code language="cmd"}}
71		-* Press Windows+R
72		-* Type shell:startup and press enter
73		-* Add or update file start_wsl.bat
74		-* Add following line into the document and save file
75		- * wsl sudo /usr/bin/dockerd
76		- {{/code}}
77		-
78		-**Step 5: Install eMagiz Deploy Agent**
79		-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"]].
80		-
81		-
82		-===3.4 Installation steps to configure Linux subsystem ===
83		-
84		-**Step 1: Install Docker **
85		-
86		-{{code language="cmd"}}
87		- curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
88		- echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
89		- sudo apt update
90		- sudo apt install docker-ce docker-ce-cli containerd.io
	64	+.\install-docker-ce.ps1
91	91	{{/code}}
92	92
93		-{{info}}
94		- Requires ~335 Mb space to install
95		-{{/info}}
	67	+==== 3.2.3 Verify docker functionality ====
96	96
97		-**Step 2: Install Java **
	69	+Execute the following command
98	98
99	99	{{code language="cmd"}}
100		- wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
101		- 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
102		- sudo apt update # update if you haven't already
103		- sudo apt install temurin-8-jdk
	72	+docker ps
104	104	{{/code}}
105	105
106		-{{info}}
107		- Requires ~335 Mb space to install
108		-{{/info}}
	75	+The result of this call should show the following:
109	109
110		-**Step 3: Ensure Docker is autostarted with WSL **
	77	+[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
111	111
112		-{{code language="cmd"}}
113		-nano .bashrc
	79	+==== 3.2.4 Install eMagiz Deploy Agent ====
114	114
115		- #Add following lines to bashrc
116		- DOCKER_DISTRO="Ubuntu"
117		- DOCKER_LOG_DIR=$HOME/docker_logs
118		- mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
119		- /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
120		-{{/code}}
	81	+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"]]
121	121
122		-**Step 4: Add user to Docker group **
	83	+== 4. Key takeaways ==
123	123
124		-{{code language="cmd"}}
125		-sudo visudo
126		-
127		- #Add following lines
128		-
129		- # Don't ask for password
130		- %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
131		-{{/code}}
132		-
133		-
134		-
135		-===3.5 Installation requirements Windows Server 2019 version 1806===
136		-
137		-{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
138		-
139		-These are the requirements to allow the installation of the eMagiz Docker agent:
140		-* Enable Hyper-V in Windows Server
141		- ** 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.
142		- ** Restart windows
143		-* Cross check is WSL 2.0 is installed
144		- ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
145		-* Please follow the instructions for preparing a Windows 2022 installation in section 3.3
146		-
147		-{{info}}
148		- * Install Docker Desktop on the Windows Server
149		- ** Please refer to this link: https://www.docker.com/products/docker-desktop/
150		- ** Restart windows
151		-* Update Docker Desktop configuration
152		- ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
153		- ** Restart Docker
154		-* Open Powershell as Administrator
155		- ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
156		- ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
157		- ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
158		- ** Execute Add-AppxPackage .\ubuntu-2004.appx
159		- *** 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.
160		-* Ubuntu should now be a runnable program (press windows key, type ubuntu)
161		-* Open the ubuntu terminal, and finish the installation.
162		- ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
163		-* Go to the next section around installing the eMagiz Docker agent
164		-{{/info}}
165		-
166		-===3.6 Installation requirements Windows Server 2012 R2 ===
167		-
168		-{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
169		-
170		-These are the requirements to allow the installation of the eMagiz Docker agent:
171		-* Install & enable Hyper-V in Windows Server
172		- ** 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.
173		- ** Restart windows
174		-* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
175		-* Create a VM in HyperV.
176		- ** 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).
177		- ** Configure a virtual switch.
178		- ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
179		- ** Install an operating system from bootable CD/DVD, ISO file
180		-* Install ubuntu downloaded previously on the VM
181		-* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
182		-* Go to the next section around installing the eMagiz agent
183		-
184		-== 4. Assignment ==
185		-
186		-Check out the cheatcheet for Docker command line:
187		-
188		-[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
189		-
190		-== 5. Key takeaways ==
191		-
192	192	* 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
193	193	* eMagiz has a specific agent that manages the download of that image to the on-premises server
194	194	* 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.
195	195
	89	+== 5. Suggested Additional Readings ==
196	196
	91	+* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
197	197
198		-== 6. Suggested Additional Readings ==
199		-
200		-N/A
201		-
202		-== 7. Silent demonstration video ==
203		-
204		-N/A
205		-
206	206	)))((({{toc/}}))){{/container}}{{/container}}