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