Skip to Content
Last modified by Erik Bakker on 2025/04/18 13:54
From version 71.1
edited by eMagiz
on 2023/02/07 14:20
Change comment: There is no comment for this version
To version 43.1
edited by eMagiz
on 2023/01/26 08:57
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,115 +22,78 @@
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 -
39 -**Step 1: Install linux distribution**
40 -
40 +Step 1: Install linux distribution
41 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
42 +wsl --install -d Ubuntu
46 46  {{/code}}
44 +
45 + #Install docker
46 +sudo apt-get update
47 +sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
48 +. /etc/os-release
49 +curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
50 +echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
51 +sudo apt update
52 +sudo apt install docker-ce docker-ce-cli containerd.io
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
54 +#Install Java
55 +wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
56 +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
57 +sudo apt update # update if you haven't already
58 +sudo apt install temurin-8-jdk
53 53  
54 -First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
60 +#Autostart Dockerd with wsl
55 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 -
68 -**Step 4: Auto start the linux subsystem when Windows server restarts **
69 -
70 - wsl sudo /usr/bin/dockerd
71 -
72 -**Step 5: Install eMagiz Deploy Agent**
73 -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"]]
74 -
75 -
76 -===3.4 Installation steps to configure Linux subsystem ===
77 -
78 -**Step 1: Install Docker **
79 -
80 -{{code language="cmd"}}
81 - curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
82 - echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
83 - sudo apt update
84 - sudo apt install docker-ce docker-ce-cli containerd.io
85 -{{/code}}
86 -
87 -{{info}}
88 - Requires ~335 Mb space to install
89 -{{/info}}
90 -
91 -**Step 2: Install Java **
92 -
93 -{{code language="cmd"}}
94 - wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
95 - 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
96 - sudo apt update # update if you haven't already
97 - sudo apt install temurin-8-jdk
98 -{{/code}}
99 -
100 -{{info}}
101 - Requires ~335 Mb space to install
102 -{{/info}}
103 -
104 -**Step 3: Ensure Docker is autostarted with WSL **
105 -
106 -{{code language="cmd"}}
107 107  nano .bashrc
108 108  
109 - #Add following lines to bashrc
110 110   DOCKER_DISTRO="Ubuntu"
111 111   DOCKER_LOG_DIR=$HOME/docker_logs
112 112   mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
113 113   /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
114 -{{/code}}
115 115  
116 -**Step 4: Add user to Docker group **
117 -
118 -{{code language="cmd"}}
69 +#Do not ask password dockerd
119 119  sudo visudo
120 120  
121 - #Add following lines
72 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
122 122  
123 - # Don't ask for password
124 - %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
125 -{{/code}}
74 +#Set WSL config for memory
75 +USERDIR/.wslconfig
76 + # Settings apply across all Linux distros running on WSL 2
77 + [wsl2]
126 126  
127 -
79 + # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
80 + memory=16GB
128 128  
129 -===3.5 Installation requirements Windows Server 2019 version 1806===
82 + # Sets the VM to use two virtual processors
83 + processors=2
130 130  
131 -{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
85 +(Exit WSL: wsl --shutdown)
86 + {{/code}}
132 132  
88 +===3.4 Installation requirements Windows Server 2019 version >1806===
89 +
133 133  These are the requirements to allow the installation of the eMagiz Docker agent:
91 +* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
92 +* Validate if WSL 2.0 is properly installed
93 +* Go to the next section around installing the eMagiz Docker agent
94 +
95 +===3.5 Installation requirements Windows Server 2019 version 1806===
96 +
97 +These are the requirements to allow the installation of the eMagiz Docker agent:
134 134  * Enable Hyper-V in Windows Server
135 135   ** 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.
136 136   ** Restart windows
... ... @@ -155,8 +155,6 @@
155 155  
156 156  ===3.6 Installation requirements Windows Server 2012 R2 ===
157 157  
158 -{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
159 -
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,6 +171,14 @@
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  
136 +=== 3.7 eMagiz Docker agent installation ===
137 +
138 +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.
139 +
140 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
141 +
142 +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.
143 +
174 174  == 4. Assignment ==
175 175  
176 176  Check out the cheatcheet for Docker command line: