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		-On-premise Install Guide
	1	+Install Docker for Windows

Author

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

Content

...	...	@@ -1,5 +1,5 @@
1	1	{{container}}{{container layoutStyle="columns"}}(((
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.
	2	+In this microlearning, we will focus on how an on-premises server can be prepared for a eMagiz Deploy agent installation.
3	3
4	4	Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5	5
...	...	@@ -10,199 +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 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		-
	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		-
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
	19	+
	20	+{{info}}
	21	+* Standard configuration to ensure that communication between your server and eMagiz to ensure communication.
	22	+ ** registry.emagiz.com:443
23	23	** controlplane.emagiz.com:8000
	24	+ ** controltower.kpn-dsh.com:443
24	24	** Preferably the entry should be *.emagiz.com
	26	+ ** Preferably the entry should be *.kpn-dsh.com{{/info}}
25	25
26		-
27		-===3.2 Installation requirements Linux===
	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
28	28
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		-* Install latest version of the Docker engine - see for instance this link below. For other Linux distributions similar install guides are available on this link.
	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
31	31
32		-{{code}}https://docs.docker.com/engine/install/ubuntu/{{/code}}
	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	33
	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.
34	34
35		-* Install the eMagiz Deploy agent
36	36
37		-===3.3 Installation requirements Windows Server 2022 (Docker Desktop)===
	55	+==== 3.2.1 Docker Installation ====
	56	+To install or update docker on your machine, execute the following commands in powershell with administrative rights:
38	38
39		-These are the requirements to allow the installation of the eMagiz Docker agent:
40		-* Install latest version of Docker Desktop from
41		-
42		-{{code}}https://www.docker.com/products/docker-desktop/{{/code}}
43		-
44		-* Validate if WSL 2.0 is properly installed
45		-* Install the eMagiz Deploy agent
46		-
47		-===3.3 Installation requirements Windows Server 2022 (without Docker Desktop) ===
48		-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).
49		-
50		-**Step 1: Install linux distribution**
51		-
52	52	{{code language="cmd"}}
53		- wsl --install -d Ubuntu
54		- sudo apt-get update
55		- sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
56		- . /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
57	57	{{/code}}
58	58
	63	+Example usage:
59	59
60		-**Step 2: Install Docker **
61		-
62	62	{{code language="cmd"}}
63		- curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
64		- echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
65		- sudo apt update
66		- sudo apt install docker-ce docker-ce-cli containerd.io
	66	+.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
67	67	{{/code}}
68	68
69		-{{info}}
70		- Requires ~335 Mb space to install
71		-{{/info}}
	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.
72	72
73		-**Step 3: Install Java **
	71	+==== 3.2.2 Check installation ====
74	74
75		-{{code language="cmd"}}
76		- wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
77		- 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
78		- sudo apt update # update if you haven't already
79		- sudo apt install temurin-8-jdk
80		-{{/code}}
	73	+After executing the commands above, the server will restart if required. After the restart, execute the following command
81	81
82		-{{info}}
83		- Requires ~335 Mb space to install
84		-{{/info}}
85		-
86		-**Step 4: Ensure Docker is autostarted with WSL **
87		-
88	88	{{code language="cmd"}}
89		-nano .bashrc
90		-
91		- #Add following lines to bashrc
92		- DOCKER_DISTRO="Ubuntu"
93		- DOCKER_LOG_DIR=$HOME/docker_logs
94		- mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
95		- /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
	76	+docker ps
96	96	{{/code}}
97	97
98		-**Step 5: Add user to Docker group **
	79	+If the command returns that the command cannot be found, please run the following command again.
99	99
100	100	{{code language="cmd"}}
101		-sudo visudo
102		-
103		- #Add following lines
104		-
105		- # Don't ask for password
106		- %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
	82	+.\install-docker-ce.ps1
107	107	{{/code}}
108	108
109		-**Step 6: Update wsl config file **
110		-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
	85	+==== 3.2.3 Verify docker functionality ====
111	111
112		-First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
	87	+Execute the following command
113	113
114		-
115	115	{{code language="cmd"}}
116		- #Add following lines
117		-
118		- # Settings apply across all Linux distros running on WSL 2
119		- [wsl2]
120		- # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
121		- memory=16GB
122		- # Sets the VM to use two virtual processors
123		- processors=2
	90	+docker ps
124	124	{{/code}}
125	125
126		-
127		-**Step 7: Auto start the linux subsystem when server restarts **
128		-
	93	+The result of this call should show the following:
129	129
130		-===3.4 Installation requirements Windows Server 2019 version >1806===
	95	+[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
131	131
132		-These are the requirements to allow the installation of the eMagiz Docker agent:
133		-* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
134		-* Validate if WSL 2.0 is properly installed
135		-* Go to the next section around installing the eMagiz Docker agent
	97	+==== 3.2.4 Install eMagiz Deploy Agent ====
136	136
137		-===3.5 Installation requirements Windows Server 2019 version 1806===
	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"]]
138	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		-* Install Docker Desktop on the Windows Server
146		- ** Please refer to this link: https://www.docker.com/products/docker-desktop/
147		- ** Restart windows
148		-* Update Docker Desktop configuration
149		- ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
150		- ** Restart Docker
151		-* Open Powershell as Administrator
152		- ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
153		- ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
154		- ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
155		- ** Execute Add-AppxPackage .\ubuntu-2004.appx
156		- *** 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.
157		-* Ubuntu should now be a runnable program (press windows key, type ubuntu)
158		-* Open the ubuntu terminal, and finish the installation.
159		- ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
160		-* Go to the next section around installing the eMagiz Docker agent
	101	+== 4. Key takeaways ==
161	161
162		-===3.6 Installation requirements Windows Server 2012 R2 ===
163		-
164		-These are the requirements to allow the installation of the eMagiz Docker agent:
165		-* Install & enable Hyper-V in Windows Server
166		- ** 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.
167		- ** Restart windows
168		-* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
169		-* Create a VM in HyperV.
170		- ** 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).
171		- ** Configure a virtual switch.
172		- ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
173		- ** Install an operating system from bootable CD/DVD, ISO file
174		-* Install ubuntu downloaded previously on the VM
175		-* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
176		-* Go to the next section around installing the eMagiz agent
177		-
178		-=== 3.7 eMagiz Docker agent installation ===
179		-
180		-eMagiz needs to install a specific agent in the Docker instance that allows to download runtime images that needs to be installed on the Docker instance. The specific command to run inside the Docker instance is specific for the machine that is configured inside eMagiz Design & Deploy Architectures. It can be found inside the eMagiz iPaaS portal under Deploy Architecture. At the runtime connector, there is a right click option called Deploy Agent. That presents either the command or the location where that agent is installed.
181		-
182		-[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
183		-
184		-After installing the agent, you can use the Docker cheat sheet below to see if the docker containers are running and/or images are available.
185		-
186		-== 4. Assignment ==
187		-
188		-Check out the cheatcheet for Docker command line:
189		-
190		-[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
191		-
192		-== 5. Key takeaways ==
193		-
194	194	* 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
195	195	* eMagiz has a specific agent that manages the download of that image to the on-premises server
196	196	* 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.
197	197
	107	+== 5. Suggested Additional Readings ==
198	198
	109	+* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
199	199
200		-== 6. Suggested Additional Readings ==
201		-
202		-N/A
203		-
204		-== 7. Silent demonstration video ==
205		-
206		-N/A
207		-
208	208	)))((({{toc/}}))){{/container}}{{/container}}