Skip to Content
Last modified by Erik Bakker on 2025/04/18 13:54
From version 75.1
edited by eMagiz
on 2023/02/07 14:52
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,27 +59,24 @@
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"}}
71 -Press Windows+R
72 -Type shell:startup and press enter
73 -
74 - wsl sudo /usr/bin/dockerd
75 -
70 +* Press Windows+R
71 +* Type shell:startup and press enter
72 +* Add or update file start_wsl.bat
73 +* Add following line into the document and save file
74 + * wsl sudo /usr/bin/dockerd
76 76   {{/code}}
77 77  
78 -
79 79  **Step 5: Install eMagiz Deploy Agent**
80 -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"].
81 -
82 -
78 +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"]].
79 +
83 83  ===3.4 Installation steps to configure Linux subsystem ===
84 84  
85 85  **Step 1: Install Docker **
... ... @@ -95,21 +95,12 @@
95 95   Requires ~335 Mb space to install
96 96  {{/info}}
97 97  
98 -**Step 2: Install Java **
95 +**Step 3: Ensure Docker is autostarted with WSL **
99 99  
100 -{{code language="cmd"}}
101 - wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
102 - 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
103 - sudo apt update # update if you haven't already
104 - sudo apt install temurin-8-jdk
105 -{{/code}}
106 -
107 107  {{info}}
108 - Requires ~335 Mb space to install
98 +This remark is valid for Windows based installations only
109 109  {{/info}}
110 110  
111 -**Step 3: Ensure Docker is autostarted with WSL **
112 -
113 113  {{code language="cmd"}}
114 114  nano .bashrc
115 115  
... ... @@ -131,8 +131,29 @@
131 131   %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
132 132  {{/code}}
133 133  
134 -
122 +**Step 5: Ensure safe IP range for WSL **
135 135  
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 +
136 136  ===3.5 Installation requirements Windows Server 2019 version 1806===
137 137  
138 138  {{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
... ... @@ -143,7 +143,10 @@
143 143   ** Restart windows
144 144  * Cross check is WSL 2.0 is installed
145 145   ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
146 -* 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
147 147   ** Please refer to this link: https://www.docker.com/products/docker-desktop/
148 148   ** Restart windows
149 149  * Update Docker Desktop configuration
... ... @@ -159,6 +159,7 @@
159 159  * Open the ubuntu terminal, and finish the installation.
160 160   ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
161 161  * Go to the next section around installing the eMagiz Docker agent
174 +{{/info}}
162 162  
163 163  ===3.6 Installation requirements Windows Server 2012 R2 ===
164 164  
... ... @@ -169,9 +169,9 @@
169 169   ** 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.
170 170   ** Restart windows
171 171  * Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
172 -* Create a VM in HyperV.
185 +* Create a VM in HyperV.
173 173   ** 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).
174 - ** Configure a virtual switch.
187 + ** Configure a virtual switch.
175 175   ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
176 176   ** Install an operating system from bootable CD/DVD, ISO file
177 177  * Install ubuntu downloaded previously on the VM
... ... @@ -178,26 +178,14 @@
178 178  * Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
179 179  * Go to the next section around installing the eMagiz agent
180 180  
181 -== 4. Assignment ==
194 +== 4. Key takeaways ==
182 182  
183 -Check out the cheatcheet for Docker command line:
184 -
185 -[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
186 -
187 -== 5. Key takeaways ==
188 -
189 189  * 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
190 190  * eMagiz has a specific agent that manages the download of that image to the on-premises server
191 191  * 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.
192 192  
200 +== 5. Suggested Additional Readings ==
193 193  
202 +* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
194 194  
195 -== 6. Suggested Additional Readings ==
196 -
197 -N/A
198 -
199 -== 7. Silent demonstration video ==
200 -
201 -N/A
202 -
203 203  )))((({{toc/}}))){{/container}}{{/container}}