Skip to Content
Last modified by Erik Bakker on 2025/04/18 13:54
From version 57.1
edited by eMagiz
on 2023/02/07 11:42
Change comment: There is no comment for this version
To version 65.2
edited by eMagiz
on 2023/02/07 12:39
Change comment: Update document after refactoring.

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -On-premise Install Guide
1 +expert-solution-architecture-onpremises-installguide2
Content
... ... @@ -26,23 +26,19 @@
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. Other Linux distributions will also work such as Debian or Red Hat.
30 -* Install latest version of the Docker engine - see for instance this link below. For other Linux distributions similar install guides are available on this link.
29 +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.
30 +**Step 1: Install linux distribution**
31 +Follow all steps in section 3.4
31 31  
32 -{{code}}https://docs.docker.com/engine/install/ubuntu/{{/code}}
33 +**Step 2: Install eMagiz Deploy Agent**
34 +Install the eMagiz Deploy agent as can be found here
33 33  
36 +===3.3 Installation requirements Windows Server 2022 ===
34 34  
35 - * Install the eMagiz Deploy agent
38 +{{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
36 36  
37 -===3.3 Installation requirements Windows Server 2022===
40 +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 38  
39 -These are the requirements to allow the installation of the eMagiz Docker agent:
40 -* Install latest version of Docker Desktop from {{code}}https://www.docker.com/products/docker-desktop/{{/code}}
41 -* Validate if WSL 2.0 is properly installed
42 -* Go to the next section around installing the eMagiz Docker agent
43 -
44 -===3.3 Installation requirements Windows Server 2022 (without Docker Desktop) ===
45 -
46 46  **Step 1: Install linux distribution**
47 47  
48 48  {{code language="cmd"}}
... ... @@ -52,10 +52,37 @@
52 52   . /etc/os-release
53 53  {{/code}}
54 54  
51 +**Step 2: Configure linux system**
52 +Please see section 3.4 for these these steps
53 +
54 +**Step 3: Update wsl config file **
55 +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
55 55  
56 -**Step 2: Install Docker **
57 +First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
57 57  
58 58  {{code language="cmd"}}
60 + #Add following lines
61 +
62 + # Settings apply across all Linux distros running on WSL 2
63 + [wsl2]
64 + # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
65 + memory=16GB
66 + # Sets the VM to use two virtual processors
67 + processors=2
68 +{{/code}}
69 +
70 +
71 +**Step 4: Auto start the linux subsystem when Windows server restarts **
72 +
73 +**Step 5: Install eMagiz Deploy Agent**
74 +Install the eMagiz Deploy agent as can be found here
75 +
76 +
77 +===3.4 Installation steps to configure Linux subsystem ===
78 +
79 +**Step 1: Install Docker **
80 +
81 +{{code language="cmd"}}
59 59   curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
60 60   echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
61 61   sudo apt update
... ... @@ -66,7 +66,7 @@
66 66   Requires ~335 Mb space to install
67 67  {{/info}}
68 68  
69 -**Step 3: Install Java **
92 +**Step 2: Install Java **
70 70  
71 71  {{code language="cmd"}}
72 72   wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
... ... @@ -79,7 +79,7 @@
79 79   Requires ~335 Mb space to install
80 80  {{/info}}
81 81  
82 -**Step 4: Ensure Docker is autostarted with WSL **
105 +**Step 3: Ensure Docker is autostarted with WSL **
83 83  
84 84  {{code language="cmd"}}
85 85  nano .bashrc
... ... @@ -91,7 +91,7 @@
91 91   /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
92 92  {{/code}}
93 93  
94 -**Step 5: Add user to Docker group **
117 +**Step 4: Add user to Docker group **
95 95  
96 96  {{code language="cmd"}}
97 97  sudo visudo
... ... @@ -102,36 +102,12 @@
102 102   %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
103 103  {{/code}}
104 104  
105 -**Step 6: Update wsl config file **
106 -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
107 -
108 -First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
109 -
110 -
111 -{{code language="cmd"}}
112 - #Add following lines
113 -
114 - # Settings apply across all Linux distros running on WSL 2
115 - [wsl2]
116 - # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
117 - memory=16GB
118 - # Sets the VM to use two virtual processors
119 - processors=2
120 -{{/code}}
121 -
122 -
123 -**Step 7: Auto start the linux subsystem when server restarts **
124 124  
125 125  
126 -===3.4 Installation requirements Windows Server 2019 version >1806===
127 -
128 -These are the requirements to allow the installation of the eMagiz Docker agent:
129 -* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
130 -* Validate if WSL 2.0 is properly installed
131 -* Go to the next section around installing the eMagiz Docker agent
132 -
133 133  ===3.5 Installation requirements Windows Server 2019 version 1806===
134 134  
132 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
133 +
135 135  These are the requirements to allow the installation of the eMagiz Docker agent:
136 136  * Enable Hyper-V in Windows Server
137 137   ** 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.
... ... @@ -157,6 +157,8 @@
157 157  
158 158  ===3.6 Installation requirements Windows Server 2012 R2 ===
159 159  
159 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
160 +
160 160  These are the requirements to allow the installation of the eMagiz Docker agent:
161 161  * Install & enable Hyper-V in Windows Server
162 162   ** 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.
... ... @@ -171,14 +171,6 @@
171 171  * Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
172 172  * Go to the next section around installing the eMagiz agent
173 173  
174 -=== 3.7 eMagiz Docker agent installation ===
175 -
176 -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.
177 -
178 -[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
179 -
180 -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.
181 -
182 182  == 4. Assignment ==
183 183  
184 184  Check out the cheatcheet for Docker command line: