Skip to Content
Last modified by Erik Bakker on 2025/04/18 13:54
From version 50.1
edited by eMagiz
on 2023/02/06 08:44
Change comment: There is no comment for this version
To version 85.1
edited by eMagiz
on 2023/04/11 15:24
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -On-premise Install Guide
1 +Pre-requisite installation of on-premises server
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 this microlearning, we will focus on how an on-premises server can be prepared for a eMagiz Deploy agent installation.
3 3  
4 4  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
... ... @@ -11,12 +11,11 @@
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 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.
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.
15 15  
16 16  == 3. On-premises deployments ==
17 17  
18 18  ===3.1 General requirements===
19 -
20 20  These are the general requirements to allow the installation of the eMagiz Docker agent:
21 21  * Ensure access to the following URLs is enabled
22 22   ** registry.emagiz.com:8443
... ... @@ -23,22 +23,20 @@
23 23   ** controlplane.emagiz.com:8000
24 24   ** Preferably the entry should be *.emagiz.com
25 25  
26 -
27 27  ===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
28 28  
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
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"]]
32 32  
33 -===3.3 Installation requirements Windows Server 2022===
33 +===3.3 Installation requirements Windows Server 2022 ===
34 34  
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
35 +{{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
39 39  
40 -===3.3 Installation requirements Windows Server 2022 (without Docker Desktop) ===
41 -
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).
38 +
42 42  **Step 1: Install linux distribution**
43 43  
44 44  {{code language="cmd"}}
... ... @@ -48,10 +48,45 @@
48 48   . /etc/os-release
49 49  {{/code}}
50 50  
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
51 51  
52 -**Step 2: Install Docker **
54 +First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
53 53  
54 54  {{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"}}
55 55   curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
56 56   echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
57 57   sudo apt update
... ... @@ -62,7 +62,7 @@
62 62   Requires ~335 Mb space to install
63 63  {{/info}}
64 64  
65 -**Step 3: Install Java **
97 +**Step 2: Install Java **
66 66  
67 67  {{code language="cmd"}}
68 68   wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
... ... @@ -87,34 +87,44 @@
87 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"
88 88  {{/code}}
89 89  
90 -#Do not ask password dockerd
122 +**Step 4: Add user to Docker group **
123 +
124 +{{code language="cmd"}}
91 91  sudo visudo
92 92  
93 - %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
127 + #Add following lines
94 94  
95 -#Set WSL config for memory
96 -USERDIR/.wslconfig
97 - # Settings apply across all Linux distros running on WSL 2
98 - [wsl2]
129 + # Don't ask for password
130 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
131 +{{/code}}
99 99  
100 - # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
101 - memory=16GB
133 +**Step 5: Ensure safe IP range for WSL **
102 102  
103 - # Sets the VM to use two virtual processors
104 - processors=2
135 +{{info}}
136 +This remark is valid for Windows based installations only
137 +{{/info}}
105 105  
106 -(Exit WSL: wsl --shutdown)
107 -
139 +This step ensures that the IP address range of the machine doesn't conflict with any IP address of the Linux subsystem. Below the recommended values depending on the range which can be filled in the value <ip-address> below:
140 +* 10.0.0.1/8
141 + ** advised value 10.25.0.1/16
142 +* 172.16.0.1/12
143 + ** advised value 172.16.0.1/16
144 +* 192.168.0.1/16
145 + **advised value 10.25.0.1/16
108 108  
109 -===3.4 Installation requirements Windows Server 2019 version >1806===
147 +{{code language="cmd"}}
148 +sudo nano /etc/docker/daemon.json
110 110  
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
150 + #Add following lines
115 115  
152 + {"bip": "<ip-address>"}
153 +{{/code}}
154 +
155 +
116 116  ===3.5 Installation requirements Windows Server 2019 version 1806===
117 117  
158 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
159 +
118 118  These are the requirements to allow the installation of the eMagiz Docker agent:
119 119  * Enable Hyper-V in Windows Server
120 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,7 +121,10 @@
121 121   ** Restart windows
122 122  * Cross check is WSL 2.0 is installed
123 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
166 +* Please follow the instructions for preparing a Windows 2022 installation in section 3.3
167 +
168 +{{info}}
169 + * Install Docker Desktop on the Windows Server
125 125   ** Please refer to this link: https://www.docker.com/products/docker-desktop/
126 126   ** Restart windows
127 127  * Update Docker Desktop configuration
... ... @@ -137,9 +137,12 @@
137 137  * Open the ubuntu terminal, and finish the installation.
138 138   ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
139 139  * Go to the next section around installing the eMagiz Docker agent
185 +{{/info}}
140 140  
141 141  ===3.6 Installation requirements Windows Server 2012 R2 ===
142 142  
189 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
190 +
143 143  These are the requirements to allow the installation of the eMagiz Docker agent:
144 144  * Install & enable Hyper-V in Windows Server
145 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.
... ... @@ -154,14 +154,6 @@
154 154  * Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
155 155  * Go to the next section around installing the eMagiz agent
156 156  
157 -=== 3.7 eMagiz Docker agent installation ===
158 -
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.
160 -
161 -[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
162 -
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 165  == 4. Assignment ==
166 166  
167 167  Check out the cheatcheet for Docker command line: