Skip to Content
Last modified by Erik Bakker on 2025/04/18 13:54
From version 30.1
edited by eMagiz
on 2022/11/18 13:23
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-premises deployment new runtime architecture
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,39 +11,152 @@
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 - ** registry.emagiz.com
23 - ** testing.emagiz.com
21 + ** registry.emagiz.com:8443
22 + ** controlplane.emagiz.com:8000
24 24   ** Preferably the entry should be *.emagiz.com
25 -
24 +
26 26  ===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
27 27  
28 -* Install latest version of the Docker engine - see for instance https://docs.docker.com/engine/install/ubuntu/
29 -* 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"]]
30 30  
31 -===3.3 Installation requirements Windows Server 2022===
33 +===3.3 Installation requirements Windows Server 2022 ===
32 32  
33 -These are the requirements to allow the installation of the eMagiz Docker agent:
34 -* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
35 -* Validate if WSL 2.0 is properly installed
36 -* 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}}
37 37  
38 -===3.4 Installation requirements Windows Server 2019 version >1806===
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).
39 39  
40 -These are the requirements to allow the installation of the eMagiz Docker agent:
41 -* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
42 -* Validate if WSL 2.0 is properly installed
43 -* Go to the next section around installing the eMagiz Docker agent
39 +**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
44 44  
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 +nano .bashrc
114 +
115 + #Add following lines to bashrc
116 + DOCKER_DISTRO="Ubuntu"
117 + DOCKER_LOG_DIR=$HOME/docker_logs
118 + mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
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 +
122 +**Step 4: Add user to Docker group **
123 +
124 +{{code language="cmd"}}
125 +sudo visudo
126 +
127 + #Add following lines
128 +
129 + # Don't ask for password
130 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
131 +{{/code}}
132 +
133 +**Step 5: Ensure safe IP range for WSL **
134 +
135 +{{info}}
136 +This remark is valid for Windows based installations only
137 +{{/info}}
138 +
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
146 +
147 +{{code language="cmd"}}
148 +sudo nano /etc/docker/daemon.json
149 +
150 + #Add following lines
151 +
152 + {"bip": "<ip-address>"}
153 +{{/code}}
154 +
155 +
45 45  ===3.5 Installation requirements Windows Server 2019 version 1806===
46 46  
158 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
159 +
47 47  These are the requirements to allow the installation of the eMagiz Docker agent:
48 48  * Enable Hyper-V in Windows Server
49 49   ** 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.
... ... @@ -50,7 +50,10 @@
50 50   ** Restart windows
51 51  * Cross check is WSL 2.0 is installed
52 52   ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
53 -* 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
54 54   ** Please refer to this link: https://www.docker.com/products/docker-desktop/
55 55   ** Restart windows
56 56  * Update Docker Desktop configuration
... ... @@ -66,9 +66,12 @@
66 66  * Open the ubuntu terminal, and finish the installation.
67 67   ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
68 68  * Go to the next section around installing the eMagiz Docker agent
69 -
185 +{{/info}}
186 +
70 70  ===3.6 Installation requirements Windows Server 2012 R2 ===
71 -
188 +
189 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
190 +
72 72  These are the requirements to allow the installation of the eMagiz Docker agent:
73 73  * Install & enable Hyper-V in Windows Server
74 74   ** 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.
... ... @@ -82,17 +82,11 @@
82 82  * Install ubuntu downloaded previously on the VM
83 83  * Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
84 84  * Go to the next section around installing the eMagiz agent
85 -
86 -=== 3.7 eMagiz Docker agent installation ===
87 -
88 -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 when the machine is used for the first time deployment of eMagiz runtimes. A popup will appear that displays the commands per type of OS. Once that agent is installed, the image that is generated for every eMagiz release can be downloaded and installed in the Docker instance.
89 89  
90 -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.
91 -
92 92  == 4. Assignment ==
93 93  
94 94  Check out the cheatcheet for Docker command line:
95 -
208 +
96 96  [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
97 97  
98 98  == 5. Key takeaways ==
... ... @@ -99,7 +99,7 @@
99 99  
100 100  * 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
101 101  * eMagiz has a specific agent that manages the download of that image to the on-premises server
102 -* 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.
215 +* 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.
103 103  
104 104  
105 105