Install Docker for Linux

{{container}}{{container layoutStyle="columns"}}(((

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

Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].

5

6

== 1. Prerequisites ==

7

8

* Advanced knowledge of the eMagiz platform

9

* Good understanding of eMagiz runtimes in general

10

11

== 2. Key concepts ==

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

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

16

== 3. On-premises deployments ==

17

18

===3.1 General requirements===

19

These are the general requirements to allow the installation of the eMagiz Docker agent:

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"]].

* When **your** security requirements require **DNS Whitelisting**, the following DNS-level configuration is needed to communicate with our infrastructure and the specific eMagiz model(s) you need to connect to. These IP addresses are subject to periodic change on our end.

26

27

** registry.emagiz.com:443

28

** controlplane.emagiz.com:443

29

** controlplane-agent.emagiz.com:443

30

** controltower.emagiz.com:443

31

** controltower.kpn-dsh.com:443

32

** controlbus.emagiz.com:443

33

** {yourcloudslotid}.emagizcloud.com:8443

34

35

* Preferably we suggest to implement the following entries on DNS level.

36

** *.emagizcloud.com

37

** *.emagiz.com

38

** *.kpn-dsh.com{{/info}}

39

40

41

* When **your** security requirements require **IP Whitelisting**, the following IP-level configuration is needed to communicate with our infrastructure and the specific eMagiz model(s) you need to connect to. These IP addresses are subject to periodic change on our end.

** 35.158.46.28:443

** 3.74.190.88:443

** 35.158.46.28:8443

** 3.74.190.88:8443

** 35.158.46.28:8444

** 3.74.190.88:8444

** 3.74.209.20:443

** 3.76.127.155:443

** 3.74.209.20:8443

** 3.76.127.155:8443

** 3.74.209.20:8444

** 3.76.127.155:8444

** 18.199.123.240

** 18.184.211.189

** 3.123.136.31{{/warning}}

58

59

===3.2 Installation Linux===

60

61

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.

62

63

==== 3.2.1 Uninstall old versions ====

64

{{info}}Before you can install Docker Engine, you need to uninstall any conflicting packages.

65

66

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}}

67

68

69

sudo apt remove $(dpkg --get-selections docker.io docker-compose docker-compose-v2 docker-doc podman-docker containerd runc | cut -f1)

70

71

72

==== 3.2.1 Set up Docker's apt repository ====

73

74

75

# Add Docker's official GPG key:

76

sudo apt-get update

77

sudo apt-get install ca-certificates curl

78

sudo install -m 0755 -d /etc/apt/keyrings

79

sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc

80

sudo chmod a+r /etc/apt/keyrings/docker.asc

81

82

# Add the repository to Apt sources:

83

echo \

84

"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \

85

$(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \

86

sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

sudo apt-get update

==== 3.2.2 Install Docker ====

91

92

To install a specific version of Docker Engine, start by listing the available versions in the repository:

93

94

95

apt list --all-versions docker-ce

96

97

docker-ce/noble 5:29.1.5-1~ubuntu.24.04~noble <arch>

98

docker-ce/noble 5:29.1.4-1~ubuntu.24.04~noble <arch>

...

Select the desired version and install:

103

104

105

VERSION_STRING=5:29.1.5-1~ubuntu.24.04~noble

106

sudo apt install docker-ce=$VERSION_STRING docker-ce-cli=$VERSION_STRING containerd.io docker-buildx-plugin docker-compose-plugin

107

108

109

==== 3.2.3 Customization ====

110

111

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.

112

113

===== 3.2.3.1 IP address range =====

114

115

Below you can find the recommended values depending on the range which can be filled in the value <ip-address> below:

116

* 10.0.0.1/8

117

** advised value 10.25.0.1/16

118

* 172.16.0.1/12

119

** advised value 172.16.0.1/16

120

* 192.168.0.1/16

121

** advised value 192.168.0.1/16

122

123

124

sudo nano /etc/docker/daemon.json

125

#Add following lines

126

{"bip": "<ip-address>"}

127

128

129

{{warning}}Be aware that the customization will only take effect once you have restarted Docker.{{/warning}}

130

131

==== 3.2.4 Verify succesfull installation of the Docker Engine ====

132

133

134

sudo docker run hello-world

Requires ~335 Mb space to install

139

140

141

==== 3.2.5 Install eMagiz Deploy Agent ====

142

143

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"]]

144

145

=== 3.3 Update Docker ===

146

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:

147

148

149

apt list --all-versions docker-ce

150

151

docker-ce/noble 5:29.1.5-1~ubuntu.24.04~noble <arch>

152

docker-ce/noble 5:29.1.4-1~ubuntu.24.04~noble <arch>

153

...{{/code}}

154

155

Select the desired version and install.

156

157

158

VERSION_STRING=5:29.1.5-1~ubuntu.24.04~noble

159

sudo apt install docker-ce=$VERSION_STRING docker-ce-cli=$VERSION_STRING containerd.io docker-buildx-plugin docker-compose-plugin

160

161

162

{{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}}

163

164

===3.4 Uninstall Docker===

165

To uninstall Docker from your machine, execute the following command.

166

167

168

sudo apt purge docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin docker-ce-rootless-extras

169

170

171

{{warning}}Images, containers, volumes, or custom configuration files on your host aren't automatically removed. To delete all images, containers, and volumes:

172

173

174

sudo rm -rf /var/lib/docker

175

sudo rm -rf /var/lib/containerd

176

Remove source list and keyrings

sudo rm /etc/apt/sources.list.d/docker.sources

181

sudo rm /etc/apt/keyrings/docker.asc

182

183

184

== 4. Key takeaways ==

185

186

* 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

187

* eMagiz has a specific agent that manages the download of that image to the on-premises server

188

* 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.

189

190

== 5. Suggested Additional Readings ==

191

192

* [[Docker official installation guide (External)>>https://docs.docker.com/engine/install/ubuntu/||target="blank"]]

193

** [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]

194

*** [[eMagiz Runtime Generation 3 (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]]

195

* [[Release Information (Menu)>>doc:Main.Release Information.WebHome||target="blank"]]

196

** [[Environment Templates (Navigation)>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]]

197

* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]

198

** [[eMagiz Runtime Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome||target="blank"]]

199

*** [[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"]]

200

*** [[eMagiz Deploy agent (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]

201

* [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]

202

** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.WebHome||target="blank"]]

203

*** [[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"]]

204

* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]

205

** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome||target="blank"]]

206

*** [[Install Docker for Windows (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-onpremises-server-windows-installguide.WebHome||target="blank"]]

207

* [[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"]]

208

* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]

209

210

211

)))((({{toc/}}))){{/container}}{{/container}}

Wiki source code of Install Docker for Linux

Navigation