Skip to Content
Last modified by Erik Bakker on 2025/04/18 13:54
From version 42.1
edited by eMagiz
on 2023/01/26 08:57
Change comment: There is no comment for this version
To version 23.1
edited by eMagiz
on 2022/11/11 09:38
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
... ... @@ -9,101 +9,47 @@
9 9  * Good understanding of eMagiz runtimes in general
10 10  
11 11  == 2. Key concepts ==
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.
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 envirionments.
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 -
18 -===3.1 General requirements===
19 19  
20 -These are the general requirements to allow the installation of the eMagiz Docker agent:
18 +===3.1 Installation requirements Linux===
19 +
20 +These are the 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 -
27 -===3.2 Installation requirements Linux===
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}}
25 +* Install latest version of Docker
31 31  * Go to the next section around installing the eMagiz agent
32 32  
33 -===3.3 Installation requirements Windows Server 2022===
28 +===3.2 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}}
31 +* Ensure access to the following URLs is enabled
32 + ** registry.emagiz.com
33 + ** testing.emagiz.com
34 + ** Preferably the entry should be *.emagiz.com
35 +* Install latest version of Docker
37 37  * Validate if WSL 2.0 is properly installed
38 -* Go to the next section around installing the eMagiz Docker agent
37 +* Go to the next section around installing the eMagiz agent
38 +
39 +===3.3 Installation requirements Windows Server 2019 version 1806===
39 39  
40 -Step 1: Install linux distribution
41 -{{code language="cmd"}}
42 - wsl --install -d Ubuntu
43 -{{//code}}
44 -
45 - #Install docker
46 -sudo apt-get update
47 -sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
48 -. /etc/os-release
49 -curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
50 -echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
51 -sudo apt update
52 -sudo apt install docker-ce docker-ce-cli containerd.io
53 -
54 -#Install Java
55 -wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
56 -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
57 -sudo apt update # update if you haven't already
58 -sudo apt install temurin-8-jdk
59 -
60 -#Autostart Dockerd with wsl
61 -
62 -nano .bashrc
63 -
64 - DOCKER_DISTRO="Ubuntu"
65 - DOCKER_LOG_DIR=$HOME/docker_logs
66 - mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
67 - /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
68 -
69 -#Do not ask password dockerd
70 -sudo visudo
71 -
72 - %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
73 -
74 -#Set WSL config for memory
75 -USERDIR/.wslconfig
76 - # Settings apply across all Linux distros running on WSL 2
77 - [wsl2]
78 -
79 - # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
80 - memory=16GB
81 -
82 - # Sets the VM to use two virtual processors
83 - processors=2
84 -
85 -(Exit WSL: wsl --shutdown)
86 - {{/code}}
87 -
88 -===3.4 Installation requirements Windows Server 2019 version >1806===
89 -
90 90  These are the requirements to allow the installation of the eMagiz Docker agent:
91 -* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
92 -* Validate if WSL 2.0 is properly installed
93 -* Go to the next section around installing the eMagiz Docker agent
94 -
95 -===3.5 Installation requirements Windows Server 2019 version 1806===
96 -
97 -These are the requirements to allow the installation of the eMagiz Docker agent:
42 +* Ensure access to the following URLs is enabled
43 + ** registry.emagiz.com
44 + ** testing.emagiz.com
45 + ** Preferably the entry should be *.emagiz.com
98 98  * Enable Hyper-V in Windows Server
99 99   ** 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.
100 100   ** Restart windows
101 -* Cross check is WSL 2.0 is installed
102 - ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
103 103  * Install Docker Desktop on the Windows Server
104 104   ** Please refer to this link: https://www.docker.com/products/docker-desktop/
105 105   ** Restart windows
106 -* Update Docker Desktop configuration
52 +* Update Docker desktop configuration
107 107   ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
108 108   ** Restart Docker
109 109  * Open Powershell as Administrator
... ... @@ -115,11 +115,15 @@
115 115  * Ubuntu should now be a runnable program (press windows key, type ubuntu)
116 116  * Open the ubuntu terminal, and finish the installation.
117 117   ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
118 -* Go to the next section around installing the eMagiz Docker agent
119 -
120 -===3.6 Installation requirements Windows Server 2012 R2 ===
121 -
64 +* Go to the next section around installing the eMagiz agent
65 +
66 +===3.4 Installation requirements Windows Server 2012 R2 ===
67 +
122 122  These are the requirements to allow the installation of the eMagiz Docker agent:
69 +* Ensure access to the following URLs is enabled
70 + ** registry.emagiz.com
71 + ** testing.emagiz.com
72 + ** Preferably the entry should be *.emagiz.com
123 123  * Install & enable Hyper-V in Windows Server
124 124   ** 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.
125 125   ** Restart windows
... ... @@ -132,19 +132,22 @@
132 132  * Install ubuntu downloaded previously on the VM
133 133  * Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
134 134  * Go to the next section around installing the eMagiz agent
85 +
86 +=== 3.5 eMagiz agent installation agent ===
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 or is available upon request. Once that agent is installed, the image that is generated for every eMagiz release can be downloaded and installed in the Docker instance.
135 135  
136 -=== 3.7 eMagiz Docker agent installation ===
90 +After installing the agent, validate it runs by checking if a docker container runs on ubuntu.
91 +* wget https://download.docker.com/linux/static/stable/x86_64/docker-20.10.5.tgz
92 +* tar zxvf docker-20.10.5.tgz
93 +* cd docker
94 +* ./docker psg
137 137  
138 -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.
139 139  
140 -[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
141 -
142 -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.
143 -
144 144  == 4. Assignment ==
145 145  
146 146  Check out the cheatcheet for Docker command line:
147 -
100 +
148 148  [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
149 149  
150 150  == 5. Key takeaways ==
... ... @@ -151,7 +151,7 @@
151 151  
152 152  * 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
153 153  * eMagiz has a specific agent that manages the download of that image to the on-premises server
154 -* 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.
107 +* 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.
155 155  
156 156  
157 157