Changes for page Install Docker for Windows

Summary

• Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.CarlijnKokkeler
	1	+XWiki.ebakker

Content

...	...	@@ -1,5 +1,5 @@
1	1	{{container}}{{container layoutStyle="columns"}}(((
2		-In eMagiz's new 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.
	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.
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 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.
	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	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,22 +17,22 @@
17	17
18	18	===3.1 General requirements===
19	19
	20	+{{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 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	+
20	20	{{info}}
21	21	* Standard configuration to ensure that communication between your server and eMagiz to ensure communication.
22	22	** registry.emagiz.com:443
23		- ** controlplane.emagiz.com:8000
	26	+ ** controlplane.emagiz.com:443
	27	+ ** controlplane-agent.emagiz.com:443
	28	+ ** controltower.emagiz.com:443
24	24	** controltower.kpn-dsh.com:443
	30	+ ** controlbus.emagiz.com:443
25	25	** Preferably the entry should be *.emagiz.com
26	26	** Preferably the entry should be *.kpn-dsh.com{{/info}}
27	27
28	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.
	35	+* When using **IP Whitelisting**, the following configuration is needed to communicate to your JMS.
36	36	** 35.158.46.28:443
37	37	** 3.74.190.88:443
38	38	** 35.158.46.28:8443
...	...	@@ -39,21 +39,23 @@
39	39	** 3.74.190.88:8443
40	40	** 35.158.46.28:8444
41	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	44	** 3.74.209.20:443
45	45	** 3.76.127.155:443
46	46	** 3.74.209.20:8443
47	47	** 3.76.127.155:8443
48	48	** 3.74.209.20:8444
49		- ** 3.76.127.155:8444{{/warning}}
	47	+ ** 3.76.127.155:8444
	48	+ ** 18.199.123.240
	49	+ ** 18.184.211.189
	50	+ ** 3.123.136.31{{/warning}}
50	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	53
54	54
	54	+===3.2 Installation Windows===
	55	+When Windows is selected as the operating system, you need Windows Server 2022. Older Windows servers are **not** supported.
	56	+
55	55	==== 3.2.1 Docker Installation ====
56		-To install or update docker on your machine, execute the following commands in powershell with administrative rights:
	58	+To install Docker on your machine, execute the following commands in PowerShell with administrative rights:
57	57
58	58	{{code language="cmd"}}
59	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,28 +60,38 @@
60	60	.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
61	61	{{/code}}
62	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	+==== 3.2.2 Customization ====
65	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"]].
	67	+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"]].
69	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:
	69	+{{warning}}Be aware that the customization will only take effect once you have restarted the machine.{{/warning}}
72	72
	71	+===== 3.2.2.1 IP address range =====
	72	+
	73	+Below is the code needed to configure a different IP address range.
	74	+
73	73	{{code language="cmd"}}
	76	+cd C:\ProgramData\Docker\config\daemon.json
	77	+#Add the following lines
	78	+{"fixed-cidr": "<ip-address>"}
	79	+{{/code}}
	80	+
	81	+===== 3.2.2.2 Data location =====
	82	+
	83	+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:
	84	+
	85	+{{code language="cmd"}}
	86	+cd C:\ProgramData\Docker\config\daemon.json
	87	+#Add the following lines
74	74	{
75	75	"data-root": "d:\\docker"
76	76	}
77	77	{{/code}}
78	78
79		-If not specified, the default is {{code language="cmd"}}c:\programdata\docker{{/code}}.
	93	+{{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}}
80	80
81		-{{/info}}
	95	+==== 3.2.3 Check installation ====
82	82
83		-==== 3.2.2 Check installation ====
84		-
85	85	After executing the commands above, the server will restart if required. After the restart, execute the following command
86	86
87	87	{{code language="cmd"}}
...	...	@@ -88,13 +88,13 @@
88	88	docker ps
89	89	{{/code}}
90	90
91		-If the command returns that the command cannot be found, please run the following command again.
	103	+If the command returns "command not found," please run the following command again.
92	92
93	93	{{code language="cmd"}}
94	94	.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
95	95	{{/code}}
96	96
97		-==== 3.2.3 Verify docker functionality ====
	109	+==== 3.2.3 Verify Docker functionality ====
98	98
99	99	Execute the following command
100	100
...	...	@@ -108,12 +108,25 @@
108	108
109	109	==== 3.2.4 Install eMagiz Deploy Agent ====
110	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"]]
	123	+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"]]
112	112
113		-===3.3 Uninstall Docker===
114		-To uninstall docker from your machine, execute the following commands in powershell with administrative rights:
	125	+=== 3.3 Update Docker ===
	126	+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:
115	115
116	116	{{code language="cmd"}}
	129	+docker version
	130	+{{/code}}
	131	+
	132	+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:
	133	+
	134	+{{code language="cmd"}}
	135	+.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
	136	+{{/code}}
	137	+
	138	+===3.4 Uninstall Docker===
	139	+To uninstall Docker from your machine, execute the following commands in PowerShell with administrative rights:
	140	+
	141	+{{code language="cmd"}}
117	117	Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Uninstall-docker/uninstall-docker.ps1" -o uninstall-docker-ce.ps1
118	118	{{/code}}
119	119
...	...	@@ -125,14 +125,14 @@
125	125
126	126	== 4. Key takeaways ==
127	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
	153	+* 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
129	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.
	155	+* 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.
131	131
132	132	== 5. Suggested Additional Readings ==
133	133
134		-** [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
135		-*** [[eMagiz Runtime Generation 3 (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]]
	159	+* [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
	160	+** [[eMagiz Runtime Generation 3 (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]]
136	136	* [[Release Information (Menu)>>doc:Main.Release Information.WebHome||target="blank"]]
137	137	** [[Environment Templates (Navigation)>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]]
138	138	* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]