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