Wiki source code of Install Docker for Windows

Version 135.1 by Erik Bakker on 2024/11/29 08:30

Hide last authors
eMagiz 1.1 1 {{container}}{{container layoutStyle="columns"}}(((
Erik Bakker 133.1 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.
Erik Bakker 15.1 3
eMagiz 1.1 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
eMagiz 3.1 9 * Good understanding of eMagiz runtimes in general
eMagiz 1.1 10
11 == 2. Key concepts ==
Erik Bakker 133.1 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.
Erik Bakker 95.1 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
eMagiz 3.1 16 == 3. On-premises deployments ==
eMagiz 25.1 17
18 ===3.1 General requirements===
Erik Bakker 99.1 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
Erik Bakker 105.1 24 ** controltower.kpn-dsh.com:443
25 ** Preferably the entry should be *.emagiz.com
Erik Bakker 106.1 26 ** Preferably the entry should be *.kpn-dsh.com{{/info}}
Erik Bakker 99.1 27
Eva Torken 101.1 28 {{warning}}
Erik Bakker 103.1 29 * In case of a very strict firewall configuration, additional configuration is needed to communicate to the eMagiz infrastructure.
Eva Torken 101.1 30 ** controltower.emagiz.com:443
Erik Bakker 105.1 31 ** controltower.kpn-dsh.com:443
Eva Torken 101.1 32 ** controlbus.emagiz.com:443
33 ** controlplane.emagiz.com:443
34
Erik Bakker 103.1 35 * When using cloudslot number **equal to or below** 125, the following configuration is needed to communicate to your JMS.
Eva Torken 101.1 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
Erik Bakker 103.1 41 ** 3.74.190.88:8444
Carlijn Kokkeler 134.1 42 ** 18.199.123.240
43 ** 18.184.211.189
44 ** 3.123.136.31
Eva Torken 101.1 45
Erik Bakker 103.1 46 * When using a cloudslot number **above** 125, the following configuration is needed to communicate to your JMS.
47 ** 3.74.209.20:443
48 ** 3.76.127.155:443
49 ** 3.74.209.20:8443
50 ** 3.76.127.155:8443
51 ** 3.74.209.20:8444
Carlijn Kokkeler 134.1 52 ** 3.76.127.155:8444
53 ** 18.199.123.240
54 ** 18.184.211.189
55 ** 3.123.136.31{{/warning}}
Erik Bakker 103.1 56
Erik Bakker 95.1 57 ===3.2 Installation Windows===
Erik Bakker 104.1 58 Whenever Windows is selected as operating system, you need to have a Windows Server 2022 version. Older Windows servers are **not** supported.
eMagiz 1.1 59
eMagiz 57.1 60
Erik Bakker 95.1 61 ==== 3.2.1 Docker Installation ====
Carlijn Kokkeler 108.1 62 To install or update docker on your machine, execute the following commands in powershell with administrative rights:
eMagiz 18.1 63
eMagiz 42.1 64 {{code language="cmd"}}
Carlijn Kokkeler 126.1 65 Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Install-update-docker/install-update-docker.ps1" -o install-update-docker-ce.ps1
66 .\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
eMagiz 43.1 67 {{/code}}
eMagiz 44.1 68
Carlijn Kokkeler 122.1 69 {{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"]].
70 {{/info}}
Erik Bakker 135.1 71
72 ==== 3.2.2 Customization ====
Carlijn Kokkeler 122.1 73
Erik Bakker 135.1 74 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"]].
75
76 {{warning}}Be aware that the customization will only take effect once you have restarted Docker.{{/warning}}
Carlijn Kokkeler 125.1 77
Erik Bakker 135.1 78 ===== 3.2.2.1 IP address range =====
79
80 Below you can find the recommended values depending on the range which can be filled in the value <ip-address> below:
81 * 10.0.0.1/8
82 ** advised value 10.25.0.1/16
83 * 172.16.0.1/12
84 ** advised value 172.16.0.1/16
85 * 192.168.0.1/16
86 ** advised value 192.168.0.1/16
Carlijn Kokkeler 125.1 87
88 {{code language="cmd"}}
Erik Bakker 135.1 89 sudo nano /etc/docker/daemon.json
90 #Add following lines
91 {"bip": "<ip-address>"}
92 {{/code}}
93
94 ===== 3.2.2.2 Data location =====
95
96 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:
97
98 {{code language="cmd"}}
Carlijn Kokkeler 125.1 99 {
100 "data-root": "d:\\docker"
101 }
102 {{/code}}
103
Erik Bakker 135.1 104 ==== 3.2.3 Check installation ====
Carlijn Kokkeler 125.1 105
Erik Bakker 95.1 106 After executing the commands above, the server will restart if required. After the restart, execute the following command
eMagiz 44.1 107
eMagiz 45.1 108 {{code language="cmd"}}
Erik Bakker 95.1 109 docker ps
eMagiz 62.1 110 {{/code}}
111
Erik Bakker 95.1 112 If the command returns that the command cannot be found, please run the following command again.
eMagiz 72.1 113
114 {{code language="cmd"}}
Erik Bakker 127.1 115 .\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
eMagiz 47.1 116 {{/code}}
eMagiz 24.1 117
Erik Bakker 95.1 118 ==== 3.2.3 Verify docker functionality ====
eMagiz 45.1 119
Erik Bakker 95.1 120 Execute the following command
eMagiz 50.1 121
eMagiz 49.1 122 {{code language="cmd"}}
Erik Bakker 95.1 123 docker ps
eMagiz 49.1 124 {{/code}}
eMagiz 32.1 125
Erik Bakker 95.1 126 The result of this call should show the following:
eMagiz 51.1 127
Erik Bakker 97.1 128 [[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
eMagiz 52.1 129
Erik Bakker 95.1 130 ==== 3.2.4 Install eMagiz Deploy Agent ====
eMagiz 52.1 131
Erik Bakker 97.1 132 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"]]
eMagiz 52.1 133
Carlijn Kokkeler 115.1 134 ===3.3 Uninstall Docker===
135 To uninstall docker from your machine, execute the following commands in powershell with administrative rights:
136
137 {{code language="cmd"}}
138 Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Uninstall-docker/uninstall-docker.ps1" -o uninstall-docker-ce.ps1
139 {{/code}}
140
141 Example usage:
142
143 {{code language="cmd"}}
144 .\uninstall-docker-ce.ps1
145 {{/code}}
146
Erik Bakker 91.1 147 == 4. Key takeaways ==
eMagiz 1.1 148
eMagiz 5.1 149 * 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
150 * eMagiz has a specific agent that manages the download of that image to the on-premises server
Erik Bakker 40.1 151 * 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.
eMagiz 1.1 152
Erik Bakker 91.1 153 == 5. Suggested Additional Readings ==
eMagiz 1.1 154
Erik Bakker 133.1 155 * [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
156 ** [[eMagiz Runtime Generation 3 (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]]
Carlijn Kokkeler 129.1 157 * [[Release Information (Menu)>>doc:Main.Release Information.WebHome||target="blank"]]
158 ** [[Environment Templates (Navigation)>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]]
Carlijn Kokkeler 128.1 159 * [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
160 ** [[eMagiz Runtime Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome||target="blank"]]
161 *** [[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"]]
Carlijn Kokkeler 129.1 162 *** [[eMagiz Deploy agent (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
Carlijn Kokkeler 128.1 163 * [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]
164 ** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.WebHome||target="blank"]]
165 *** [[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"]]
166 * [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
167 ** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome||target="blank"]]
168 *** [[Install Docker for Linux (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-onpremises-server-linux-installguide.WebHome||target="blank"]]
Carlijn Kokkeler 131.1 169 * [[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"]]
Carlijn Kokkeler 129.1 170 * Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
Carlijn Kokkeler 131.1 171
eMagiz 1.1 172 )))((({{toc/}}))){{/container}}{{/container}}