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