Skip to Content

Changes for page Install Docker for Linux

Last modified by Erik Bakker on 2026/01/30 10:56
From version 130.2
edited by Bas Elzinga
on 2024/12/17 12:14
Change comment: There is no comment for this version
To version 24.1
edited by eMagiz
on 2022/11/11 09:45
Change comment: There is no comment for this version

Summary

Details

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