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

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -On-premise Install Guide
1 +Pre-requisite installation of on-premises server
Content
... ... @@ -16,7 +16,6 @@
16 16  == 3. On-premises deployments ==
17 17  
18 18  ===3.1 General requirements===
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 22   ** registry.emagiz.com:8443
... ... @@ -23,96 +23,112 @@
23 23   ** controlplane.emagiz.com:8000
24 24   ** Preferably the entry should be *.emagiz.com
25 25  
26 -
27 27  ===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
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}}
31 -* Go to the next section around installing the eMagiz agent
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"]]
32 32  
33 -===3.3 Installation requirements Windows Server 2022===
33 +===3.3 Installation requirements Windows Server 2022 ===
34 34  
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}}
37 -* Validate if WSL 2.0 is properly installed
38 -* Go to the next section around installing the eMagiz Docker agent
35 +{{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
39 39  
40 -===3.3 Installation requirements Windows Server 2022 (without Docker Desktop) ===
41 -
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 +
42 42  **Step 1: Install linux distribution**
43 43  
44 44  {{code language="cmd"}}
45 -wsl --install -d Ubuntu
42 + wsl --install -d Ubuntu
46 46   sudo apt-get update
47 47   sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
48 48   . /etc/os-release
49 49  {{/code}}
50 50  
51 -
52 -**Step 2: Install Docker **
53 -{{code language="cmd"}}
54 -curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
55 -echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
56 -sudo apt update
57 -sudo apt install docker-ce docker-ce-cli containerd.io
48 +**Step 2: Configure linux system**
49 +Please see section 3.4 for these these steps
58 58  
59 - Requires ~335 Mb space to install
60 - {{/code}}
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
61 61  
54 +First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
62 62  
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}}
63 63  
67 +
68 +**Step 4: Auto start the linux subsystem when Windows server restarts **
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 ===
64 64  
76 +**Step 1: Install Docker **
65 65  
66 -**Step 3: Install Java **
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 -
73 - Requires 221 Mb space to install
74 - {{/code}}
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}}
75 75  
85 +{{info}}
86 + Requires ~335 Mb space to install
87 +{{/info}}
76 76  
89 +**Step 2: Install Java **
77 77  
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}}
78 78  
79 -#Autostart Dockerd with wsl
98 +{{info}}
99 + Requires ~335 Mb space to install
100 +{{/info}}
80 80  
102 +**Step 3: Ensure Docker is autostarted with WSL **
103 +
104 +{{code language="cmd"}}
81 81  nano .bashrc
82 82  
107 + #Add following lines to bashrc
83 83   DOCKER_DISTRO="Ubuntu"
84 84   DOCKER_LOG_DIR=$HOME/docker_logs
85 85   mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
86 86   /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}}
87 87  
88 -#Do not ask password dockerd
114 +**Step 4: Add user to Docker group **
115 +
116 +{{code language="cmd"}}
89 89  sudo visudo
90 90  
91 - %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
119 + #Add following lines
92 92  
93 -#Set WSL config for memory
94 -USERDIR/.wslconfig
95 - # Settings apply across all Linux distros running on WSL 2
96 - [wsl2]
121 + # Don't ask for password
122 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
123 +{{/code}}
97 97  
98 - # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
99 - memory=16GB
100 -
101 - # Sets the VM to use two virtual processors
102 - processors=2
103 -
104 -(Exit WSL: wsl --shutdown)
105 105  
106 106  
107 -===3.4 Installation requirements Windows Server 2019 version >1806===
108 -
109 -These are the requirements to allow the installation of the eMagiz Docker agent:
110 -* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
111 -* Validate if WSL 2.0 is properly installed
112 -* Go to the next section around installing the eMagiz Docker agent
113 -
114 114  ===3.5 Installation requirements Windows Server 2019 version 1806===
115 115  
129 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
130 +
116 116  These are the requirements to allow the installation of the eMagiz Docker agent:
117 117  * 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.
... ... @@ -138,6 +138,8 @@
138 138  
139 139  ===3.6 Installation requirements Windows Server 2012 R2 ===
140 140  
156 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
157 +
141 141  These are the requirements to allow the installation of the eMagiz Docker agent:
142 142  * Install & enable Hyper-V in Windows Server
143 143   ** 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.
... ... @@ -152,14 +152,6 @@
152 152  * Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
153 153  * Go to the next section around installing the eMagiz agent
154 154  
155 -=== 3.7 eMagiz Docker agent installation ===
156 -
157 -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.
158 -
159 -[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
160 -
161 -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.
162 -
163 163  == 4. Assignment ==
164 164  
165 165  Check out the cheatcheet for Docker command line: