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.CarlijnKokkeler

Content

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