Changes for page Install Docker for Linux

Last modified by Erik Bakker on 2026/04/21 12:16

From version 118.1
edited by CarlijnKokkeler
on 2024/09/03 09:50
Change comment: There is no comment for this version
To version 141.1
edited by Erik Bakker
on 2026/04/21 11:58
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.CarlijnKokkeler
1 +XWiki.ebakker
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 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 3  
4 4  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
... ... @@ -9,7 +9,7 @@
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 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.
13 13  
14 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 15  
... ... @@ -18,22 +18,26 @@
18 18  ===3.1 General requirements===
19 19  These are the general requirements to allow the installation of the eMagiz Docker agent:
20 20  
21 +{{info}}It is advised to use Docker version 29.1.3 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"]].
22 +{{/info}}
23 +
21 21  {{info}}
22 22  * Standard configuration to ensure that communication between your server and eMagiz to ensure communication.
23 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}}
28 -
29 -{{warning}}
30 -* In case of a very strict firewall configuration, additional configuration is needed to communicate to the eMagiz infrastructure.
27 + ** controlplane.emagiz.com:443
28 + ** controlplane-agent.emagiz.com:443
31 31   ** controltower.emagiz.com:443
32 32   ** controltower.kpn-dsh.com:443
33 33   ** controlbus.emagiz.com:443
34 - ** controlplane.emagiz.com:443
32 + ** {yourcloudslotid}.emagizcloud.com:8443
33 +
34 +* Preferably we suggest to implement the following entries on DNS level.
35 + ** *.emagizcloud.com
36 + ** *.emagiz.com
37 + ** *.kpn-dsh.com{{/info}}
35 35  
36 -* When using cloudslot number **equal to or below** 125, the following configuration is needed to communicate to your JMS.
39 +{{warning}}
40 +* When using **IP Whitelisting**, the following configuration is needed to communicate to your JMS.
37 37   ** 35.158.46.28:443
38 38   ** 3.74.190.88:443
39 39   ** 35.158.46.28:8443
... ... @@ -40,18 +40,29 @@
40 40   ** 3.74.190.88:8443
41 41   ** 35.158.46.28:8444
42 42   ** 3.74.190.88:8444
43 -
44 -* When using a cloudslot number **above** 125, the following configuration is needed to communicate to your JMS.
45 45   ** 3.74.209.20:443
46 46   ** 3.76.127.155:443
47 47   ** 3.74.209.20:8443
48 48   ** 3.76.127.155:8443
49 49   ** 3.74.209.20:8444
50 - ** 3.76.127.155:8444{{/warning}}
52 + ** 3.76.127.155:8444
53 + ** 18.199.123.240
54 + ** 18.184.211.189
55 + ** 3.123.136.31{{/warning}}
51 51  
52 52  ===3.2 Installation Linux===
58 +
53 53  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.
54 54  
61 +==== 3.2.1 Uninstall old versions ====
62 +{{info}}Before you can install Docker Engine, you need to uninstall any conflicting packages.
63 +
64 +Your Linux distribution may provide unofficial Docker packages, which may conflict with the official packages provided by Docker. You must uninstall these packages before you install the official version of Docker Engine.{{/info}}
65 +
66 +{{code language="cmd"}}
67 +sudo apt remove $(dpkg --get-selections docker.io docker-compose docker-compose-v2 docker-doc podman-docker containerd runc | cut -f1)
68 +{{/code}}
69 +
55 55  ==== 3.2.1 Set up Docker's apt repository ====
56 56  
57 57  {{code language="cmd"}}
... ... @@ -72,16 +72,48 @@
72 72  
73 73  ==== 3.2.2 Install Docker ====
74 74  
90 +To install a specific version of Docker Engine, start by listing the available versions in the repository:
91 +
75 75  {{code language="cmd"}}
76 -sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
93 +apt list --all-versions docker-ce
94 +
95 +docker-ce/noble 5:29.1.5-1~ubuntu.24.04~noble <arch>
96 +docker-ce/noble 5:29.1.4-1~ubuntu.24.04~noble <arch>
97 +...
77 77  {{/code}}
78 78  
79 -{{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"]].
80 -{{/info}}
100 +Select the desired version and install:
81 81  
82 -==== 3.2.3 Verify succesfull installation of the Docker Engine ====
102 +{{code language="cmd"}}
103 +VERSION_STRING=5:29.1.5-1~ubuntu.24.04~noble
104 +sudo apt install docker-ce=$VERSION_STRING docker-ce-cli=$VERSION_STRING containerd.io docker-buildx-plugin docker-compose-plugin
105 +{{/code}}
83 83  
107 +==== 3.2.3 Customization ====
108 +
109 +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.
110 +
111 +===== 3.2.3.1 IP address range =====
112 +
113 +Below you can find the recommended values depending on the range which can be filled in the value <ip-address> below:
114 +* 10.0.0.1/8
115 +** advised value 10.25.0.1/16
116 +* 172.16.0.1/12
117 +** advised value 172.16.0.1/16
118 +* 192.168.0.1/16
119 +** advised value 192.168.0.1/16
120 +
84 84  {{code language="cmd"}}
122 +sudo nano /etc/docker/daemon.json
123 +#Add following lines
124 +{"bip": "<ip-address>"}
125 +{{/code}}
126 +
127 +{{warning}}Be aware that the customization will only take effect once you have restarted Docker.{{/warning}}
128 +
129 +==== 3.2.4 Verify succesfull installation of the Docker Engine ====
130 +
131 +{{code language="cmd"}}
85 85  sudo docker run hello-world
86 86  {{/code}}
87 87  
... ... @@ -89,10 +89,49 @@
89 89   Requires ~335 Mb space to install
90 90  {{/info}}
91 91  
92 -==== 3.2.4 Install eMagiz Deploy Agent ====
139 +==== 3.2.5 Install eMagiz Deploy Agent ====
93 93  
94 94  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"]]
95 95  
143 +=== 3.3 Update Docker ===
144 +When you are advised to update your Docker version, you can follow the following procedure to update to a specific version of Docker Engine, start by listing the available versions in the repository:
145 +
146 +{{code language="cmd"}}
147 +apt list --all-versions docker-ce
148 +
149 +docker-ce/noble 5:29.1.5-1~ubuntu.24.04~noble <arch>
150 +docker-ce/noble 5:29.1.4-1~ubuntu.24.04~noble <arch>
151 +...{{/code}}
152 +
153 +Select the desired version and install.
154 +
155 +{{code language="cmd"}}
156 +VERSION_STRING=5:29.1.5-1~ubuntu.24.04~noble
157 +sudo apt install docker-ce=$VERSION_STRING docker-ce-cli=$VERSION_STRING containerd.io docker-buildx-plugin docker-compose-plugin
158 +{{/code}}
159 +
160 +{{warning}}It may happen that, due to the update, your containers are no longer starting up. To resolve this, please restart the containers, which can be done via a deployment plan or the deploy architecture.{{/warning}}
161 +
162 +===3.4 Uninstall Docker===
163 +To uninstall Docker from your machine, execute the following command.
164 +
165 +{{code language="cmd"}}
166 +sudo apt purge docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin docker-ce-rootless-extras
167 +{{/code}}
168 +
169 +{{warning}}Images, containers, volumes, or custom configuration files on your host aren't automatically removed. To delete all images, containers, and volumes:
170 +
171 +{{code language="cmd"}}
172 +sudo rm -rf /var/lib/docker
173 +sudo rm -rf /var/lib/containerd
174 +Remove source list and keyrings
175 +{{/code}}
176 +
177 +{{code language="cmd"}}
178 + sudo rm /etc/apt/sources.list.d/docker.sources
179 + sudo rm /etc/apt/keyrings/docker.asc
180 +{{/code}}
181 +{{/warning}}
96 96  == 4. Key takeaways ==
97 97  
98 98  * 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
... ... @@ -104,8 +104,8 @@
104 104  * [[Docker official installation guide (External)>>https://docs.docker.com/engine/install/ubuntu/||target="blank"]]
105 105  ** [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
106 106  *** [[eMagiz Runtime Generation 3 (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]]
107 -* [[Release Information (Menu)>>doc:Main.eMagiz Academy.Release Information.WebHome||target="blank"]]
108 -** [[Environment Templates (Navigation)>>doc:Main.eMagiz Academy.Release Information.Cloud Templates.WebHome||target="blank"]]
193 +* [[Release Information (Menu)>>doc:Main.Release Information.WebHome||target="blank"]]
194 +** [[Environment Templates (Navigation)>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]]
109 109  * [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
110 110  ** [[eMagiz Runtime Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome||target="blank"]]
111 111  *** [[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"]]
... ... @@ -116,8 +116,8 @@
116 116  * [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
117 117  ** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome||target="blank"]]
118 118  *** [[Install Docker for Windows (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-onpremises-server-windows-installguide.WebHome||target="blank"]]
205 +* [[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"]]
119 119  * Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
120 120  
121 121  
122 -
123 123  )))((({{toc/}}))){{/container}}{{/container}}