Skip to Content
Last modified by Erik Bakker on 2025/04/18 13:54
From version 56.1
edited by eMagiz
on 2023/02/07 11:39
Change comment: There is no comment for this version
To version 82.1
edited by eMagiz
on 2023/04/11 15:15
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 -
... ... @@ -75,7 +75,7 @@
75 75   Requires ~335 Mb space to install
76 76  {{/info}}
77 77  
78 -**Step 4: Ensure Docker is autostarted with WSL **
110 +**Step 3: Ensure Docker is autostarted with WSL **
79 79  
80 80  {{code language="cmd"}}
81 81  nano .bashrc
... ... @@ -87,7 +87,7 @@
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 -**Step 5: Add user to Docker group **
122 +**Step 4: Add user to Docker group **
91 91  
92 92  {{code language="cmd"}}
93 93  sudo visudo
... ... @@ -98,36 +98,26 @@
98 98   %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
99 99  {{/code}}
100 100  
101 -**Step 6: Update wsl config file **
102 -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
133 +**Step 5: Ensure safe IP range for WSL **
103 103  
104 -First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
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
105 105  
106 -
107 107  {{code language="cmd"}}
141 +sudo nano /etc/docker/daemon.json
142 +
108 108   #Add following lines
109 -
110 - # Settings apply across all Linux distros running on WSL 2
111 - [wsl2]
112 - # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
113 - memory=16GB
114 - # Sets the VM to use two virtual processors
115 - processors=2
144 +
145 + {"bip": "<ip-address>"}
116 116  {{/code}}
117 117  
118 -
119 -**Step 7: Auto start the linux subsystem when server restarts **
120 -
121 121  
122 -===3.4 Installation requirements Windows Server 2019 version >1806===
123 -
124 -These are the requirements to allow the installation of the eMagiz Docker agent:
125 -* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
126 -* Validate if WSL 2.0 is properly installed
127 -* Go to the next section around installing the eMagiz Docker agent
128 -
129 129  ===3.5 Installation requirements Windows Server 2019 version 1806===
130 130  
151 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
152 +
131 131  These are the requirements to allow the installation of the eMagiz Docker agent:
132 132  * Enable Hyper-V in Windows Server
133 133   ** 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.
... ... @@ -134,7 +134,10 @@
134 134   ** Restart windows
135 135  * Cross check is WSL 2.0 is installed
136 136   ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
137 -* Install Docker Desktop on the Windows Server
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
138 138   ** Please refer to this link: https://www.docker.com/products/docker-desktop/
139 139   ** Restart windows
140 140  * Update Docker Desktop configuration
... ... @@ -150,9 +150,12 @@
150 150  * Open the ubuntu terminal, and finish the installation.
151 151   ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
152 152  * Go to the next section around installing the eMagiz Docker agent
178 +{{/info}}
153 153  
154 154  ===3.6 Installation requirements Windows Server 2012 R2 ===
155 155  
182 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
183 +
156 156  These are the requirements to allow the installation of the eMagiz Docker agent:
157 157  * Install & enable Hyper-V in Windows Server
158 158   ** 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.
... ... @@ -167,14 +167,6 @@
167 167  * Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
168 168  * Go to the next section around installing the eMagiz agent
169 169  
170 -=== 3.7 eMagiz Docker agent installation ===
171 -
172 -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.
173 -
174 -[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
175 -
176 -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.
177 -
178 178  == 4. Assignment ==
179 179  
180 180  Check out the cheatcheet for Docker command line: