Changes for page Install Docker for Windows
Last modified by Erik Bakker on 2026/04/21 12:15
From version 151.1
edited by Erik Bakker
on 2026/04/21 12:15
on 2026/04/21 12:15
Change comment:
There is no comment for this version
To version 121.1
edited by CarlijnKokkeler
on 2024/03/28 11:00
on 2024/03/28 11:00
Change comment:
There is no comment for this version
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. ebakker1 +XWiki.CarlijnKokkeler - Content
-
... ... @@ -1,5 +1,5 @@ 1 1 {{container}}{{container layoutStyle="columns"}}((( 2 -In eMagiz'scurrent runtime architecture, Dockertechnologyisutilized to deployruntimes efficiently. eMagiz provides specific runtime imagesthat canbe deployedwithindockerized environments. Thissection outlinesthestepsneededtopreparea Windowsserverforthe installationof theeMagiz DeployAgent,which is responsible for downloadingtheseimages from the eMagiz infrastructure.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 ... ... @@ -9,7 +9,7 @@ 9 9 * Good understanding of eMagiz runtimes in general 10 10 11 11 == 2. Key concepts == 12 -In the currentruntime 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.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 13 14 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 15 ... ... @@ -17,28 +17,22 @@ 17 17 18 18 ===3.1 General requirements=== 19 19 20 -{{info}}It is advised to use Docker version 29.1.3 as this is the version being used in the latest eMagiz cloud template. We advise aligning the on-premise Docker version and updating it according to the release notes of the [[Cloud templates>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]]. 21 -{{/info}} 22 - 23 23 {{info}} 24 -* When **your** security requirements require **DNS Whitelisting**, the following DNS-level configuration is needed to communicate with our infrastructure and the specific eMagiz model(s) you need to connect to. These IP addresses are subject to periodic change on our end. 25 - 21 +* Standard configuration to ensure that communication between your server and eMagiz to ensure communication. 26 26 ** registry.emagiz.com:443 27 - ** controlplane.emagiz.com:443 28 - ** controlplane-agent.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. 29 29 ** controltower.emagiz.com:443 30 30 ** controltower.kpn-dsh.com:443 31 31 ** controlbus.emagiz.com:443 32 - ** {yourcloudslotid}.emagizcloud.com:8443 33 - 34 -* Preferably we suggest to implement the following entries on DNS level. 35 - ** *.emagizcloud.com 36 - ** *.emagiz.com 37 - ** *.kpn-dsh.com{{/info}} 33 + ** controlplane.emagiz.com:443 38 38 39 -{{warning}} 40 -* When **your** security requirements require **IP Whitelisting**, the following IP-level configuration is needed to communicate with our infrastructure and the specific eMagiz model(s) you need to connect to. These IP addresses are subject to periodic change on our end. 41 - 35 +* When using cloudslot number **equal to or below** 125, the following configuration is needed to communicate to your JMS. 42 42 ** 35.158.46.28:443 43 43 ** 3.74.190.88:443 44 44 ** 35.158.46.28:8443 ... ... @@ -45,62 +45,29 @@ 45 45 ** 3.74.190.88:8443 46 46 ** 35.158.46.28:8444 47 47 ** 3.74.190.88:8444 42 + 43 +* When using a cloudslot number **above** 125, the following configuration is needed to communicate to your JMS. 48 48 ** 3.74.209.20:443 49 49 ** 3.76.127.155:443 50 50 ** 3.74.209.20:8443 51 51 ** 3.76.127.155:8443 52 52 ** 3.74.209.20:8444 53 - ** 3.76.127.155:8444 54 - ** 18.199.123.240:443 55 - ** 18.184.211.189:443 56 - ** 3.123.136.31:443 57 - ** 3.66.44.69:443 58 - ** 52.57.64.170:443 59 - ** 63.182.102.95:443{{/warning}} 49 + ** 3.76.127.155:8444{{/warning}} 60 60 61 61 ===3.2 Installation Windows=== 62 -When Windows is selected as theoperating system, you need Windows Server 2022. Older Windows servers are **not** supported.52 +Whenever Windows is selected as operating system, you need to have a Windows Server 2022 version. Older Windows servers are **not** supported. 63 63 54 + 64 64 ==== 3.2.1 Docker Installation ==== 65 -To install Docker on your machine, execute the following commands inPowerShell with administrative rights:56 +To install or update docker on your machine, execute the following commands in powershell with administrative rights: 66 66 67 67 {{code language="cmd"}} 68 -Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/ emagiz/windows-support/main/Install-update-docker/install-update-docker.ps1" -o install-update-docker-ce.ps169 -.\install- update-docker-ce.ps1-DockerVersion DESIRED_VERSION59 +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 70 70 {{/code}} 71 71 72 -==== 3.2.2 C ustomization ====63 +==== 3.2.2 Check installation ==== 73 73 74 -After installing Docker, you can stick with the standard configuration or adjust specific settings. Settings that can be of particular interest include the one that defines the IP address range your Docker installation will use to run containers, and the one 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 the machine.{{/warning}} 77 - 78 -===== 3.2.2.1 IP address range ===== 79 - 80 -Below is the code needed to configure a different IP address range. 81 - 82 -{{code language="cmd"}} 83 -cd C:\ProgramData\Docker\config\daemon.json 84 -#Add the following lines 85 -{"fixed-cidr": "<ip-address>"} 86 -{{/code}} 87 - 88 -===== 3.2.2.2 Data location ===== 89 - 90 -Below is an example of switching from the default C directory ({{code language="cmd"}}c:\programdata\docker{{/code}}) to the D directory to store Docker data. Based on your internal configuration, you can choose the best suitable variant if needed. To do so, you can add the following attribute to the Docker daemon file: 91 - 92 -{{code language="cmd"}} 93 -cd C:\ProgramData\Docker\config\daemon.json 94 -#Add the following lines 95 -{ 96 - "data-root": "d:\\docker" 97 -} 98 -{{/code}} 99 - 100 -{{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}} 101 - 102 -==== 3.2.3 Check installation ==== 103 - 104 104 After executing the commands above, the server will restart if required. After the restart, execute the following command 105 105 106 106 {{code language="cmd"}} ... ... @@ -107,13 +107,13 @@ 107 107 docker ps 108 108 {{/code}} 109 109 110 -If the command returns "command not found,"please run the following command again.71 +If the command returns that the command cannot be found, please run the following command again. 111 111 112 112 {{code language="cmd"}} 113 -.\install- update-docker-ce.ps1-DockerVersion DESIRED_VERSION74 +.\install-docker-ce.ps1 114 114 {{/code}} 115 115 116 -==== 3.2.3 Verify Docker functionality ====77 +==== 3.2.3 Verify docker functionality ==== 117 117 118 118 Execute the following command 119 119 ... ... @@ -127,59 +127,53 @@ 127 127 128 128 ==== 3.2.4 Install eMagiz Deploy Agent ==== 129 129 130 -Install the eMagiz Deploy agent as described in this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]91 +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"]] 131 131 132 -=== 3.3 UpdateDocker===133 - When youare advisedto updateyour Dockerversion,youcan verifywhether youare on thecorrect Docker versionbyexecutingthe following command inPowerShell with administrative rights:93 +===3.3 Uninstall Docker=== 94 +To uninstall docker from your machine, execute the following commands in powershell with administrative rights: 134 134 135 135 {{code language="cmd"}} 136 - dockerversion97 +Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Uninstall-docker/uninstall-docker.ps1" -o uninstall-docker-ce.ps1 137 137 {{/code}} 138 138 139 - When this returnsaversion **lower** than the advised version shown under the "General requirements" section, you can updateDocker on your machine. To doso, execute the following command in PowerShell with administrative rights:100 +Example usage: 140 140 141 141 {{code language="cmd"}} 142 -.\install- update-docker-ce.ps1-DockerVersion DESIRED_VERSION103 +.\uninstall-docker-ce.ps1 143 143 {{/code}} 144 144 145 -{{warning}}It may happen that, due to the update, your containers are no longer starting up. To resolve this, please restart the containers, which can be done via a deployment plan or the deploy architecture.{{/warning}} 106 +{{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"]]. 107 +{{/info}} 146 146 147 -===3.4 Uninstall Docker=== 148 -To uninstall Docker from your machine, execute the following commands in PowerShell with administrative rights: 109 +{{info}} 110 +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}}. 111 +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"]]. 149 149 150 -{{ code language="cmd"}}151 -In voke-WebRequest-UseBasicParsing"https://raw.githubusercontent.com/emagiz/windows-support/main/Uninstall-docker/uninstall-docker.ps1"-ouninstall-docker-ce.ps1152 -{{/ code}}113 +{{warning}} 114 +Ignore the Uninstall section as it is outdated (For Windows Server 2016), instead refer to the previous section to Uninstall docker 115 +{{/warning}} 153 153 154 -Example usage: 117 +**Example usage of the Docker daemon file**: You maybe want the Docker daemon to keep images and containers in an alternate path (D: 118 +drive for example). To do so you can add the following attribute to the Docker daemon file: 155 155 156 156 {{code language="cmd"}} 157 -.\uninstall-docker-ce.ps1 121 +{ 122 + "data-root": "d:\\docker" 123 +} 158 158 {{/code}} 159 159 126 +If not specified, the default is {{code language="cmd"}}c:\programdata\docker{{/code}} 127 + 128 +{{/info}} 129 + 160 160 == 4. Key takeaways == 161 161 162 -* eMagiz uses runtime images to deploy theeMagiz runtime onDockerized environments. The runtime image holds all the information and components required to run the runtime132 +* 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 163 163 * eMagiz has a specific agent that manages the download of that image to the on-premises server 164 -* The firewall of the on-premises environment should allow outgoing traffic without any restriction s. Ifthat is not desirable, eMagiz can provide the addresses and ports needed to setup theappropriatefirewall rules.134 +* 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. 165 165 166 166 == 5. Suggested Additional Readings == 167 167 168 -* [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]] 169 -** [[eMagiz Runtime Generation 3 (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]] 170 -* [[Release Information (Menu)>>doc:Main.Release Information.WebHome||target="blank"]] 171 -** [[Environment Templates (Navigation)>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]] 172 -* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]] 173 -** [[eMagiz Runtime Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome||target="blank"]] 174 -*** [[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"]] 175 -*** [[eMagiz Deploy agent (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]] 176 -* [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]] 177 -** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.WebHome||target="blank"]] 178 -*** [[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"]] 179 -* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]] 180 -** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome||target="blank"]] 181 -*** [[Install Docker for Linux (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-onpremises-server-linux-installguide.WebHome||target="blank"]] 182 -* [[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"]] 183 183 * Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]] 184 184 185 185 )))((({{toc/}}))){{/container}}{{/container}}