Install Docker for Windows

{{container}}{{container layoutStyle="columns"}}(((

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

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 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

== 3. On-premises deployments ==

17

18

===3.1 General requirements===

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"]].

* Standard configuration to ensure that communication between your server and eMagiz to ensure communication.

25

** registry.emagiz.com:443

26

** controlplane.emagiz.com:443

27

** controlplane-agent.emagiz.com:443

28

** controltower.emagiz.com:443

29

** controltower.kpn-dsh.com:443

30

** controlbus.emagiz.com:443

31

** {yourcloudslotid}.emagizcloud.com:8443

32

33

* Preferably we suggest to implement the following entries on DNS level.

34

** *.emagizcloud.com

35

** *.emagiz.com

36

** *.kpn-dsh.com{{/info}}

37

38

39

* When using **IP Whitelisting**, the following configuration is needed to communicate to your JMS.

** 35.158.46.28:443

** 3.74.190.88:443

** 35.158.46.28:8443

** 3.74.190.88:8443

** 35.158.46.28:8444

** 3.74.190.88:8444

** 3.74.209.20:443

** 3.76.127.155:443

** 3.74.209.20:8443

** 3.76.127.155:8443

** 3.74.209.20:8444

** 3.76.127.155:8444

** 18.199.123.240

** 18.184.211.189

** 3.123.136.31{{/warning}}

===3.2 Installation Windows===

59

When Windows is selected as the operating system, you need Windows Server 2022. Older Windows servers are **not** supported.

60

61

==== 3.2.1 Docker Installation ====

62

To install Docker on your machine, execute the following commands in PowerShell with administrative rights:

63

64

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

67

68

69

==== 3.2.2 Customization ====

70

71

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"]].

72

73

{{warning}}Be aware that the customization will only take effect once you have restarted the machine.{{/warning}}

74

75

===== 3.2.2.1 IP address range =====

76

77

Below is the code needed to configure a different IP address range.

78

79

80

cd C:\ProgramData\Docker\config\daemon.json

81

#Add the following lines

82

{"fixed-cidr": "<ip-address>"}

83

84

85

===== 3.2.2.2 Data location =====

86

87

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:

88

89

90

cd C:\ProgramData\Docker\config\daemon.json

91

#Add the following lines

92

{

93

"data-root": "d:\\docker"

}

{{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}}

98

99

==== 3.2.3 Check installation ====

100

101

After executing the commands above, the server will restart if required. After the restart, execute the following command

docker ps

If the command returns "command not found," please run the following command again.

108

109

110

.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION

111

112

113

==== 3.2.3 Verify Docker functionality ====

114

115

Execute the following command

docker ps

The result of this call should show the following:

122

123

[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]

124

125

==== 3.2.4 Install eMagiz Deploy Agent ====

126

127

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"]]

128

129

=== 3.3 Update Docker ===

130

When you are advised to update your Docker version, you can verify whether you are on the correct Docker version by executing the following command in PowerShell with administrative rights:

docker version

When this returns a version **lower** than the advised version shown under the "General requirements" section, you can update Docker on your machine. To do so, execute the following command in PowerShell with administrative rights:

137

138

139

.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION

140

141

142

{{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}}

143

144

===3.4 Uninstall Docker===

145

To uninstall Docker from your machine, execute the following commands in PowerShell with administrative rights:

146

147

148

Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Uninstall-docker/uninstall-docker.ps1" -o uninstall-docker-ce.ps1

Example usage:

.\uninstall-docker-ce.ps1

155

156

157

== 4. Key takeaways ==

158

159

* eMagiz uses runtime images to deploy the eMagiz runtime on Dockerized environments. The runtime image holds all the information and components required to run the runtime

160

* eMagiz has a specific agent that manages the download of that image to the on-premises server

161

* The firewall of the on-premises environment should allow outgoing traffic without any restrictions. If that is not desirable, eMagiz can provide the addresses and ports needed to set up the appropriate firewall rules.

162

163

== 5. Suggested Additional Readings ==

164

165

* [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]

166

** [[eMagiz Runtime Generation 3 (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]]

167

* [[Release Information (Menu)>>doc:Main.Release Information.WebHome||target="blank"]]

168

** [[Environment Templates (Navigation)>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]]

169

* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]

170

** [[eMagiz Runtime Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome||target="blank"]]

171

*** [[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"]]

172

*** [[eMagiz Deploy agent (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]

173

* [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]

174

** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.WebHome||target="blank"]]

175

*** [[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"]]

176

* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]

177

** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome||target="blank"]]

178

*** [[Install Docker for Linux (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-onpremises-server-linux-installguide.WebHome||target="blank"]]

179

* [[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"]]

180

* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]

181

182

)))((({{toc/}}))){{/container}}{{/container}}

Wiki source code of Install Docker for Windows