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