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

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 eMagiz's current runtime architecture, Docker technology is utilized to deploy runtimes efficiently. eMagiz provides specific runtime images that can be deployed within dockerized environments. This section outlines the steps needed to prepare a Windows server for the installation of the eMagiz Deploy Agent, which is responsible for downloading these images from the eMagiz infrastructure.
3	3
4	4	Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5	5
...	...	@@ -9,152 +9,155 @@
9	9	* Good understanding of eMagiz runtimes in general
10	10
11	11	== 2. Key concepts ==
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		-
	12	+In the current 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	+
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	+ ** controlplane.emagiz.com:443
23	23	** controlplane.emagiz.com:8000
	25	+ ** controlplane-agent.emagiz.com:8000
	26	+ ** controltower.emagiz.com:443
	27	+ ** controltower.kpn-dsh.com:443
	28	+ ** controlbus.emagiz.com:443
24	24	** Preferably the entry should be *.emagiz.com
	30	+ ** Preferably the entry should be *.kpn-dsh.com{{/info}}
25	25
26		-
27		-===3.2 Installation requirements Linux===
	32	+{{warning}}
	33	+* When using **IP Whitelisting**, the following configuration is needed to communicate to your JMS.
	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
	40	+ ** 3.74.209.20:443
	41	+ ** 3.76.127.155:443
	42	+ ** 3.74.209.20:8443
	43	+ ** 3.76.127.155:8443
	44	+ ** 3.74.209.20:8444
	45	+ ** 3.76.127.155:8444
	46	+ ** 18.199.123.240
	47	+ ** 18.184.211.189
	48	+ ** 3.123.136.31{{/warning}}
28	28
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
	50	+===3.2 Installation Windows===
	51	+Whenever Windows is selected as operating system, you need to have a Windows Server 2022 version. Older Windows servers are **not** supported.
32	32
33		-===3.3 Installation requirements Windows Server 2022===
34	34
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
	54	+==== 3.2.1 Docker Installation ====
	55	+To install or update docker on your machine, execute the following commands in powershell with administrative rights:
39	39
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
	57	+{{code language="cmd"}}
	58	+Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Install-update-docker/install-update-docker.ps1" -o install-update-docker-ce.ps1
	59	+.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
	60	+{{/code}}
