Skip to Content

Changes for page Install Docker for Linux

Last modified by Erik Bakker on 2026/01/30 10:56
From version 13.1
edited by eMagiz
on 2022/10/28 12:21
Change comment: There is no comment for this version
To version 127.1
edited by Erik Bakker
on 2024/11/29 08:20
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -On-premises deployment new runtime architecture
1 +Install Docker for Linux
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.eMagiz
1 +XWiki.ebakker
Content
... ... @@ -1,11 +1,8 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
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 -
2 +In eMagiz's current runtime architecture, Docker technology plays a central role in deploying runtimes. eMagiz creates specific runtime images tailored for dockerized environments, streamlining deployment. This section focuses on preparing a Linux server for the installation of the eMagiz Deploy Agent, which facilitates downloading these runtime images from the eMagiz infrastructure.
3 +
4 4  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
6 -* Last update: June 24th 2021
7 -* Required reading time: 10 minutes
8 -
9 9  == 1. Prerequisites ==
10 10  
11 11  * Advanced knowledge of the eMagiz platform
... ... @@ -12,61 +12,144 @@
12 12  * Good understanding of eMagiz runtimes in general
13 13  
14 14  == 2. Key concepts ==
15 -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
12 +In the current 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.
16 16  
14 +In the below section the Linux variant is described in terms of how to prepare the server to allow the [[eMagiz Deploy Agent>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]] to be installed. That agent allows to download images from the eMagiz infrastructure.
15 +
17 17  == 3. On-premises deployments ==
18 18  
19 -===3.1 Installation requirements Windows Server 2019 version 1806===
18 +===3.1 General requirements===
19 +These are the general requirements to allow the installation of the eMagiz Docker agent:
20 20  
21 -Below the installation step for this version of Windows
21 +{{info}}
22 +* Standard configuration to ensure that communication between your server and eMagiz to ensure communication.
23 + ** registry.emagiz.com:443
24 + ** controlplane.emagiz.com:8000
25 + ** controltower.kpn-dsh.com:443
26 + ** Preferably the entry should be *.emagiz.com
27 + ** Preferably the entry should be *.kpn-dsh.com{{/info}}
22 22  
23 -* Enable Hyper-V in Windows Server
24 - ** 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.
25 - ** Restart windows
26 -* Install Docker Desktop on the Windows Server
27 - ** Please refer to this link: https://www.docker.com/products/docker-desktop/
28 - ** Restart windows
29 -* Update Docker desktop configuration
30 - ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
31 - ** Restart Docker
32 -* Open Powershell as Administrator
33 - ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
34 - ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
35 - ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
36 - ** Execute Add-AppxPackage .\ubuntu-2004.appx
37 - ** If errors occur, please consult https://learn.microsoft.com/en-us/windows/wsl/install-on-server. Rename the file to a zip, expand it, and add it to the path variable.
38 -* Ubuntu should now be a runnable program (press windows key, type ubuntu)
39 -* Open the ubuntu terminal, and finish the installation.
40 - ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
29 +{{warning}}
30 +* In case of a very strict firewall configuration, additional configuration is needed to communicate to the eMagiz infrastructure.
31 + ** controltower.emagiz.com:443
32 + ** controltower.kpn-dsh.com:443
33 + ** controlbus.emagiz.com:443
34 + ** controlplane.emagiz.com:443
35 +
36 +* When using cloudslot number **equal to or below** 125, the following configuration is needed to communicate to your JMS.
37 + ** 35.158.46.28:443
38 + ** 3.74.190.88:443
39 + ** 35.158.46.28:8443
40 + ** 3.74.190.88:8443
41 + ** 35.158.46.28:8444
42 + ** 3.74.190.88:8444
43 + ** 18.199.123.240
44 + ** 18.184.211.189
45 + ** 3.123.136.31
46 +
47 +
48 +* When using a cloudslot number **above** 125, the following configuration is needed to communicate to your JMS.
49 + ** 3.74.209.20:443
50 + ** 3.76.127.155:443
51 + ** 3.74.209.20:8443
52 + ** 3.76.127.155:8443
53 + ** 3.74.209.20:8444
54 + ** 3.76.127.155:8444
55 + ** 18.199.123.240
56 + ** 18.184.211.189
57 + ** 3.123.136.31{{/warning}}
58 +
59 +===3.2 Installation Linux===
60 +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.
61 +
62 +==== 3.2.1 Set up Docker's apt repository ====
63 +
64 +{{code language="cmd"}}
65 +# Add Docker's official GPG key:
66 +sudo apt-get update
67 +sudo apt-get install ca-certificates curl
68 +sudo install -m 0755 -d /etc/apt/keyrings
69 +sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
70 +sudo chmod a+r /etc/apt/keyrings/docker.asc
71 +
72 +# Add the repository to Apt sources:
73 +echo \
74 + "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
75 + $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
76 + sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
77 +sudo apt-get update
78 +{{/code}}
79 +
80 +==== 3.2.2 Install Docker ====
81 +
82 +{{code language="cmd"}}
83 +sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
84 +{{/code}}
85 +
41 41  
42 -=== 3.2 Installation agent ===
87 +{{info}}It is advised to use Docker version 24.0.7 as this is the version being used in the latest eMagiz cloud template. We advise to align the on-premise Docker version and update it according to the release notes of the [[Cloud templates>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]].
88 +{{/info}}
43 43  
44 -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.
45 45  
46 -=== 3.3 Cloud architecture for API Gateway ===
47 -
48 -[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-install-runtime-images.png]]
91 +==== 3.2.3 Customization ====
49 49  
50 -== 4. Assignment ==
93 +After installing Docker you have the option to stick with the standard configuration of Docker or you can opt to alter some specific settings. One setting that can be of particular interest is the setting that defines the IP address range your Docker installation will use to run the containers.
51 51  
52 -Check out the cheatcheet for Docker command line:
95 +===== 3.2.3.1 IP address range =====
53 53  
54 -[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
97 +Below you can find the recommended values depending on the range which can be filled in the value <ip-address> below:
98 +* 10.0.0.1/8
99 +** advised value 10.25.0.1/16
100 +* 172.16.0.1/12
101 +** advised value 172.16.0.1/16
102 +* 192.168.0.1/16
103 +** advised value 192.168.0.1/16
55 55  
56 -== 5. Key takeaways ==
105 +{{code language="cmd"}}
106 +sudo nano /etc/docker/daemon.json
107 +#Add following lines
108 +{"bip": "<ip-address>"}
109 +{{/code}}
57 57  
58 -* 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
59 -* eMagiz has a specific agent that manages the download of that image to the on-premises server
60 -* 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.
111 +==== 3.2.4 Verify succesfull installation of the Docker Engine ====
61 61  
113 +{{code language="cmd"}}
114 +sudo docker run hello-world
115 +{{/code}}
62 62  
117 +{{info}}
118 + Requires ~335 Mb space to install
119 +{{/info}}
63 63  
64 -== 6. Suggested Additional Readings ==
121 +==== 3.2.5 Install eMagiz Deploy Agent ====
65 65  
66 -N/A
67 -
68 -== 7. Silent demonstration video ==
123 +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"]]
69 69  
70 -N/A
125 +== 4. Key takeaways ==
71 71  
127 +* 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
128 +* eMagiz has a specific agent that manages the download of that image to the on-premises server
129 +* 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.
130 +
131 +== 5. Suggested Additional Readings ==
132 +
133 +* [[Docker official installation guide (External)>>https://docs.docker.com/engine/install/ubuntu/||target="blank"]]
134 +** [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
135 +*** [[eMagiz Runtime Generation 3 (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]]
136 +* [[Release Information (Menu)>>doc:Main.Release Information.WebHome||target="blank"]]
137 +** [[Environment Templates (Navigation)>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]]
138 +* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
139 +** [[eMagiz Runtime Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome||target="blank"]]
140 +*** [[Interpret on-premise logging (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-interpret-on-premise-logging.WebHome||target="blank"]]
141 +*** [[eMagiz Deploy agent (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
142 +* [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]
143 +** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.WebHome||target="blank"]]
144 +*** [[Impact of Runtime Image Upgrades (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.advanced-lifecycle-management-impact-of-runtime-image-upgrades.WebHome||target="blank"]]
145 +* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
146 +** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome||target="blank"]]
147 +*** [[Install Docker for Windows (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-onpremises-server-windows-installguide.WebHome||target="blank"]]
148 +* [[Install Docker (Search Result)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=install+docker||target="blank"]]
149 +* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
150 +
151 +
72 72  )))((({{toc/}}))){{/container}}{{/container}}