Skip to Content
Last modified by Erik Bakker on 2025/04/18 13:54
From version 111.1
edited by Carlijn Kokkeler
on 2024/03/28 10:31
Change comment: There is no comment for this version
To version 49.1
edited by eMagiz
on 2023/02/06 08:43
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 this microlearning, we will focus on how an on-premises server can be prepared for a eMagiz Deploy agent installation.
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  
... ... @@ -10,106 +10,180 @@
10 10  
11 11  == 2. Key concepts ==
12 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 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 -
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
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
42 42  
43 -* When using a cloudslot number **above** 125, the following configuration is needed to communicate to your JMS.
44 - ** 3.74.209.20:443
45 - ** 3.76.127.155:443
46 - ** 3.74.209.20:8443
47 - ** 3.76.127.155:8443
48 - ** 3.74.209.20:8444
49 - ** 3.76.127.155:8444{{/warning}}
33 +===3.3 Installation requirements Windows Server 2022===
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.
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
53 53  
40 +===3.3 Installation requirements Windows Server 2022 (without Docker Desktop) ===
41 +
42 +**Step 1: Install linux distribution**
54 54  
55 -==== 3.2.1 Docker Installation ====
56 -To install or update docker on your machine, execute the following commands in powershell with administrative rights:
57 -
58 58  {{code language="cmd"}}
59 -Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/microsoft/Windows-Containers/Main/helpful_tools/Install-DockerCE/install-docker-ce.ps1" -o install-docker-ce.ps1
60 -.\install-docker-ce.ps1
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
61 61  {{/code}}
62 62  
63 -Example usage:
64 64  
52 +**Step 2: Install Docker **
53 +
65 65  {{code language="cmd"}}
66 -.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
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
67 67  {{/code}}
68 68  
69 -To install the latest version of docker you can use {{code language="cmd"}}e .\install-update-docker-ce.ps1{{/code}} without specifying the version flag.
61 +{{info}}
62 + Requires ~335 Mb space to install
63 +{{/info}}
70 70  
71 -{{info}}eMagiz suggests a specific version of docker to install, please see Section ..{{/info}}
72 72  
73 -{{warning}}Note: This process is service affecting, your running containers will be stopped and will need to be started again.{{/warning}}
74 74  
75 -==== 3.2.2 Check installation ====
67 +**Step 3: Install Java **
76 76  
77 -After executing the commands above, the server will restart if required. After the restart, execute the following command
78 -
79 79  {{code language="cmd"}}
80 -docker ps
70 + wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
71 + 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
72 + sudo apt update # update if you haven't already
73 + sudo apt install temurin-8-jdk
81 81  {{/code}}
82 82  
83 -If the command returns that the command cannot be found, please run the following command again.
76 +{{info}}
77 + Requires ~335 Mb space to install
78 +{{/info}}
84 84  
80 +**Step 3: Ensure Docker is autostarted with WSL **
81 +
85 85  {{code language="cmd"}}
86 -.\install-docker-ce.ps1
83 +nano .bashrc
84 +
85 + #Add following lines to bashrc
86 + DOCKER_DISTRO="Ubuntu"
87 + DOCKER_LOG_DIR=$HOME/docker_logs
88 + mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
89 + /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
87 87  {{/code}}
88 88  
89 -==== 3.2.3 Verify docker functionality ====
92 +#Do not ask password dockerd
93 +sudo visudo
90 90  
91 -Execute the following command
95 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
92 92  
93 -{{code language="cmd"}}
94 -docker ps
95 -{{/code}}
97 +#Set WSL config for memory
98 +USERDIR/.wslconfig
99 + # Settings apply across all Linux distros running on WSL 2
100 + [wsl2]
96 96  
97 -The result of this call should show the following:
102 + # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
103 + memory=16GB
98 98  
99 -[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
105 + # Sets the VM to use two virtual processors
106 + processors=2
100 100  
101 -==== 3.2.4 Install eMagiz Deploy Agent ====
108 +(Exit WSL: wsl --shutdown)
109 +
102 102  
103 -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"]]
111 +===3.4 Installation requirements Windows Server 2019 version >1806===
104 104  
105 -== 4. Key takeaways ==
113 +These are the requirements to allow the installation of the eMagiz Docker agent:
114 +* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
115 +* Validate if WSL 2.0 is properly installed
116 +* Go to the next section around installing the eMagiz Docker agent
106 106  
118 +===3.5 Installation requirements Windows Server 2019 version 1806===
119 +
120 +These are the requirements to allow the installation of the eMagiz Docker agent:
121 +* Enable Hyper-V in Windows Server
122 + ** 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.
123 + ** Restart windows
124 +* Cross check is WSL 2.0 is installed
125 + ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
126 +* Install Docker Desktop on the Windows Server
127 + ** Please refer to this link: https://www.docker.com/products/docker-desktop/
128 + ** Restart windows
129 +* Update Docker Desktop configuration
130 + ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
131 + ** Restart Docker
132 +* Open Powershell as Administrator
133 + ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
134 + ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
135 + ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
136 + ** Execute Add-AppxPackage .\ubuntu-2004.appx
137 + *** 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.
138 +* Ubuntu should now be a runnable program (press windows key, type ubuntu)
139 +* Open the ubuntu terminal, and finish the installation.
140 + ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
141 +* Go to the next section around installing the eMagiz Docker agent
142 +
143 +===3.6 Installation requirements Windows Server 2012 R2 ===
144 +
145 +These are the requirements to allow the installation of the eMagiz Docker agent:
146 +* Install & enable Hyper-V in Windows Server
147 + ** 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.
148 + ** Restart windows
149 +* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
150 +* Create a VM in HyperV.
151 + ** 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).
152 + ** Configure a virtual switch.
153 + ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
154 + ** Install an operating system from bootable CD/DVD, ISO file
155 +* Install ubuntu downloaded previously on the VM
156 +* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
157 +* Go to the next section around installing the eMagiz agent
158 +
159 +=== 3.7 eMagiz Docker agent installation ===
160 +
161 +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.
162 +
163 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
164 +
165 +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.
166 +
167 +== 4. Assignment ==
168 +
169 +Check out the cheatcheet for Docker command line:
170 +
171 +[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
172 +
173 +== 5. Key takeaways ==
174 +
107 107  * 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
108 108  * eMagiz has a specific agent that manages the download of that image to the on-premises server
109 109  * 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.
110 110  
111 -== 5. Suggested Additional Readings ==
112 112  
113 -* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
114 114  
181 +== 6. Suggested Additional Readings ==
182 +
183 +N/A
184 +
185 +== 7. Silent demonstration video ==
186 +
187 +N/A
188 +
115 115  )))((({{toc/}}))){{/container}}{{/container}}