Skip to Content
Last modified by Erik Bakker on 2025/04/18 13:54
From version 69.1
edited by eMagiz
on 2023/02/07 13:20
Change comment: There is no comment for this version
To version 35.1
edited by Erik Bakker
on 2023/01/18 10:24
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Pre-requisite installation of on-premises server
1 +On-premise Install Guide
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.eMagiz
1 +XWiki.ebakker
Content
... ... @@ -16,6 +16,7 @@
16 16  == 3. On-premises deployments ==
17 17  
18 18  ===3.1 General requirements===
19 +
19 19  These are the general requirements to allow the installation of the eMagiz Docker agent:
20 20  * Ensure access to the following URLs is enabled
21 21   ** registry.emagiz.com:8443
... ... @@ -22,113 +22,75 @@
22 22   ** controlplane.emagiz.com:8000
23 23   ** Preferably the entry should be *.emagiz.com
24 24  
26 +
25 25  ===3.2 Installation requirements Linux===
26 -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.
27 -**Step 1: Install linux distribution**
28 -Follow all steps in section 3.4
29 29  
30 -**Step 2: Install eMagiz Deploy Agent**
31 -Install the eMagiz Deploy agent as can be found [[on this link>>https://docs.emagiz.com/bin/view/Main/eMagiz%20Academy/Microlearnings/Intermediate%20Level/eMagiz%20Runtime%20Management/intermediate-runtime-management-deploy-agent/||target="_blank"]]
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
32 32  
33 -===3.3 Installation requirements Windows Server 2022 ===
33 +===3.3 Installation requirements Windows Server 2022===
34 34  
35 -{{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
36 -
37 -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).
38 -
39 -**Step 1: Install linux distribution**
40 -
41 -{{code language="cmd"}}
42 - wsl --install -d Ubuntu
43 - sudo apt-get update
44 - sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
45 - . /etc/os-release
46 -{{/code}}
47 -
48 -**Step 2: Configure linux system**
49 -Please see section 3.4 for these these steps
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
50 50  
51 -**Step 3: Update wsl config file **
52 -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
53 -
54 -First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
55 -
56 -{{code language="cmd"}}
57 - #Add following lines
58 -
59 - # Settings apply across all Linux distros running on WSL 2
60 - [wsl2]
61 - # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
62 - memory=16GB
63 - # Sets the VM to use two virtual processors
64 - processors=2
65 -{{/code}}
66 -
67 67  
68 -**Step 4: Auto start the linux subsystem when Windows server restarts **
69 69  
70 -**Step 5: Install eMagiz Deploy Agent**
71 -Install the eMagiz Deploy agent as can be found [[on this link>>https://docs.emagiz.com/bin/view/Main/eMagiz%20Academy/Microlearnings/Intermediate%20Level/eMagiz%20Runtime%20Management/intermediate-runtime-management-deploy-agent/||target="_blank"]]
72 -
73 -
74 -===3.4 Installation steps to configure Linux subsystem ===
42 + #Install docker
43 +sudo apt-get update
44 +sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
45 +. /etc/os-release
46 +curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
47 +echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
48 +sudo apt update
75 75  
76 -**Step 1: Install Docker **
50 +sudo apt install docker-ce docker-ce-cli containerd.io
77 77  
78 -{{code language="cmd"}}
79 - curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
80 - echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
81 - sudo apt update
82 - sudo apt install docker-ce docker-ce-cli containerd.io
83 -{{/code}}
52 +#Install Java
53 +wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
54 +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
55 +sudo apt update # update if you haven't already
56 +sudo apt install temurin-8-jdk
84 84  
85 -{{info}}
86 - Requires ~335 Mb space to install
87 -{{/info}}
88 -
89 -**Step 2: Install Java **
90 -
91 -{{code language="cmd"}}
92 - wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
93 - 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
94 - sudo apt update # update if you haven't already
95 - sudo apt install temurin-8-jdk
96 -{{/code}}
97 -
98 -{{info}}
99 - Requires ~335 Mb space to install
100 -{{/info}}
101 -
102 -**Step 3: Ensure Docker is autostarted with WSL **
103 -
104 -{{code language="cmd"}}
58 +#Autostart Dockerd with wsl
105 105  nano .bashrc
106 106  
107 - #Add following lines to bashrc
108 108   DOCKER_DISTRO="Ubuntu"
109 109   DOCKER_LOG_DIR=$HOME/docker_logs
110 110   mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
111 111   /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
112 -{{/code}}
113 113  
114 -**Step 4: Add user to Docker group **
115 -
116 -{{code language="cmd"}}
66 +#Do not ask password dockerd
117 117  sudo visudo
118 118  
119 - #Add following lines
69 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
120 120  
121 - # Don't ask for password
122 - %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
123 -{{/code}}
71 +#Set WSL config for memory
72 +USERDIR/.wslconfig
73 + # Settings apply across all Linux distros running on WSL 2
74 + [wsl2]
124 124  
125 -
76 + # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
77 + memory=16GB
126 126  
127 -===3.5 Installation requirements Windows Server 2019 version 1806===
79 + # Sets the VM to use two virtual processors
80 + processors=2
81 +
82 +
83 +(Exit WSL: wsl --shutdown)
128 128  
129 -{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
85 +===3.4 Installation requirements Windows Server 2019 version >1806===
130 130  
131 131  These are the requirements to allow the installation of the eMagiz Docker agent:
88 +* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
89 +* Validate if WSL 2.0 is properly installed
90 +* Go to the next section around installing the eMagiz Docker agent
91 +
92 +===3.5 Installation requirements Windows Server 2019 version 1806===
93 +
94 +These are the requirements to allow the installation of the eMagiz Docker agent:
132 132  * Enable Hyper-V in Windows Server
133 133   ** 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.
134 134   ** Restart windows
... ... @@ -150,11 +150,9 @@
150 150  * Open the ubuntu terminal, and finish the installation.
151 151   ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
152 152  * Go to the next section around installing the eMagiz Docker agent
153 -
116 +
154 154  ===3.6 Installation requirements Windows Server 2012 R2 ===
155 -
156 -{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
157 -
118 +
158 158  These are the requirements to allow the installation of the eMagiz Docker agent:
159 159  * Install & enable Hyper-V in Windows Server
160 160   ** 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.
... ... @@ -168,11 +168,17 @@
168 168  * Install ubuntu downloaded previously on the VM
169 169  * Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
170 170  * Go to the next section around installing the eMagiz agent
132 +
133 +=== 3.7 eMagiz Docker agent installation ===
134 +
135 +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  
137 +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.
138 +
172 172  == 4. Assignment ==
173 173  
174 174  Check out the cheatcheet for Docker command line:
175 -
142 +
176 176  [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
177 177  
178 178  == 5. Key takeaways ==
... ... @@ -179,7 +179,7 @@
179 179  
180 180  * 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
181 181  * eMagiz has a specific agent that manages the download of that image to the on-premises server
182 -* 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 +* 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.
183 183  
184 184  
185 185