Skip to Content
Last modified by Erik Bakker on 2025/04/18 13:54
From version 51.1
edited by eMagiz
on 2023/02/06 09:32
Change comment: There is no comment for this version
To version 27.1
edited by eMagiz
on 2022/11/15 14:54
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
... ... @@ -11,7 +11,7 @@
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 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.5 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.
15 15  
16 16  == 3. On-premises deployments ==
17 17  
... ... @@ -19,100 +19,30 @@
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
30 -* Install latest version of the Docker engine - see for instance {{code}}https://docs.docker.com/engine/install/ubuntu/{{/code}}
28 +* Install latest version of the Docker engine - see for instance https://docs.docker.com/engine/install/ubuntu/
31 31  * Go to the next section around installing the eMagiz agent
32 32  
33 33  ===3.3 Installation requirements Windows Server 2022===
34 34  
35 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}}
34 +* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
37 37  * Validate if WSL 2.0 is properly installed
38 -* Go to the next section around installing the eMagiz Docker agent
36 +* Go to the next section around installing the eMagiz agent
39 39  
40 -===3.3 Installation requirements Windows Server 2022 (without Docker Desktop) ===
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 -
52 -**Step 2: Install Docker **
53 -
54 -{{code language="cmd"}}
55 - curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
56 - echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
57 - sudo apt update
58 - sudo apt install docker-ce docker-ce-cli containerd.io
59 -{{/code}}
60 -
61 -{{info}}
62 - Requires ~335 Mb space to install
63 -{{/info}}
64 -
65 -**Step 3: Install Java **
66 -
67 -{{code language="cmd"}}
68 - wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
69 - 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
70 - sudo apt update # update if you haven't already
71 - sudo apt install temurin-8-jdk
72 -{{/code}}
73 -
74 -{{info}}
75 - Requires ~335 Mb space to install
76 -{{/info}}
77 -
78 -**Step 4: Ensure Docker is autostarted with WSL **
79 -
80 -{{code language="cmd"}}
81 -nano .bashrc
82 -
83 - #Add following lines to bashrc
84 - DOCKER_DISTRO="Ubuntu"
85 - DOCKER_LOG_DIR=$HOME/docker_logs
86 - mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
87 - /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
88 -{{/code}}
89 -
90 -**Step 4: Add user to Docker group **
91 -
92 -sudo visudo
93 - #Add following lines to bashrc
94 -
95 - # Don't ask for password
96 - %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
97 - #Set WSL config for memory
98 - USERDIR/.wslconfig
99 - # Settings apply across all Linux distros running on WSL 2
100 - [wsl2]
101 - # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
102 - memory=16GB
103 - # Sets the VM to use two virtual processors
104 - processors=2
105 -
106 -(Exit WSL: wsl --shutdown)
107 -
108 -
109 109  ===3.4 Installation requirements Windows Server 2019 version >1806===
110 110  
111 111  These are the requirements to allow the installation of the eMagiz Docker agent:
112 112  * Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
113 113  * Validate if WSL 2.0 is properly installed
114 -* Go to the next section around installing the eMagiz Docker agent
115 -
43 +* Go to the next section around installing the eMagiz agent
44 +
45 +
116 116  ===3.5 Installation requirements Windows Server 2019 version 1806===
117 117  
118 118  These are the requirements to allow the installation of the eMagiz Docker agent:
... ... @@ -119,8 +119,6 @@
119 119  * Enable Hyper-V in Windows Server
120 120   ** 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.
121 121   ** Restart windows
122 -* Cross check is WSL 2.0 is installed
123 - ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
124 124  * Install Docker Desktop on the Windows Server
125 125   ** Please refer to this link: https://www.docker.com/products/docker-desktop/
126 126   ** Restart windows
... ... @@ -136,10 +136,10 @@
136 136  * Ubuntu should now be a runnable program (press windows key, type ubuntu)
137 137  * Open the ubuntu terminal, and finish the installation.
138 138   ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
139 -* Go to the next section around installing the eMagiz Docker agent
140 -
67 +* Go to the next section around installing the eMagiz agent
68 +
141 141  ===3.6 Installation requirements Windows Server 2012 R2 ===
142 -
70 +
143 143  These are the requirements to allow the installation of the eMagiz Docker agent:
144 144  * Install & enable Hyper-V in Windows Server
145 145   ** 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,19 +153,17 @@
153 153  * Install ubuntu downloaded previously on the VM
154 154  * Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
155 155  * Go to the next section around installing the eMagiz agent
84 +
85 +=== 3.7 eMagiz agent installation agent ===
86 +
87 +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.
156 156  
157 -=== 3.7 eMagiz Docker agent installation ===
158 -
159 -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.
160 -
161 -[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
162 -
163 163  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.
164 164  
165 165  == 4. Assignment ==
166 166  
167 167  Check out the cheatcheet for Docker command line:
168 -
94 +
169 169  [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
170 170  
171 171  == 5. Key takeaways ==
... ... @@ -172,7 +172,7 @@
172 172  
173 173  * 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
174 174  * eMagiz has a specific agent that manages the download of that image to the on-premises server
175 -* 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.
101 +* 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.
176 176  
177 177  
178 178