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

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

24

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

29

** Preferably the entry should be *.emagiz.com

30

** Preferably the entry should be *.kpn-dsh.com{{/info}}

31

32

33

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

49

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.

52

53

54

==== 3.2.1 Docker Installation ====

55

To install or update docker on your machine, execute the following commands in powershell with administrative rights:

56

57

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

61

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

64

65

==== 3.2.2 Customization ====

66

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

68

69

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

70

71

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

72

73

Below you can find the code necessary to configure a different IP address range.

74

75

76

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

77

#Add following lines

78

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

79

80

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:

84

85

86

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

87

#Add following lines

88

{

89

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

94

95

==== 3.2.3 Check installation ====

96

97

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

docker ps

If the command returns that the command cannot be found, please run the following command again.

104

105

106

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

107

108

109

==== 3.2.3 Verify docker functionality ====

110

111

Execute the following command

docker ps

The result of this call should show the following:

118

119

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

120

121

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

122

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

124

125

===3.3 Uninstall Docker===

126

To uninstall docker from your machine, execute the following commands in powershell with administrative rights:

127

128

129

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

136

137

138

== 4. Key takeaways ==

139

140

* 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

141

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

142

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

143

144

== 5. Suggested Additional Readings ==

145

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

162

163

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

Wiki source code of Install Docker for Windows