Skip to Content
Last modified by Erik Bakker on 2025/04/18 13:54
From version 70.1
edited by eMagiz
on 2023/02/07 13:22
Change comment: There is no comment for this version
To version 56.1
edited by eMagiz
on 2023/02/07 11:39
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
Content
... ... @@ -1,5 +1,5 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -In this microlearning, we will focus on how an on-premises server can be prepared for a eMagiz Deploy agent installation.
2 +In this microlearning, we will focus on how the installation requirements for on-premises deployments of eMagiz runtimes that are part of the new runtime architecture. The new runtime architecture uses a containerized approach to deploy runtimes.
3 3  
4 4  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
... ... @@ -11,11 +11,12 @@
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 Windows and Linux variants are described in terms of how to prepare the server to allow the eMagiz Deploy agent to be installed. That agent allows to download images from the eMagiz infrastructure.
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.
15 15  
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,20 +22,22 @@
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 {{code}}https://docs.docker.com/engine/install/ubuntu/{{/code}}
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}}
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
36 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 -
40 +===3.3 Installation requirements Windows Server 2022 (without Docker Desktop) ===
41 +
39 39  **Step 1: Install linux distribution**
40 40  
41 41  {{code language="cmd"}}
... ... @@ -45,37 +45,10 @@
45 45   . /etc/os-release
46 46  {{/code}}
47 47  
48 -**Step 2: Configure linux system**
49 -Please see section 3.4 for these these steps
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 53  
54 -First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
52 +**Step 2: Install Docker **
55 55  
56 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 -
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 ===
75 -
76 -**Step 1: Install Docker **
77 -
78 -{{code language="cmd"}}
79 79   curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
80 80   echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
81 81   sudo apt update
... ... @@ -86,7 +86,7 @@
86 86   Requires ~335 Mb space to install
87 87  {{/info}}
88 88  
89 -**Step 2: Install Java **
65 +**Step 3: Install Java **
90 90  
91 91  {{code language="cmd"}}
92 92   wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
... ... @@ -99,7 +99,7 @@
99 99   Requires ~335 Mb space to install
100 100  {{/info}}
101 101  
102 -**Step 3: Ensure Docker is autostarted with WSL **
78 +**Step 4: Ensure Docker is autostarted with WSL **
103 103  
104 104  {{code language="cmd"}}
105 105  nano .bashrc
... ... @@ -111,7 +111,7 @@
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 112  {{/code}}
113 113  
114 -**Step 4: Add user to Docker group **
90 +**Step 5: Add user to Docker group **
115 115  
116 116  {{code language="cmd"}}
117 117  sudo visudo
... ... @@ -122,12 +122,36 @@
122 122   %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
123 123  {{/code}}
124 124  
101 +**Step 6: Update wsl config file **
102 +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
103 +
104 +First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
105 +
106 +
107 +{{code language="cmd"}}
108 + #Add following lines
109 +
110 + # Settings apply across all Linux distros running on WSL 2
111 + [wsl2]
112 + # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
113 + memory=16GB
114 + # Sets the VM to use two virtual processors
115 + processors=2
116 +{{/code}}
117 +
118 +
119 +**Step 7: Auto start the linux subsystem when server restarts **
125 125  
126 126  
127 -===3.5 Installation requirements Windows Server 2019 version 1806===
122 +===3.4 Installation requirements Windows Server 2019 version >1806===
128 128  
129 -{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
124 +These are the requirements to allow the installation of the eMagiz Docker agent:
125 +* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
126 +* Validate if WSL 2.0 is properly installed
127 +* Go to the next section around installing the eMagiz Docker agent
130 130  
129 +===3.5 Installation requirements Windows Server 2019 version 1806===
130 +
131 131  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.
... ... @@ -153,8 +153,6 @@
153 153  
154 154  ===3.6 Installation requirements Windows Server 2012 R2 ===
155 155  
156 -{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
157 -
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.
... ... @@ -169,6 +169,14 @@
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
171 171  
170 +=== 3.7 eMagiz Docker agent installation ===
171 +
172 +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.
173 +
174 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
175 +
176 +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.
177 +
172 172  == 4. Assignment ==
173 173  
174 174  Check out the cheatcheet for Docker command line: