Skip to Content

Changes for page Install Docker for Linux

Last modified by Erik Bakker on 2026/01/30 10:56
From version 31.1
edited by eMagiz
on 2022/11/28 14:12
Change comment: There is no comment for this version
To version 133.1
edited by Erik Bakker
on 2025/10/19 21:13
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,5 +1,5 @@
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.
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,108 +9,136 @@
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 -In the below section the specific operating systems and versions are discussed in a sense that the prerequisite installations are described. Once the right installation is done, refer to section 3.7 for the installation of the eMagiz agent that manages the interaction with the eMagiz platform. That agent will download the created docker images that will be deployed in the Docker environment.
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  
16 16  == 3. On-premises deployments ==
17 17  
18 18  ===3.1 General requirements===
19 -
20 20  These are the general requirements to allow the installation of the eMagiz Docker agent:
21 -* Ensure access to the following URLs is enabled
22 - ** registry.emagiz.com
23 - ** testing.emagiz.com
20 +
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:443
25 + ** controlplane-agent.emagiz.com:443
26 + ** controltower.emagiz.com:443
27 + ** controltower.kpn-dsh.com:443
28 + ** controlbus.emagiz.com:443
24 24   ** Preferably the entry should be *.emagiz.com
30 + ** Preferably the entry should be *.kpn-dsh.com{{/info}}
25 25  
26 -
27 -===3.2 Installation requirements Linux===
32 +{{warning}}
33 +* When using **IP Whitelisting**, the following configuration is needed to communicate to your JMS.
34 + ** 35.158.46.28:443
35 + ** 3.74.190.88:443
36 + ** 35.158.46.28:8443
37 + ** 3.74.190.88:8443
38 + ** 35.158.46.28:8444
39 + ** 3.74.190.88:8444
40 + ** 3.74.209.20:443
41 + ** 3.76.127.155:443
42 + ** 3.74.209.20:8443
43 + ** 3.76.127.155:8443
44 + ** 3.74.209.20:8444
45 + ** 3.76.127.155:8444
46 + ** 18.199.123.240
47 + ** 18.184.211.189
48 + ** 3.123.136.31{{/warning}}
28 28  
29 -* Whenever Linux is selected as operating system, the latest version of Ubuntu will work
30 -* Install latest version of the Docker engine - see for instance https://docs.docker.com/engine/install/ubuntu/
31 -* Go to the next section around installing the eMagiz agent
50 +===3.2 Installation Linux===
51 +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.
32 32  
33 -===3.3 Installation requirements Windows Server 2022===
53 +==== 3.2.1 Set up Docker's apt repository ====
34 34  
35 -These are the requirements to allow the installation of the eMagiz Docker agent:
36 -* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
37 -* Validate if WSL 2.0 is properly installed
38 -* Go to the next section around installing the eMagiz Docker agent
55 +{{code language="cmd"}}
56 +# Add Docker's official GPG key:
57 +sudo apt-get update
58 +sudo apt-get install ca-certificates curl
59 +sudo install -m 0755 -d /etc/apt/keyrings
60 +sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
61 +sudo chmod a+r /etc/apt/keyrings/docker.asc
39 39  
40 -===3.4 Installation requirements Windows Server 2019 version >1806===
63 +# Add the repository to Apt sources:
64 +echo \
65 + "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
66 + $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
67 + sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
68 +sudo apt-get update
69 +{{/code}}
41 41  
42 -These are the requirements to allow the installation of the eMagiz Docker agent:
43 -* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
44 -* Validate if WSL 2.0 is properly installed
45 -* Go to the next section around installing the eMagiz Docker agent
46 -
47 -===3.5 Installation requirements Windows Server 2019 version 1806===
71 +==== 3.2.2 Install Docker ====
48 48  
49 -These are the requirements to allow the installation of the eMagiz Docker agent:
50 -* Enable Hyper-V in Windows Server
51 - ** 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.
52 - ** Restart windows
53 -* Cross check is WSL 2.0 is installed
54 - ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
55 -* Install Docker Desktop on the Windows Server
56 - ** Please refer to this link: https://www.docker.com/products/docker-desktop/
57 - ** Restart windows
58 -* Update Docker Desktop configuration
59 - ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
60 - ** Restart Docker
61 -* Open Powershell as Administrator
62 - ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
63 - ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
64 - ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
65 - ** Execute Add-AppxPackage .\ubuntu-2004.appx
66 - *** 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.
67 -* Ubuntu should now be a runnable program (press windows key, type ubuntu)
68 -* Open the ubuntu terminal, and finish the installation.
69 - ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
70 -* Go to the next section around installing the eMagiz Docker agent
71 -
72 -===3.6 Installation requirements Windows Server 2012 R2 ===
73 -
74 -These are the requirements to allow the installation of the eMagiz Docker agent:
75 -* Install & enable Hyper-V in Windows Server
76 - ** 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.
77 - ** Restart windows
78 -* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
79 -* Create a VM in HyperV.
80 - ** For this, choose Generation 1, the amount of memory you want to assign to ubuntu and thus to the containers. Please consider the overhead for memory as well (such as OS).
81 - ** Configure a virtual switch.
82 - ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
83 - ** Install an operating system from bootable CD/DVD, ISO file
84 -* Install ubuntu downloaded previously on the VM
85 -* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
86 -* Go to the next section around installing the eMagiz agent
87 -
88 -=== 3.7 eMagiz Docker agent installation ===
89 -
90 -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 when the machine is used for the first time deployment of eMagiz runtimes. A popup will appear that displays the commands per type of OS. Once that agent is installed, the image that is generated for every eMagiz release can be downloaded and installed in the Docker instance.
73 +{{code language="cmd"}}
74 +sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
75 +{{/code}}
91 91  
92 -After installing the agent, you can use the Docker cheat sheet below to see if the docker containers are running and/or images are available.
93 93  
94 -== 4. Assignment ==
78 +{{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"]].
79 +{{/info}}
95 95  
96 -Check out the cheatcheet for Docker command line:
81 +==== 3.2.3 Customization ====
82 +
83 +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.
84 +
85 +===== 3.2.3.1 IP address range =====
97 97  
98 -[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
87 +Below you can find the recommended values depending on the range which can be filled in the value <ip-address> below:
88 +* 10.0.0.1/8
89 +** advised value 10.25.0.1/16
90 +* 172.16.0.1/12
91 +** advised value 172.16.0.1/16
92 +* 192.168.0.1/16
93 +** advised value 192.168.0.1/16
99 99  
100 -== 5. Key takeaways ==
95 +{{code language="cmd"}}
96 +sudo nano /etc/docker/daemon.json
97 +#Add following lines
98 +{"bip": "<ip-address>"}
99 +{{/code}}
101 101  
102 -* 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
103 -* eMagiz has a specific agent that manages the download of that image to the on-premises server
104 -* 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.
101 +{{warning}}Be aware that the customization will only take effect once you have restarted Docker.{{/warning}}
105 105  
103 +==== 3.2.4 Verify succesfull installation of the Docker Engine ====
106 106  
105 +{{code language="cmd"}}
106 +sudo docker run hello-world
107 +{{/code}}
107 107  
108 -== 6. Suggested Additional Readings ==
109 +{{info}}
110 + Requires ~335 Mb space to install
111 +{{/info}}
109 109  
110 -N/A
111 -
112 -== 7. Silent demonstration video ==
113 +==== 3.2.5 Install eMagiz Deploy Agent ====
113 113  
114 -N/A
115 +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 115  
117 +== 4. Key takeaways ==
118 +
119 +* 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
120 +* eMagiz has a specific agent that manages the download of that image to the on-premises server
121 +* 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.
122 +
123 +== 5. Suggested Additional Readings ==
124 +
125 +* [[Docker official installation guide (External)>>https://docs.docker.com/engine/install/ubuntu/||target="blank"]]
126 +** [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
127 +*** [[eMagiz Runtime Generation 3 (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]]
128 +* [[Release Information (Menu)>>doc:Main.Release Information.WebHome||target="blank"]]
129 +** [[Environment Templates (Navigation)>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]]
130 +* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
131 +** [[eMagiz Runtime Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome||target="blank"]]
132 +*** [[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"]]
133 +*** [[eMagiz Deploy agent (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
134 +* [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]
135 +** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.WebHome||target="blank"]]
136 +*** [[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"]]
137 +* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
138 +** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome||target="blank"]]
139 +*** [[Install Docker for Windows (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-onpremises-server-windows-installguide.WebHome||target="blank"]]
140 +* [[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"]]
141 +* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
142 +
143 +
116 116  )))((({{toc/}}))){{/container}}{{/container}}