Changes for page Install Docker for Windows

Summary

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

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-Install Docker for Windows
	1	+On-premise Install Guide

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,127 +10,151 @@
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
	30	+* Install latest version of the Docker engine - see for instance {{code}}https://docs.docker.com/engine/install/ubuntu/{{/code}}
	31	+* Go to the next section around installing the eMagiz agent
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	+These are the requirements to allow the installation of the eMagiz Docker agent:
	36	+* Install latest version of Docker Desktop from {{code}}https://www.docker.com/products/docker-desktop/{{/code}}
	37	+* Validate if WSL 2.0 is properly installed
	38	+* Go to the next section around installing the eMagiz Docker agent
53	53
	40	+ #Install docker
	41	+sudo apt-get update
	42	+sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
	43	+. /etc/os-release
	44	+curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
	45	+echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
	46	+sudo apt update
	47	+sudo apt install docker-ce docker-ce-cli containerd.io
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:
	49	+#Install Java
	50	+wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
	51	+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
	52	+sudo apt update # update if you haven't already
	53	+sudo apt install temurin-8-jdk
57	57
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
61		-{{/code}}
	55	+#Autostart Dockerd with wsl
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}}
	57	+nano .bashrc
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"]].
	59	+ DOCKER_DISTRO="Ubuntu"
	60	+ DOCKER_LOG_DIR=$HOME/docker_logs
	61	+ mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
	62	+ /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
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:
	64	+#Do not ask password dockerd
	65	+sudo visudo
72	72
73		-{{code language="cmd"}}
74		-{
75		- "data-root": "d:\\docker"
76		-}
77		-{{/code}}
	67	+ %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
78	78
79		-If not specified, the default is {{code language="cmd"}}c:\programdata\docker{{/code}}.
	69	+#Set WSL config for memory
	70	+USERDIR/.wslconfig
	71	+ # Settings apply across all Linux distros running on WSL 2
	72	+ [wsl2]
80	80
81		-{{/info}}
	74	+ # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
	75	+ memory=16GB
82	82
83		-==== 3.2.2 Check installation ====
	77	+ # Sets the VM to use two virtual processors
	78	+ processors=2
84	84
85		-After executing the commands above, the server will restart if required. After the restart, execute the following command
	80	+(Exit WSL: wsl --shutdown)
86	86
87		-{{code language="cmd"}}
88		-docker ps
89		-{{/code}}
	82	+===3.4 Installation requirements Windows Server 2019 version >1806===
90	90
91		-If the command returns that the command cannot be found, please run the following command again.
	84	+These are the requirements to allow the installation of the eMagiz Docker agent:
	85	+* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
	86	+* Validate if WSL 2.0 is properly installed
	87	+* Go to the next section around installing the eMagiz Docker agent
92	92
93		-{{code language="cmd"}}
94		-.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
95		-{{/code}}
	89	+===3.5 Installation requirements Windows Server 2019 version 1806===
96	96
97		-==== 3.2.3 Verify docker functionality ====
	91	+These are the requirements to allow the installation of the eMagiz Docker agent:
	92	+* Enable Hyper-V in Windows Server
	93	+ ** 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.
	94	+ ** Restart windows
	95	+* Cross check is WSL 2.0 is installed
	96	+ ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
	97	+* Install Docker Desktop on the Windows Server
	98	+ ** Please refer to this link: https://www.docker.com/products/docker-desktop/
	99	+ ** Restart windows
	100	+* Update Docker Desktop configuration
	101	+ ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
	102	+ ** Restart Docker
	103	+* Open Powershell as Administrator
	104	+ ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
	105	+ ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
	106	+ ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
	107	+ ** Execute Add-AppxPackage .\ubuntu-2004.appx
	108	+ *** 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.
	109	+* Ubuntu should now be a runnable program (press windows key, type ubuntu)
	110	+* Open the ubuntu terminal, and finish the installation.
	111	+ ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
	112	+* Go to the next section around installing the eMagiz Docker agent
98	98
99		-Execute the following command
	114	+===3.6 Installation requirements Windows Server 2012 R2 ===
100	100
101		-{{code language="cmd"}}
102		-docker ps
103		-{{/code}}
	116	+These are the requirements to allow the installation of the eMagiz Docker agent:
	117	+* Install & enable Hyper-V in Windows Server
	118	+ ** 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.
	119	+ ** Restart windows
	120	+* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
	121	+* Create a VM in HyperV.
	122	+ ** 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).
	123	+ ** Configure a virtual switch.
	124	+ ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
	125	+ ** Install an operating system from bootable CD/DVD, ISO file
	126	+* Install ubuntu downloaded previously on the VM
	127	+* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
	128	+* Go to the next section around installing the eMagiz agent
104	104
105		-The result of this call should show the following:
	130	+=== 3.7 eMagiz Docker agent installation ===
106	106
107		-[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
	132	+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.
108	108
109		-==== 3.2.4 Install eMagiz Deploy Agent ====
	134	+[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
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"]]
	136	+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.
112	112
113		-===3.3 Uninstall Docker===
114		-To uninstall docker from your machine, execute the following commands in powershell with administrative rights:
	138	+== 4. Assignment ==
115	115
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}}
	140	+Check out the cheatcheet for Docker command line:
119	119
120		-Example usage:
	142	+[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
121	121
122		-{{code language="cmd"}}
123		-.\uninstall-docker-ce.ps1
124		-{{/code}}
	144	+== 5. Key takeaways ==
125	125
126		-== 4. Key takeaways ==
127		-
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	135
	152	+== 6. Suggested Additional Readings ==
	153	+
	154	+N/A
	155	+
	156	+== 7. Silent demonstration video ==
	157	+
	158	+N/A
	159	+
136	136	)))((({{toc/}}))){{/container}}{{/container}}