Skip to Content
Last modified by Erik Bakker on 2025/04/18 13:54
From version 134.1
edited by Carlijn Kokkeler
on 2024/10/25 11:39
Change comment: There is no comment for this version
To version 51.1
edited by eMagiz
on 2023/02/06 09:32
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Install Docker for Windows
1 +On-premise Install Guide
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.CarlijnKokkeler
1 +XWiki.eMagiz
Content
... ... @@ -1,5 +1,5 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
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.
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.
3 3  
4 4  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
... ... @@ -9,149 +9,179 @@
9 9  * Good understanding of eMagiz runtimes in general
10 10  
11 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 -
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 +
16 16  == 3. On-premises deployments ==
17 17  
18 18  ===3.1 General requirements===
19 -
20 -{{info}}
21 -* Standard configuration to ensure that communication between your server and eMagiz to ensure communication.
22 - ** registry.emagiz.com:443
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:8443
23 23   ** controlplane.emagiz.com:8000
24 - ** controltower.kpn-dsh.com:443
25 25   ** Preferably the entry should be *.emagiz.com
26 - ** Preferably the entry should be *.kpn-dsh.com{{/info}}
27 27  
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
26 +
27 +===3.2 Installation requirements Linux===
34 34  
35 -* When using cloudslot number **equal to or below** 125, the following configuration is needed to communicate to your JMS.
36 - ** 35.158.46.28:443
37 - ** 3.74.190.88:443
38 - ** 35.158.46.28:8443
39 - ** 3.74.190.88:8443
40 - ** 35.158.46.28:8444
41 - ** 3.74.190.88:8444
42 - ** 18.199.123.240
43 - ** 18.184.211.189
44 - ** 3.123.136.31
29 +* Whenever Linux is selected as operating system, the latest version of Ubuntu will work
30 +* Install latest version of the Docker engine - see for instance {{code}}https://docs.docker.com/engine/install/ubuntu/{{/code}}
31 +* Go to the next section around installing the eMagiz agent
45 45  
46 -* When using a cloudslot number **above** 125, the following configuration is needed to communicate to your JMS.
47 - ** 3.74.209.20:443
48 - ** 3.76.127.155:443
49 - ** 3.74.209.20:8443
50 - ** 3.76.127.155:8443
51 - ** 3.74.209.20:8444
52 - ** 3.76.127.155:8444
53 - ** 18.199.123.240
54 - ** 18.184.211.189
55 - ** 3.123.136.31{{/warning}}
33 +===3.3 Installation requirements Windows Server 2022===
56 56  
57 -===3.2 Installation Windows===
58 -Whenever Windows is selected as operating system, you need to have a Windows Server 2022 version. Older Windows servers are **not** supported.
35 +These are the requirements to allow the installation of the eMagiz Docker agent:
36 +* Install latest version of Docker Desktop from {{code}}https://www.docker.com/products/docker-desktop/{{/code}}
37 +* Validate if WSL 2.0 is properly installed
38 +* Go to the next section around installing the eMagiz Docker agent
59 59  
40 +===3.3 Installation requirements Windows Server 2022 (without Docker Desktop) ===
41 +
42 +**Step 1: Install linux distribution**
60 60  
61 -==== 3.2.1 Docker Installation ====
62 -To install or update docker on your machine, execute the following commands in powershell with administrative rights:
63 -
64 64  {{code language="cmd"}}
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
45 + wsl --install -d Ubuntu
46 + sudo apt-get update
47 + sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
48 + . /etc/os-release
67 67  {{/code}}
68 68  
69 -{{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"]].
70 -{{/info}}
71 71  
72 -{{info}}
73 -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}}.
74 -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"]].
52 +**Step 2: Install Docker **
75 75  
76 -**Example usage of the Docker daemon file**: You maybe want the Docker daemon to keep images and containers in an alternate path (D:
77 -drive for example). To do so you can add the following attribute to the Docker daemon file:
78 -
79 79  {{code language="cmd"}}
80 -{
81 - "data-root": "d:\\docker"
82 -}
55 + curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
56 + echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
57 + sudo apt update
58 + sudo apt install docker-ce docker-ce-cli containerd.io
83 83  {{/code}}
84 84  
85 -If not specified, the default is {{code language="cmd"}}c:\programdata\docker{{/code}}.
86 -
61 +{{info}}
62 + Requires ~335 Mb space to install
87 87  {{/info}}
88 88  
89 -==== 3.2.2 Check installation ====
65 +**Step 3: Install Java **
90 90  
91 -After executing the commands above, the server will restart if required. After the restart, execute the following command
92 -
93 93  {{code language="cmd"}}
94 -docker ps
68 + wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
69 + echo "deb https://packages.adoptium.net/artifactory/deb $(awk -F= '/^VERSION_CODENAME/{print$2}' /etc/os-release) main" | sudo tee /etc/apt/sources.list.d/adoptium.list
70 + sudo apt update # update if you haven't already
71 + sudo apt install temurin-8-jdk
95 95  {{/code}}
96 96  
97 -If the command returns that the command cannot be found, please run the following command again.
74 +{{info}}
75 + Requires ~335 Mb space to install
76 +{{/info}}
98 98  
78 +**Step 4: Ensure Docker is autostarted with WSL **
79 +
99 99  {{code language="cmd"}}
100 -.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
81 +nano .bashrc
82 +
83 + #Add following lines to bashrc
84 + DOCKER_DISTRO="Ubuntu"
85 + DOCKER_LOG_DIR=$HOME/docker_logs
86 + mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
87 + /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
101 101  {{/code}}
102 102  
103 -==== 3.2.3 Verify docker functionality ====
90 +**Step 4: Add user to Docker group **
104 104  
105 -Execute the following command
92 +sudo visudo
93 + #Add following lines to bashrc
94 +
95 + # Don't ask for password
96 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
97 + #Set WSL config for memory
98 + USERDIR/.wslconfig
99 + # Settings apply across all Linux distros running on WSL 2
100 + [wsl2]
101 + # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
102 + memory=16GB
103 + # Sets the VM to use two virtual processors
104 + processors=2
106 106  
107 -{{code language="cmd"}}
108 -docker ps
109 -{{/code}}
106 +(Exit WSL: wsl --shutdown)
107 +
110 110  
111 -The result of this call should show the following:
109 +===3.4 Installation requirements Windows Server 2019 version >1806===
112 112  
113 -[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
111 +These are the requirements to allow the installation of the eMagiz Docker agent:
112 +* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
113 +* Validate if WSL 2.0 is properly installed
114 +* Go to the next section around installing the eMagiz Docker agent
114 114  
115 -==== 3.2.4 Install eMagiz Deploy Agent ====
116 +===3.5 Installation requirements Windows Server 2019 version 1806===
116 116  
117 -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"]]
118 +These are the requirements to allow the installation of the eMagiz Docker agent:
119 +* Enable Hyper-V in Windows Server
120 + ** 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.
121 + ** Restart windows
122 +* Cross check is WSL 2.0 is installed
123 + ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
124 +* Install Docker Desktop on the Windows Server
125 + ** Please refer to this link: https://www.docker.com/products/docker-desktop/
126 + ** Restart windows
127 +* Update Docker Desktop configuration
128 + ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
129 + ** Restart Docker
130 +* Open Powershell as Administrator
131 + ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
132 + ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
133 + ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
134 + ** Execute Add-AppxPackage .\ubuntu-2004.appx
135 + *** 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.
136 +* Ubuntu should now be a runnable program (press windows key, type ubuntu)
137 +* Open the ubuntu terminal, and finish the installation.
138 + ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
139 +* Go to the next section around installing the eMagiz Docker agent
118 118  
119 -===3.3 Uninstall Docker===
120 -To uninstall docker from your machine, execute the following commands in powershell with administrative rights:
141 +===3.6 Installation requirements Windows Server 2012 R2 ===
121 121  
122 -{{code language="cmd"}}
123 -Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Uninstall-docker/uninstall-docker.ps1" -o uninstall-docker-ce.ps1
124 -{{/code}}
143 +These are the requirements to allow the installation of the eMagiz Docker agent:
144 +* Install & enable Hyper-V in Windows Server
145 + ** 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.
146 + ** Restart windows
147 +* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
148 +* Create a VM in HyperV.
149 + ** 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).
150 + ** Configure a virtual switch.
151 + ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
152 + ** Install an operating system from bootable CD/DVD, ISO file
153 +* Install ubuntu downloaded previously on the VM
154 +* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
155 +* Go to the next section around installing the eMagiz agent
125 125  
126 -Example usage:
157 +=== 3.7 eMagiz Docker agent installation ===
127 127  
128 -{{code language="cmd"}}
129 -.\uninstall-docker-ce.ps1
130 -{{/code}}
159 +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 under Deploy Architecture. At the runtime connector, there is a right click option called Deploy Agent. That presents either the command or the location where that agent is installed.
131 131  
132 -== 4. Key takeaways ==
161 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
133 133  
163 +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.
164 +
165 +== 4. Assignment ==
166 +
167 +Check out the cheatcheet for Docker command line:
168 +
169 +[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
170 +
171 +== 5. Key takeaways ==
172 +
134 134  * 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
135 135  * eMagiz has a specific agent that manages the download of that image to the on-premises server
136 136  * 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.
137 137  
138 -== 5. Suggested Additional Readings ==
139 139  
140 -* [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
141 -** [[eMagiz Runtime Generation 3 (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]]
142 -* [[Release Information (Menu)>>doc:Main.Release Information.WebHome||target="blank"]]
143 -** [[Environment Templates (Navigation)>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]]
144 -* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
145 -** [[eMagiz Runtime Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome||target="blank"]]
146 -*** [[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"]]
147 -*** [[eMagiz Deploy agent (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
148 -* [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]
149 -** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.WebHome||target="blank"]]
150 -*** [[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"]]
151 -* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
152 -** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome||target="blank"]]
153 -*** [[Install Docker for Linux (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-onpremises-server-linux-installguide.WebHome||target="blank"]]
154 -* [[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"]]
155 -* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
156 156  
179 +== 6. Suggested Additional Readings ==
180 +
181 +N/A
182 +
183 +== 7. Silent demonstration video ==
184 +
185 +N/A
186 +
157 157  )))((({{toc/}}))){{/container}}{{/container}}