Changes for page Install Docker for Linux

Last modified by Erik Bakker on 2025/10/19 21:13

From version 79.1
edited by eMagiz
on 2023/02/07 14:56
Change comment: There is no comment for this version
To version 19.1
edited by eMagiz
on 2022/11/11 09:27
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-premises deployment new runtime architecture
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  
... ... @@ -9,146 +9,43 @@
9 9  * Good understanding of eMagiz runtimes in general
10 10  
11 11  == 2. Key concepts ==
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.
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 envirionments
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.
15 -
16 16  == 3. On-premises deployments ==
15 +
16 +===3.1 Installation requirements Linux===
17 17  
18 -===3.1 General requirements===
19 -These are the general requirements to allow the installation of the eMagiz Docker agent:
18 +These are the 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
22 - ** controlplane.emagiz.com:8000
20 + ** registry.emagiz.com
21 + ** testing.emagiz.com
23 23   ** Preferably the entry should be *.emagiz.com
23 +* Install latest version of Docker
24 24  
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
25 +===3.2 Installation requirements Windows Server 2022===
29 29  
30 -**Step 2: Install eMagiz Deploy Agent**
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"]]
32 -
33 -===3.3 Installation requirements Windows Server 2022 ===
34 -
35 -{{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
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 -
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
46 -{{/code}}
47 -
48 -**Step 2: Configure linux system**
49 -Please see section 3.4 for these these steps
27 +These are the requirements to allow the installation of the eMagiz Docker agent:
28 +* Ensure access to the following URLs is enabled
29 + ** registry.emagiz.com
30 + ** testing.emagiz.com
31 + ** Preferably the entry should be *.emagiz.com
32 +* Install latest version of Docker
33 +* Validate if WSL 2.0 is properly installed
50 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
35 +===3.3 Installation requirements Windows Server 2019 version 1806===
53 53  
54 -First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
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 -{{code language="cmd"}}
71 -* Press Windows+R
72 -* Type shell:startup and press enter
73 -* Add or update file start_wsl.bat
74 -* Add following line into the document and save file
75 - * wsl sudo /usr/bin/dockerd
76 - {{/code}}
77 -
78 -**Step 5: Install eMagiz Deploy Agent**
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 -
82 -===3.4 Installation steps to configure Linux subsystem ===
83 -
84 -**Step 1: Install Docker **
85 -
86 -{{code language="cmd"}}
87 - curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
88 - echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
89 - sudo apt update
90 - sudo apt install docker-ce docker-ce-cli containerd.io
91 -{{/code}}
92 -
93 -{{info}}
94 - Requires ~335 Mb space to install
95 -{{/info}}
96 -
97 -**Step 2: Install Java **
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 -{{info}}
107 - Requires ~335 Mb space to install
108 -{{/info}}
109 -
110 -**Step 3: Ensure Docker is autostarted with WSL **
111 -
112 -{{code language="cmd"}}
113 -nano .bashrc
114 -
115 - #Add following lines to bashrc
116 - DOCKER_DISTRO="Ubuntu"
117 - DOCKER_LOG_DIR=$HOME/docker_logs
118 - mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
119 - /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
120 -{{/code}}
121 -
122 -**Step 4: Add user to Docker group **
123 -
124 -{{code language="cmd"}}
125 -sudo visudo
126 -
127 - #Add following lines
128 -
129 - # Don't ask for password
130 - %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
131 -{{/code}}
132 -
133 -
134 -
135 -===3.5 Installation requirements Windows Server 2019 version 1806===
136 -
137 -{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
138 -
139 139  These are the requirements to allow the installation of the eMagiz Docker agent:
38 +* Ensure access to the following URLs is enabled
39 + ** registry.emagiz.com
40 + ** testing.emagiz.com
41 + ** Preferably the entry should be *.emagiz.com
140 140  * Enable Hyper-V in Windows Server
141 141   ** 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.
142 142   ** Restart windows
143 -* Cross check is WSL 2.0 is installed
144 - ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
145 -* Please follow the instructions for preparing a Windows 2022 installation in section 3.3
146 -
147 -{{info}}
148 - * Install Docker Desktop on the Windows Server
45 +* Install Docker Desktop on the Windows Server
149 149   ** Please refer to this link: https://www.docker.com/products/docker-desktop/
150 150   ** Restart windows
151 -* Update Docker Desktop configuration
48 +* Update Docker desktop configuration
152 152   ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
153 153   ** Restart Docker
154 154  * Open Powershell as Administrator
... ... @@ -160,14 +160,14 @@
160 160  * Ubuntu should now be a runnable program (press windows key, type ubuntu)
161 161  * Open the ubuntu terminal, and finish the installation.
162 162   ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
163 -* Go to the next section around installing the eMagiz Docker agent
164 -{{/info}}
165 -
166 -===3.6 Installation requirements Windows Server 2012 R2 ===
167 -
168 -{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
169 -
60 +
61 +===3.4 Installation requirements Windows Server 2012 R2 ===
62 +
170 170  These are the requirements to allow the installation of the eMagiz Docker agent:
64 +* Ensure access to the following URLs is enabled
65 + ** registry.emagiz.com
66 + ** testing.emagiz.com
67 + ** Preferably the entry should be *.emagiz.com
171 171  * Install & enable Hyper-V in Windows Server
172 172   ** 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.
173 173   ** Restart windows
... ... @@ -179,12 +179,19 @@
179 179   ** Install an operating system from bootable CD/DVD, ISO file
180 180  * Install ubuntu downloaded previously on the VM
181 181  * Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
182 -* Go to the next section around installing the eMagiz agent
79 +
80 +=== 3.5 Installation agent ===
81 +
82 +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 or is available upon request. Once that agent is installed, the image that is generated for every eMagiz release can be downloaded and installed in the Docker instance.
83 +
84 +=== 3.3 Cloud architecture for API Gateway ===
85 +
86 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-install-runtime-images.png]]
183 183  
184 184  == 4. Assignment ==
185 185  
186 186  Check out the cheatcheet for Docker command line:
187 -
91 +
188 188  [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
189 189  
190 190  == 5. Key takeaways ==
... ... @@ -191,7 +191,7 @@
191 191  
192 192  * 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
193 193  * eMagiz has a specific agent that manages the download of that image to the on-premises server
194 -* 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.
98 +* 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.
195 195  
196 196  
197 197