Wiki source code of Install Docker for Windows

Last modified by Erik Bakker on 2024/04/11 08:21
Show last authors
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.
3
4 Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5
6 == 1. Prerequisites ==
7
8 * Advanced knowledge of the eMagiz platform
9 * Good understanding of eMagiz runtimes in general
10
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 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 == 3. On-premises deployments ==
17
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
23 ** controlplane.emagiz.com:8000
24 ** controltower.kpn-dsh.com:443
25 ** Preferably the entry should be *.emagiz.com
26 ** Preferably the entry should be *.kpn-dsh.com{{/info}}
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
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
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}}
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.
53
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:
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}}
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}}
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"]].
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:
72
73 {{code language="cmd"}}
74 {
75 "data-root": "d:\\docker"
76 }
77 {{/code}}
78
79 If not specified, the default is {{code language="cmd"}}c:\programdata\docker{{/code}}.
80
81 {{/info}}
82
83 ==== 3.2.2 Check installation ====
84
85 After executing the commands above, the server will restart if required. After the restart, execute the following command
86
87 {{code language="cmd"}}
88 docker ps
89 {{/code}}
90
91 If the command returns that the command cannot be found, please run the following command again.
92
93 {{code language="cmd"}}
94 .\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
95 {{/code}}
96
97 ==== 3.2.3 Verify docker functionality ====
98
99 Execute the following command
100
101 {{code language="cmd"}}
102 docker ps
103 {{/code}}
104
105 The result of this call should show the following:
106
107 [[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
108
109 ==== 3.2.4 Install eMagiz Deploy Agent ====
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"]]
112
113 ===3.3 Uninstall Docker===
114 To uninstall docker from your machine, execute the following commands in powershell with administrative rights:
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}}
119
120 Example usage:
121
122 {{code language="cmd"}}
123 .\uninstall-docker-ce.ps1
124 {{/code}}
125
126 == 4. Key takeaways ==
127
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 * eMagiz has a specific agent that manages the download of that image to the on-premises server
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
132 == 5. Suggested Additional Readings ==
133
134 * Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
135
136 )))((({{toc/}}))){{/container}}{{/container}}