48	48
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
	62	+{{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"]].
	63	+{{/info}}
54	54
55		-#Autostart Dockerd with wsl
	65	+==== 3.2.2 Customization ====
56	56
57		-nano .bashrc
	67	+After installing Docker you have the option to stick with the standard configuration of Docker or you can opt to alter some specific settings. Settings that can be of particular interest are the setting that defines the IP address range your Docker installation will use to run the containers and the setting that defines where to store data (i.e. containers and images). To check the full list of compatible configuration options for Windows you can check: [[Configure Docker in Windows>>https://learn.microsoft.com/en-us/virtualization/windowscontainers/manage-docker/configure-docker-daemon||target="blank"]].
58	58
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	+{{warning}}Be aware that the customization will only take effect once you have restarted the machine.{{/warning}}
63	63
64		-#Do not ask password dockerd
65		-sudo visudo
	71	+===== 3.2.2.1 IP address range =====
	72	+
	73	+Below you can find the code necessary to configure a different IP address range.
66	66
67		- %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
	75	+{{code language="cmd"}}
	76	+cd C:\ProgramData\Docker\config\daemon.json
	77	+#Add following lines
	78	+{"fixed-cidr": "<ip-address>"}
	79	+{{/code}}
68	68
69		-#Set WSL config for memory
70		-USERDIR/.wslconfig
71		- # Settings apply across all Linux distros running on WSL 2
72		- [wsl2]
	81	+===== 3.2.2.2 Data location =====
	82	+
	83	+Below you can find an example of switching from the default C directory ({{code language="cmd"}}c:\programdata\docker{{/code}}) to the D directory to store data related to Docker. Based on your internal configuration you can choose the best suitable variant if that is needed. To do so you can add the following attribute to the Docker daemon file:
73	73
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
	85	+{{code language="cmd"}}
	86	+cd C:\ProgramData\Docker\config\daemon.json
	87	+#Add following lines
	88	+{
	89	+ "data-root": "d:\\docker"
	90	+}
	91	+{{/code}}
76	76
77		- # Sets the VM to use two virtual processors
78		- processors=2
	93	+{{warning}}Note that when you want to create multiple customizations to your configuration the result in the daemon.json file should be a **valid** JSON structure{{/warning}}
79	79
80		-(Exit WSL: wsl --shutdown)
	95	+==== 3.2.3 Check installation ====
81	81
82		-===3.4 Installation requirements Windows Server 2019 version >1806===
	97	+After executing the commands above, the server will restart if required. After the restart, execute the following command
83	83
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
	99	+{{code language="cmd"}}
	100	+docker ps
	101	+{{/code}}
88	88
89		-===3.5 Installation requirements Windows Server 2019 version 1806===
	103	+If the command returns that the command cannot be found, please run the following command again.
90	90
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
	105	+{{code language="cmd"}}
	106	+.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
	107	+{{/code}}
113	113
114		-===3.6 Installation requirements Windows Server 2012 R2 ===
	109	+==== 3.2.3 Verify docker functionality ====
115	115
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
	111	+Execute the following command
129	129
130		-=== 3.7 eMagiz Docker agent installation ===
	113	+{{code language="cmd"}}
	114	+docker ps
	115	+{{/code}}
131	131
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.
	117	+The result of this call should show the following:
133	133
134		-[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
	119	+[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
135	135
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.
	121	+==== 3.2.4 Install eMagiz Deploy Agent ====
137	137
138		-== 4. Assignment ==
	123	+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"]]
139	139
140		-Check out the cheatcheet for Docker command line:
	125	+===3.3 Uninstall Docker===
	126	+To uninstall docker from your machine, execute the following commands in powershell with administrative rights:
141	141
142		-[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
	128	+{{code language="cmd"}}
	129	+Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Uninstall-docker/uninstall-docker.ps1" -o uninstall-docker-ce.ps1
	130	+{{/code}}
143	143
144		-== 5. Key takeaways ==
	132	+Example usage:
145	145
	134	+{{code language="cmd"}}
	135	+.\uninstall-docker-ce.ps1
	136	+{{/code}}
	137	+
	138	+== 4. Key takeaways ==
	139	+
146	146	* 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
147	147	* eMagiz has a specific agent that manages the download of that image to the on-premises server
148	148	* 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.
149	149
	144	+== 5. Suggested Additional Readings ==
150	150
	146	+* [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
	147	+** [[eMagiz Runtime Generation 3 (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]]
	148	+* [[Release Information (Menu)>>doc:Main.Release Information.WebHome||target="blank"]]
	149	+** [[Environment Templates (Navigation)>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]]
	150	+* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
	151	+** [[eMagiz Runtime Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome||target="blank"]]
	152	+*** [[Interpret on-premise logging (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-interpret-on-premise-logging.WebHome||target="blank"]]
	153	+*** [[eMagiz Deploy agent (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
	154	+* [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]
	155	+** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.WebHome||target="blank"]]
	156	+*** [[Impact of Runtime Image Upgrades (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.advanced-lifecycle-management-impact-of-runtime-image-upgrades.WebHome||target="blank"]]
	157	+* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
	158	+** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome||target="blank"]]
	159	+*** [[Install Docker for Linux (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-onpremises-server-linux-installguide.WebHome||target="blank"]]
	160	+* [[Install Docker (Search Result)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=install+docker||target="blank"]]
	161	+* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
151	151
152		-== 6. Suggested Additional Readings ==
153		-
154		-N/A
155		-
156		-== 7. Silent demonstration video ==
157		-
158		-N/A
159		-
160	160	)))((({{toc/}}))){{/container}}{{/container}}