Skip to Content
Last modified by Erik Bakker on 2025/04/18 13:54
From version 83.1
edited by eMagiz
on 2023/04/11 15:15
Change comment: There is no comment for this version
To version 39.1
edited by Erik Bakker
on 2023/01/23 12:25
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Pre-requisite installation of on-premises server
1 +On-premise Install Guide
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.eMagiz
1 +XWiki.ebakker
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  
... ... @@ -11,11 +11,12 @@
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 13  
14 -In the below section the Windows and Linux variants are described in terms of how to prepare the server to allow the eMagiz Deploy agent to be installed. That agent allows to download images from the eMagiz infrastructure.
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 15  
16 16  == 3. On-premises deployments ==
17 17  
18 18  ===3.1 General requirements===
19 +
19 19  These are the general requirements to allow the installation of the eMagiz Docker agent:
20 20  * Ensure access to the following URLs is enabled
21 21   ** registry.emagiz.com:8443
... ... @@ -22,134 +22,74 @@
22 22   ** controlplane.emagiz.com:8000
23 23   ** Preferably the entry should be *.emagiz.com
24 24  
26 +
25 25  ===3.2 Installation requirements Linux===
26 -Whenever Linux is selected as operating system, the latest version of Ubuntu will work. Other Linux distributions will also work such as Debian or Red Hat.
27 -**Step 1: Install linux distribution**
28 -Follow all steps in section 3.4
29 29  
30 -**Step 2: Install eMagiz Deploy Agent**
31 -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"]]
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
32 32  
33 -===3.3 Installation requirements Windows Server 2022 ===
33 +===3.3 Installation requirements Windows Server 2022===
34 34  
35 -{{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
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
36 36  
37 -The steps below will install a linux subsystem under Windows. In that Linux system, Docker and Java will be installed. Please note that the Windows server needs to be able to run Virtualized (either via BIOS setting or via Nested Virtualization).
40 + #Install docker
41 +{{code}}
42 +sudo apt-get update
43 +sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
44 +. /etc/os-release
45 +curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
46 +echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
47 +sudo apt update
48 +sudo apt install docker-ce docker-ce-cli containerd.io{{/code}}
38 38  
39 -**Step 1: Install linux distribution**
50 +#Install Java
51 +{{code language="unix"}}
52 +wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
53 +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
54 +sudo apt update # update if you haven't already
55 +sudo apt install temurin-8-jdk{{/code}}
40 40  
41 -{{code language="cmd"}}
42 - wsl --install -d Ubuntu
43 - sudo apt-get update
44 - sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
45 - . /etc/os-release
46 -{{/code}}
57 +#Autostart Dockerd with wsl
47 47  
48 -**Step 2: Configure linux system**
49 -Please see section 3.4 for these these steps
50 -
51 -**Step 3: Update wsl config file **
52 -In this step we need to add or update the WSL config file that manages the resources of the Linux subsystem. Important resources to manage are the assigned memory and number of processors. For memory we recommend to review the mempory settings for the runtime that need to run on this server and add 762 MB to the total value of the heap and non-heap of these runtimes. For processor we recommend to set the value to 2 - depending on the amount of processors available on that machine
53 -
54 -First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
55 -
56 -{{code language="cmd"}}
57 - #Add following lines
58 -
59 - # Settings apply across all Linux distros running on WSL 2
60 - [wsl2]
61 - # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
62 - memory=16GB
63 - # Sets the VM to use two virtual processors
64 - processors=2
65 -{{/code}}
66 -
67 -
68 -**Step 4: Auto start the linux subsystem when Windows server restarts **
69 -
70 -{{code language="cmd"}}
71 -* Press Windows+R
72 -* Type shell:startup and press enter
73 -* Add or update file start_wsl.bat
74 -* Add following line into the document and save file
75 - * wsl sudo /usr/bin/dockerd
76 - {{/code}}
77 -
78 -**Step 5: Install eMagiz Deploy Agent**
79 -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"]].
80 -
81 -
82 -===3.4 Installation steps to configure Linux subsystem ===
83 -
84 -**Step 1: Install Docker **
85 -
86 -{{code language="cmd"}}
87 - curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
88 - echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
89 - sudo apt update
90 - sudo apt install docker-ce docker-ce-cli containerd.io
91 -{{/code}}
92 -
93 -{{info}}
94 - Requires ~335 Mb space to install
95 -{{/info}}
96 -
97 -**Step 2: Install Java **
98 -
99 -{{code language="cmd"}}
100 - wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
101 - 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
102 - sudo apt update # update if you haven't already
103 - sudo apt install temurin-8-jdk
104 -{{/code}}
105 -
106 -{{info}}
107 - Requires ~335 Mb space to install
108 -{{/info}}
109 -
110 -**Step 3: Ensure Docker is autostarted with WSL **
111 -
112 -{{code language="cmd"}}
113 113  nano .bashrc
114 114  
115 - #Add following lines to bashrc
116 116   DOCKER_DISTRO="Ubuntu"
117 117   DOCKER_LOG_DIR=$HOME/docker_logs
118 118   mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
119 119   /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
120 -{{/code}}
121 121  
122 -**Step 4: Add user to Docker group **
123 -
124 -{{code language="cmd"}}
66 +#Do not ask password dockerd
125 125  sudo visudo
126 126  
127 - #Add following lines
69 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
128 128  
129 - # Don't ask for password
130 - %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
131 -{{/code}}
71 +#Set WSL config for memory
72 +USERDIR/.wslconfig
73 + # Settings apply across all Linux distros running on WSL 2
74 + [wsl2]
132 132  
133 -**Step 5: Ensure safe IP range for WSL **
76 + # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
77 + memory=16GB
134 134  
135 -This step ensure that the IP address range of the machine doesn't conflict with IP address of the Linux subsystem. This remark is valid for Windows based installations only. Below the recommended values depending on the range which can be filled in the value <ip-address> below:
136 -* 10.0.0.1/8 - use 10.25.0.1/16
137 -* 172.16.0.1/12 - use 172.16.0.1/16
138 -* 192.168.0.1/16 - use 10.25.0.1/16
79 + # Sets the VM to use two virtual processors
80 + processors=2
81 +
82 +
83 +(Exit WSL: wsl --shutdown)
139 139  
140 -{{code language="cmd"}}
141 -sudo nano /etc/docker/daemon.json
85 +===3.4 Installation requirements Windows Server 2019 version >1806===
142 142  
143 - #Add following lines
144 -
145 - {"bip": "<ip-address>"}
146 -{{/code}}
147 -
148 -
87 +These are the requirements to allow the installation of the eMagiz Docker agent:
88 +* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
89 +* Validate if WSL 2.0 is properly installed
90 +* Go to the next section around installing the eMagiz Docker agent
91 +
149 149  ===3.5 Installation requirements Windows Server 2019 version 1806===
150 150  
151 -{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
152 -
153 153  These are the requirements to allow the installation of the eMagiz Docker agent:
154 154  * Enable Hyper-V in Windows Server
155 155   ** 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.
... ... @@ -156,10 +156,7 @@
156 156   ** Restart windows
157 157  * Cross check is WSL 2.0 is installed
158 158   ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
159 -* Please follow the instructions for preparing a Windows 2022 installation in section 3.3
160 -
161 -{{info}}
162 - * Install Docker Desktop on the Windows Server
100 +* Install Docker Desktop on the Windows Server
163 163   ** Please refer to this link: https://www.docker.com/products/docker-desktop/
164 164   ** Restart windows
165 165  * Update Docker Desktop configuration
... ... @@ -175,12 +175,9 @@
175 175  * Open the ubuntu terminal, and finish the installation.
176 176   ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
177 177  * Go to the next section around installing the eMagiz Docker agent
178 -{{/info}}
179 -
116 +
180 180  ===3.6 Installation requirements Windows Server 2012 R2 ===
181 -
182 -{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
183 -
118 +
184 184  These are the requirements to allow the installation of the eMagiz Docker agent:
185 185  * Install & enable Hyper-V in Windows Server
186 186   ** 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.
... ... @@ -194,11 +194,19 @@
194 194  * Install ubuntu downloaded previously on the VM
195 195  * Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
196 196  * Go to the next section around installing the eMagiz agent
132 +
133 +=== 3.7 eMagiz Docker agent installation ===
134 +
135 +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.
136 +
137 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
197 197  
139 +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.
140 +
198 198  == 4. Assignment ==
199 199  
200 200  Check out the cheatcheet for Docker command line:
201 -
144 +
202 202  [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
203 203  
204 204  == 5. Key takeaways ==
... ... @@ -205,7 +205,7 @@
205 205  
206 206  * 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
207 207  * eMagiz has a specific agent that manages the download of that image to the on-premises server
208 -* 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.
151 +* 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.
209 209  
210 210  
211 211