Skip to Content
Last modified by Erik Bakker on 2025/04/18 13:54
From version 44.1
edited by eMagiz
on 2023/01/26 10:02
Change comment: There is no comment for this version
To version 86.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,81 +23,141 @@
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**
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}}
47 +
48 +**Step 2: Configure linux system**
49 +Please see section 3.4 for these these steps
43 43  
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 +
44 44  {{code language="cmd"}}
45 -wsl --install -d Ubuntu
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
46 46  {{/code}}
47 47  
67 +
68 +**Step 4: Auto start the linux subsystem when Windows server restarts **
48 48  
49 -#Install docker
50 -sudo apt-get update
51 -sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
52 -. /etc/os-release
53 -curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
54 -echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
55 -sudo apt update
56 -sudo apt install docker-ce docker-ce-cli containerd.io
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}}
57 57  
58 -#Install Java
59 -wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
60 -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
61 -sudo apt update # update if you haven't already
62 -sudo apt install temurin-8-jdk
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 ===
63 63  
64 -#Autostart Dockerd with wsl
84 +**Step 1: Install Docker **
65 65  
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"}}
66 66  nano .bashrc
67 67  
115 + #Add following lines to bashrc
68 68   DOCKER_DISTRO="Ubuntu"
69 69   DOCKER_LOG_DIR=$HOME/docker_logs
70 70   mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
71 71   /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}}
72 72  
73 -#Do not ask password dockerd
122 +**Step 4: Add user to Docker group **
123 +
124 +{{code language="cmd"}}
74 74  sudo visudo
75 75  
76 - %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
127 + #Add following lines
77 77  
78 -#Set WSL config for memory
79 -USERDIR/.wslconfig
80 - # Settings apply across all Linux distros running on WSL 2
81 - [wsl2]
129 + # Don't ask for password
130 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
131 +{{/code}}
82 82  
83 - # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
84 - memory=16GB
133 +**Step 5: Ensure safe IP range for WSL **
85 85  
86 - # Sets the VM to use two virtual processors
87 - processors=2
135 +{{info}}
136 +This remark is valid for Windows based installations only
137 +{{/info}}
88 88  
89 -(Exit WSL: wsl --shutdown)
90 - {{/code}}
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
91 91  
92 -===3.4 Installation requirements Windows Server 2019 version >1806===
147 +{{code language="cmd"}}
148 +sudo nano /etc/docker/daemon.json
93 93  
94 -These are the requirements to allow the installation of the eMagiz Docker agent:
95 -* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
96 -* Validate if WSL 2.0 is properly installed
97 -* Go to the next section around installing the eMagiz Docker agent
150 + #Add following lines
98 98  
152 + {"bip": "<ip-address>"}
153 +{{/code}}
154 +
155 +
99 99  ===3.5 Installation requirements Windows Server 2019 version 1806===
100 100  
158 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
159 +
101 101  These are the requirements to allow the installation of the eMagiz Docker agent:
102 102  * Enable Hyper-V in Windows Server
103 103   ** 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.
... ... @@ -104,7 +104,10 @@
104 104   ** Restart windows
105 105  * Cross check is WSL 2.0 is installed
106 106   ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
107 -* 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
108 108   ** Please refer to this link: https://www.docker.com/products/docker-desktop/
109 109   ** Restart windows
110 110  * Update Docker Desktop configuration
... ... @@ -120,9 +120,12 @@
120 120  * Open the ubuntu terminal, and finish the installation.
121 121   ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
122 122  * Go to the next section around installing the eMagiz Docker agent
185 +{{/info}}
123 123  
124 124  ===3.6 Installation requirements Windows Server 2012 R2 ===
125 125  
189 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
190 +
126 126  These are the requirements to allow the installation of the eMagiz Docker agent:
127 127  * Install & enable Hyper-V in Windows Server
128 128   ** 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.
... ... @@ -137,14 +137,6 @@
137 137  * Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
138 138  * Go to the next section around installing the eMagiz agent
139 139  
140 -=== 3.7 eMagiz Docker agent installation ===
141 -
142 -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.
143 -
144 -[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
145 -
146 -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.
147 -
148 148  == 4. Assignment ==
149 149  
150 150  Check out the cheatcheet for Docker command line: