Skip to Content
Last modified by Erik Bakker on 2026/01/30 10:56
From version 30.1
edited by eMagiz
on 2022/11/18 13:23
Change comment: There is no comment for this version
To version 138.2
edited by Bas Elzinga
on 2024/12/17 12:19
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -On-premises deployment new runtime architecture
1 +Install Docker for Windows
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.eMagiz
1 +XWiki.BasElzinga
Content
... ... @@ -1,5 +1,5 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -In this microlearning, we will focus on how the installation requirements for on-premises deployments of eMagiz runtimes that are part of the new runtime architecture. The new runtime architecture uses a containerized approach to deploy runtimes.
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,106 +9,160 @@
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.
13 -
14 -In the below section the specific operating systems and versions are discussed in a sense that the prerequisite installations are described. Once the right installation is done, refer to section 3.7 for the installation of the eMagiz agent that manages the interaction with the eMagiz platform. That agent will download the created docker images that will be deployed in the Docker environment.
15 -
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 16  == 3. On-premises deployments ==
17 17  
18 18  ===3.1 General requirements===
19 -
20 -These are the general requirements to allow the installation of the eMagiz Docker agent:
21 -* Ensure access to the following URLs is enabled
22 - ** registry.emagiz.com
23 - ** testing.emagiz.com
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: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
24 24   ** Preferably the entry should be *.emagiz.com
25 -
26 -===3.2 Installation requirements Linux===
30 + ** Preferably the entry should be *.kpn-dsh.com{{/info}}
27 27  
28 -* Install latest version of the Docker engine - see for instance https://docs.docker.com/engine/install/ubuntu/
29 -* Go to the next section around installing the eMagiz agent
32 +{{warning}}
33 +* When using cloudslot number **equal to or below** 125, the following configuration is needed to communicate to your JMS.
34 + ** 35.158.46.28:443
35 + ** 3.74.190.88:443
36 + ** 35.158.46.28:8443
37 + ** 3.74.190.88:8443
38 + ** 35.158.46.28:8444
39 + ** 3.74.190.88:8444
40 + ** 18.199.123.240
41 + ** 18.184.211.189
42 + ** 3.123.136.31
30 30  
31 -===3.3 Installation requirements Windows Server 2022===
44 +* When using a cloudslot number **above** 125, the following configuration is needed to communicate to your JMS.
45 + ** 3.74.209.20:443
46 + ** 3.76.127.155:443
47 + ** 3.74.209.20:8443
48 + ** 3.76.127.155:8443
49 + ** 3.74.209.20:8444
50 + ** 3.76.127.155:8444
51 + ** 18.199.123.240
52 + ** 18.184.211.189
53 + ** 3.123.136.31{{/warning}}
32 32  
33 -These are the requirements to allow the installation of the eMagiz Docker agent:
34 -* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
35 -* Validate if WSL 2.0 is properly installed
36 -* Go to the next section around installing the eMagiz Docker agent
55 +===3.2 Installation Windows===
56 +Whenever Windows is selected as operating system, you need to have a Windows Server 2022 version. Older Windows servers are **not** supported.
37 37  
38 -===3.4 Installation requirements Windows Server 2019 version >1806===
39 39  
40 -These are the requirements to allow the installation of the eMagiz Docker agent:
41 -* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
42 -* Validate if WSL 2.0 is properly installed
43 -* Go to the next section around installing the eMagiz Docker agent
59 +==== 3.2.1 Docker Installation ====
60 +To install or update docker on your machine, execute the following commands in powershell with administrative rights:
61 +
62 +{{code language="cmd"}}
63 +Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Install-update-docker/install-update-docker.ps1" -o install-update-docker-ce.ps1
64 +.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
65 +{{/code}}
66 +
67 +{{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"]].
68 +{{/info}}
69 +
70 +==== 3.2.2 Customization ====
71 +
72 +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"]].
73 +
74 +{{warning}}Be aware that the customization will only take effect once you have restarted the machine.{{/warning}}
75 +
76 +===== 3.2.2.1 IP address range =====
44 44  
45 -===3.5 Installation requirements Windows Server 2019 version 1806===
78 +Below you can find the code necessary to configure a different IP address range.
46 46  
47 -These are the requirements to allow the installation of the eMagiz Docker agent:
48 -* Enable Hyper-V in Windows Server
49 - ** Go to Server Manager, Manage (top right), enable roles and features, select the desired roles and server selections. In the Features section, enable Hyper-V.
50 - ** Restart windows
51 -* Cross check is WSL 2.0 is installed
52 - ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
53 -* Install Docker Desktop on the Windows Server
54 - ** Please refer to this link: https://www.docker.com/products/docker-desktop/
55 - ** Restart windows
56 -* Update Docker Desktop configuration
57 - ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
58 - ** Restart Docker
59 -* Open Powershell as Administrator
60 - ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
61 - ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
62 - ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
63 - ** Execute Add-AppxPackage .\ubuntu-2004.appx
64 - *** If errors occur, please consult https://learn.microsoft.com/en-us/windows/wsl/install-on-server. Rename the file to a zip, expand it, and add it to the path variable.
65 -* Ubuntu should now be a runnable program (press windows key, type ubuntu)
66 -* Open the ubuntu terminal, and finish the installation.
67 - ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
68 -* Go to the next section around installing the eMagiz Docker agent
80 +{{code language="cmd"}}
81 +cd C:\ProgramData\Docker\config\daemon.json
82 +#Add following lines
83 +{"fixed-cidr": "<ip-address>"}
84 +{{/code}}
85 +
86 +===== 3.2.2.2 Data location =====
69 69  
70 -===3.6 Installation requirements Windows Server 2012 R2 ===
71 -
72 -These are the requirements to allow the installation of the eMagiz Docker agent:
73 -* Install & enable Hyper-V in Windows Server
74 - ** Go to Server Manager, Manage (top right), enable roles and features, select the desired roles and server selections. In the Features section, enable Hyper-V.
75 - ** Restart windows
76 -* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
77 -* Create a VM in HyperV.
78 - ** For this, choose Generation 1, the amount of memory you want to assign to ubuntu and thus to the containers. Please consider the overhead for memory as well (such as OS).
79 - ** Configure a virtual switch.
80 - ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
81 - ** Install an operating system from bootable CD/DVD, ISO file
82 -* Install ubuntu downloaded previously on the VM
83 -* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
84 -* Go to the next section around installing the eMagiz agent
85 -
86 -=== 3.7 eMagiz Docker agent installation ===
87 -
88 -eMagiz needs to install a specific agent in the Docker instance that allows to download runtime images that needs to be installed on the Docker instance. The specific command to run inside the Docker instance is specific for the machine that is configured inside eMagiz Design & Deploy Architectures. It can be found inside the eMagiz iPaaS portal when the machine is used for the first time deployment of eMagiz runtimes. A popup will appear that displays the commands per type of OS. Once that agent is installed, the image that is generated for every eMagiz release can be downloaded and installed in the Docker instance.
88 +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:
89 89  
90 -After installing the agent, you can use the Docker cheat sheet below to see if the docker containers are running and/or images are available.
90 +{{code language="cmd"}}
91 +cd C:\ProgramData\Docker\config\daemon.json
92 +#Add following lines
93 +{
94 + "data-root": "d:\\docker"
95 +}
96 +{{/code}}
91 91  
92 -== 4. Assignment ==
98 +{{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}}
93 93  
94 -Check out the cheatcheet for Docker command line:
95 -
96 -[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
100 +==== 3.2.3 Check installation ====
97 97  
98 -== 5. Key takeaways ==
102 +After executing the commands above, the server will restart if required. After the restart, execute the following command
99 99  
100 -* 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
101 -* eMagiz has a specific agent that manages the download of that image to the on-premises server
102 -* 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.
104 +{{code language="cmd"}}
105 +docker ps
106 +{{/code}}
103 103  
108 +If the command returns that the command cannot be found, please run the following command again.
104 104  
110 +{{code language="cmd"}}
111 +.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
112 +{{/code}}
105 105  
106 -== 6. Suggested Additional Readings ==
114 +==== 3.2.3 Verify docker functionality ====
107 107  
108 -N/A
109 -
110 -== 7. Silent demonstration video ==
116 +Execute the following command
111 111  
112 -N/A
118 +{{code language="cmd"}}
119 +docker ps
120 +{{/code}}
113 113  
122 +The result of this call should show the following:
123 +
124 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
125 +
126 +==== 3.2.4 Install eMagiz Deploy Agent ====
127 +
128 +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"]]
129 +
130 +===3.3 Uninstall Docker===
131 +To uninstall docker from your machine, execute the following commands in powershell with administrative rights:
132 +
133 +{{code language="cmd"}}
134 +Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Uninstall-docker/uninstall-docker.ps1" -o uninstall-docker-ce.ps1
135 +{{/code}}
136 +
137 +Example usage:
138 +
139 +{{code language="cmd"}}
140 +.\uninstall-docker-ce.ps1
141 +{{/code}}
142 +
143 +== 4. Key takeaways ==
144 +
145 +* 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
146 +* eMagiz has a specific agent that manages the download of that image to the on-premises server
147 +* 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.
148 +
149 +== 5. Suggested Additional Readings ==
150 +
151 +* [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
152 +** [[eMagiz Runtime Generation 3 (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]]
153 +* [[Release Information (Menu)>>doc:Main.Release Information.WebHome||target="blank"]]
154 +** [[Environment Templates (Navigation)>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]]
155 +* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
156 +** [[eMagiz Runtime Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome||target="blank"]]
157 +*** [[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"]]
158 +*** [[eMagiz Deploy agent (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
159 +* [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]
160 +** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.WebHome||target="blank"]]
161 +*** [[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"]]
162 +* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
163 +** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome||target="blank"]]
164 +*** [[Install Docker for Linux (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-onpremises-server-linux-installguide.WebHome||target="blank"]]
165 +* [[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"]]
166 +* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
167 +
114 114  )))((({{toc/}}))){{/container}}{{/container}}