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

* Standard configuration to ensure that communication between your server and eMagiz to ensure communication.

26

** registry.emagiz.com:443

27

** controlplane.emagiz.com:443

28

** controlplane-agent.emagiz.com:443

29

** controltower.emagiz.com:443

30

** controltower.kpn-dsh.com:443

31

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

38

39

40

* When using **IP Whitelisting**, the following configuration is needed to communicate to your JMS.

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

56

57

===3.2 Installation Linux===

58

59

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.

60

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

67

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

68

69

70

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

71

72

73

# Add Docker's official GPG key:

74

sudo apt-get update

75

sudo apt-get install ca-certificates curl

76

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

77

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

78

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

79

80

# Add the repository to Apt sources:

81

echo \

82

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

83

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

84

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

sudo apt-get update

==== 3.2.2 Install Docker ====

89

90

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

91

92

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>

...

Select the desired version and install:

101

102

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

106

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

121

122

sudo nano /etc/docker/daemon.json

123

#Add following lines

124

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

125

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

132

sudo docker run hello-world

Requires ~335 Mb space to install

137

138

139

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

140

141

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

142

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

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

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

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

166

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

167

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

172

sudo rm -rf /var/lib/docker

173

sudo rm -rf /var/lib/containerd

174

Remove source list and keyrings

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

179

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

180

181

182

== 4. Key takeaways ==

183

184

* 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

185

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

186

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

187

188

== 5. Suggested Additional Readings ==

189

190

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

191

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

192

*** [[eMagiz Runtime Generation 3 (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||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"]]

195

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

196

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

197

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

198

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

199

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

200

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

201

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

202

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

203

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

204

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

206

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

207

208

209

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

Wiki source code of Install Docker for Linux