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

* 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

** Preferably the entry should be *.emagiz.com

33

** Preferably the entry should be *.kpn-dsh.com{{/info}}

34

35

36

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

52

53

===3.2 Installation Linux===

54

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.

55

56

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

57

58

59

# Add Docker's official GPG key:

60

sudo apt-get update

61

sudo apt-get install ca-certificates curl

62

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

63

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

64

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

65

66

# Add the repository to Apt sources:

67

echo \

68

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

69

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

70

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

sudo apt-get update

==== 3.2.2 Install Docker ====

75

76

77

sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

78

79

80

==== 3.2.3 Customization ====

81

82

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.

83

84

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

85

86

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

87

* 10.0.0.1/8

88

** advised value 10.25.0.1/16

89

* 172.16.0.1/12

90

** advised value 172.16.0.1/16

91

* 192.168.0.1/16

92

** advised value 192.168.0.1/16

93

94

95

sudo nano /etc/docker/daemon.json

96

#Add following lines

97

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

98

99

100

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

101

102

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

103

104

105

sudo docker run hello-world

Requires ~335 Mb space to install

110

111

112

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

113

114

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

115

116

=== 3.3 Update Docker ===

117

When you are advised to update your Docker version, you can verify whether you are on the correct Docker version by executing the following command in PowerShell with administrative rights:

docker version

When this returns a version **lower** than the advised version shown under the "General requirements" section, you can update Docker on your machine. To do so, execute the following command in PowerShell with administrative rights:

124

125

126

.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION

127

128

129

===3.4 Uninstall Docker===

130

To uninstall Docker from your machine, execute the following commands in PowerShell with administrative rights:

131

132

133

Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Uninstall-docker/uninstall-docker.ps1" -o uninstall-docker-ce.ps1

Example usage:

.\uninstall-docker-ce.ps1

140

141

== 4. Key takeaways ==

142

143

* 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

144

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

145

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

146

147

== 5. Suggested Additional Readings ==

148

149

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

150

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

151

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

152

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

153

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

154

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

155

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

156

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

157

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

158

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

159

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

160

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

161

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

162

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

163

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

164

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

165

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

166

167

168

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

Wiki source code of Install Docker for Linux

Navigation