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