Skip to Content
Last modified by Erik Bakker on 2025/04/18 13:54
From version 78.1
edited by eMagiz
on 2023/02/07 14:54
Change comment: There is no comment for this version
To version 93.1
edited by Carlijn Kokkeler
on 2023/12/07 11:23
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.eMagiz
1 +XWiki.CarlijnKokkeler
Content
... ... @@ -18,7 +18,7 @@
18 18  ===3.1 General requirements===
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 - ** registry.emagiz.com:8443
21 + ** registry.emagiz.com:443
22 22   ** controlplane.emagiz.com:8000
23 23   ** Preferably the entry should be *.emagiz.com
24 24  
... ... @@ -25,7 +25,7 @@
25 25  ===3.2 Installation requirements Linux===
26 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 27  **Step 1: Install linux distribution**
28 -Follow all steps in section 3.4
28 +Follow the relevant steps in section 3.4
29 29  
30 30  **Step 2: Install eMagiz Deploy Agent**
31 31  Install the eMagiz Deploy agent as can be found in this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
... ... @@ -47,7 +47,7 @@
47 47  
48 48  **Step 2: Configure linux system**
49 49  Please see section 3.4 for these these steps
50 -
50 +
51 51  **Step 3: Update wsl config file **
52 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  
... ... @@ -59,12 +59,11 @@
59 59   # Settings apply across all Linux distros running on WSL 2
60 60   [wsl2]
61 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
62 + memory=16GB
63 63   # Sets the VM to use two virtual processors
64 64   processors=2
65 65  {{/code}}
66 66  
67 -
68 68  **Step 4: Auto start the linux subsystem when Windows server restarts **
69 69  
70 70  {{code language="cmd"}}
... ... @@ -77,8 +77,7 @@
77 77  
78 78  **Step 5: Install eMagiz Deploy Agent**
79 79  Install the eMagiz Deploy agent as can be found in this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]].
80 -
81 -
79 +
82 82  ===3.4 Installation steps to configure Linux subsystem ===
83 83  
84 84  **Step 1: Install Docker **
... ... @@ -94,21 +94,12 @@
94 94   Requires ~335 Mb space to install
95 95  {{/info}}
96 96  
97 -**Step 2: Install Java **
95 +**Step 3: Ensure Docker is autostarted with WSL **
98 98  
99 -{{code language="cmd"}}
100 - wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
101 - 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
102 - sudo apt update # update if you haven't already
103 - sudo apt install temurin-8-jdk
104 -{{/code}}
105 -
106 106  {{info}}
107 - Requires ~335 Mb space to install
98 +This remark is valid for Windows based installations only
108 108  {{/info}}
109 109  
110 -**Step 3: Ensure Docker is autostarted with WSL **
111 -
112 112  {{code language="cmd"}}
113 113  nano .bashrc
114 114  
... ... @@ -130,8 +130,29 @@
130 130   %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
131 131  {{/code}}
132 132  
133 -
122 +**Step 5: Ensure safe IP range for WSL **
134 134  
124 +{{info}}
125 +This remark is valid for Windows based installations only
126 +{{/info}}
127 +
128 +This step ensures that the IP address range of the machine doesn't conflict with any IP address of the Linux subsystem. Below the recommended values depending on the range which can be filled in the value <ip-address> below:
129 +* 10.0.0.1/8
130 + ** advised value 10.25.0.1/16
131 +* 172.16.0.1/12
132 + ** advised value 172.16.0.1/16
133 +* 192.168.0.1/16
134 + ** advised value 192.168.0.1/16
135 +
136 +{{code language="cmd"}}
137 +sudo nano /etc/docker/daemon.json
138 +
139 + #Add following lines
140 +
141 + {"bip": "<ip-address>"}
142 +{{/code}}
143 +
144 +
135 135  ===3.5 Installation requirements Windows Server 2019 version 1806===
136 136  
137 137  {{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
... ... @@ -142,7 +142,10 @@
142 142   ** Restart windows
143 143  * Cross check is WSL 2.0 is installed
144 144   ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
145 -* Install Docker Desktop on the Windows Server
155 +* Please follow the instructions for preparing a Windows 2022 installation in section 3.3
156 +
157 +{{info}}
158 + * Install Docker Desktop on the Windows Server
146 146   ** Please refer to this link: https://www.docker.com/products/docker-desktop/
147 147   ** Restart windows
148 148  * Update Docker Desktop configuration
... ... @@ -158,6 +158,7 @@
158 158  * Open the ubuntu terminal, and finish the installation.
159 159   ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
160 160  * Go to the next section around installing the eMagiz Docker agent
174 +{{/info}}
161 161  
162 162  ===3.6 Installation requirements Windows Server 2012 R2 ===
163 163  
... ... @@ -168,9 +168,9 @@
168 168   ** 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 169   ** Restart windows
170 170  * Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
171 -* Create a VM in HyperV.
185 +* Create a VM in HyperV.
172 172   ** For this, choose Generation 1, the amount of memory you want to assign to ubuntu and thus to the containers. Please consider the overhead for memory as well (such as OS).
173 - ** Configure a virtual switch.
187 + ** Configure a virtual switch.
174 174   ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
175 175   ** Install an operating system from bootable CD/DVD, ISO file
176 176  * Install ubuntu downloaded previously on the VM
... ... @@ -177,26 +177,14 @@
177 177  * Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
178 178  * Go to the next section around installing the eMagiz agent
179 179  
180 -== 4. Assignment ==
194 +== 4. Key takeaways ==
181 181  
182 -Check out the cheatcheet for Docker command line:
183 -
184 -[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
185 -
186 -== 5. Key takeaways ==
187 -
188 188  * eMagiz uses runtime images to deploy emagiz runtime on dockerized environments. The runtime image holds all the information and components required to run the runtime
189 189  * eMagiz has a specific agent that manages the download of that image to the on-premises server
190 190  * The firewall of the on-premises environment should allow outgoing traffic without any restriction. In case that is not desirable, eMagiz can provide the addresses and ports needed to setup the right firewall rules.
191 191  
200 +== 5. Suggested Additional Readings ==
192 192  
202 +* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
193 193  
194 -== 6. Suggested Additional Readings ==
195 -
196 -N/A
197 -
198 -== 7. Silent demonstration video ==
199 -
200 -N/A
201 -
202 202  )))((({{toc/}}))){{/container}}{{/container}}