Skip to Content
Last modified by Erik Bakker on 2025/04/18 13:54
From version 63.1
edited by eMagiz
on 2023/02/07 12:28
Change comment: There is no comment for this version
To version 30.1
edited by eMagiz
on 2022/11/18 13:23
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -On-premise Install Guide
1 +On-premises deployment new runtime architecture
Content
... ... @@ -19,118 +19,31 @@
19 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:8443
23 - ** controlplane.emagiz.com:8000
22 + ** registry.emagiz.com
23 + ** testing.emagiz.com
24 24   ** Preferably the entry should be *.emagiz.com
25 -
26 26  
27 27  ===3.2 Installation requirements Linux===
28 28  
29 -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.
30 -**Step 1: Install linux distribution**
31 -Follow all steps in section 3.4
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
32 32  
33 -**Step 2: Install eMagiz Deploy Agent**
34 -Install the eMagiz Deploy agent as can be found here
31 +===3.3 Installation requirements Windows Server 2022===
35 35  
36 -===3.3 Installation requirements Windows Server 2022 ===
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
37 37  
38 -{{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
38 +===3.4 Installation requirements Windows Server 2019 version >1806===
39 39  
40 -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).
41 -
42 -**Step 1: Install linux distribution**
43 -
44 -{{code language="cmd"}}
45 - wsl --install -d Ubuntu
46 - sudo apt-get update
47 - sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
48 - . /etc/os-release
49 -{{/code}}
50 -
51 -**Step 2: Configure linux system**
52 -Please see section 3.4 for these these steps
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
53 53  
54 -**Step 3: Update wsl config file **
55 -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
56 -
57 -First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
58 -
59 -{{code language="cmd"}}
60 - #Add following lines
61 -
62 - # Settings apply across all Linux distros running on WSL 2
63 - [wsl2]
64 - # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
65 - memory=16GB
66 - # Sets the VM to use two virtual processors
67 - processors=2
68 -{{/code}}
69 -
70 -
71 -**Step 4: Auto start the linux subsystem when Windows server restarts **
72 -
73 -**Step 5: Install eMagiz Deploy Agent**
74 -Install the eMagiz Deploy agent as can be found here
75 -
76 -
77 -===3.4 Installation steps to configure Linux subsystem ===
78 -
79 -**Step 1: Install Docker **
80 -
81 -{{code language="cmd"}}
82 - curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
83 - echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
84 - sudo apt update
85 - sudo apt install docker-ce docker-ce-cli containerd.io
86 -{{/code}}
87 -
88 -{{info}}
89 - Requires ~335 Mb space to install
90 -{{/info}}
91 -
92 -**Step 2: Install Java **
93 -
94 -{{code language="cmd"}}
95 - wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
96 - 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
97 - sudo apt update # update if you haven't already
98 - sudo apt install temurin-8-jdk
99 -{{/code}}
100 -
101 -{{info}}
102 - Requires ~335 Mb space to install
103 -{{/info}}
104 -
105 -**Step 3: Ensure Docker is autostarted with WSL **
106 -
107 -{{code language="cmd"}}
108 -nano .bashrc
109 -
110 - #Add following lines to bashrc
111 - DOCKER_DISTRO="Ubuntu"
112 - DOCKER_LOG_DIR=$HOME/docker_logs
113 - mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
114 - /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
115 -{{/code}}
116 -
117 -**Step 4: Add user to Docker group **
118 -
119 -{{code language="cmd"}}
120 -sudo visudo
121 -
122 - #Add following lines
123 -
124 - # Don't ask for password
125 - %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
126 -{{/code}}
127 -
128 -
129 -
130 130  ===3.5 Installation requirements Windows Server 2019 version 1806===
131 131  
132 -{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
133 -
134 134  These are the requirements to allow the installation of the eMagiz Docker agent:
135 135  * Enable Hyper-V in Windows Server
136 136   ** 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.
... ... @@ -153,11 +153,9 @@
153 153  * Open the ubuntu terminal, and finish the installation.
154 154   ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
155 155  * Go to the next section around installing the eMagiz Docker agent
156 -
69 +
157 157  ===3.6 Installation requirements Windows Server 2012 R2 ===
158 -
159 -{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
160 -
71 +
161 161  These are the requirements to allow the installation of the eMagiz Docker agent:
162 162  * Install & enable Hyper-V in Windows Server
163 163   ** 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.
... ... @@ -171,19 +171,17 @@
171 171  * Install ubuntu downloaded previously on the VM
172 172  * Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
173 173  * Go to the next section around installing the eMagiz agent
174 -
85 +
175 175  === 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.
176 176  
177 -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.
178 -
179 -[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
180 -
181 181  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.
182 182  
183 183  == 4. Assignment ==
184 184  
185 185  Check out the cheatcheet for Docker command line:
186 -
95 +
187 187  [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
188 188  
189 189  == 5. Key takeaways ==
... ... @@ -190,7 +190,7 @@
190 190  
191 191  * 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
192 192  * eMagiz has a specific agent that manages the download of that image to the on-premises server
193 -* 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.
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.
194 194  
195 195  
196 196