Skip to Content

Changes for page Install Docker for Linux

Last modified by Erik Bakker on 2026/01/30 10:56
From version 134.1
edited by Erik Bakker
on 2026/01/23 12:52
Change comment: There is no comment for this version
To version 49.1
edited by eMagiz
on 2023/02/06 08:43
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-premise Install Guide
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ebakker
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,100 +9,53 @@
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 environments.
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.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.
15 15  
16 16  == 3. On-premises deployments ==
17 17  
18 18  ===3.1 General requirements===
19 +
19 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"]].
22 -{{/info}}
23 -
24 -{{info}}
25 -* 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
21 +* Ensure access to the following URLs is enabled
22 + ** registry.emagiz.com:8443
23 + ** controlplane.emagiz.com:8000
32 32   ** Preferably the entry should be *.emagiz.com
33 - ** Preferably the entry should be *.kpn-dsh.com{{/info}}
34 34  
35 -{{warning}}
36 -* When using **IP Whitelisting**, the following configuration is needed to communicate to your JMS.
37 - ** 35.158.46.28:443
38 - ** 3.74.190.88:443
39 - ** 35.158.46.28:8443
40 - ** 3.74.190.88:8443
41 - ** 35.158.46.28:8444
42 - ** 3.74.190.88:8444
43 - ** 3.74.209.20:443
44 - ** 3.76.127.155:443
45 - ** 3.74.209.20:8443
46 - ** 3.76.127.155:8443
47 - ** 3.74.209.20:8444
48 - ** 3.76.127.155:8444
49 - ** 18.199.123.240
50 - ** 18.184.211.189
51 - ** 3.123.136.31{{/warning}}
26 +
27 +===3.2 Installation requirements Linux===
52 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.
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 {{code}}https://docs.docker.com/engine/install/ubuntu/{{/code}}
31 +* Go to the next section around installing the eMagiz agent
55 55  
56 -==== 3.2.1 Set up Docker's apt repository ====
33 +===3.3 Installation requirements Windows Server 2022===
57 57  
58 -{{code language="cmd"}}
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
35 +These are the requirements to allow the installation of the eMagiz Docker agent:
36 +* Install latest version of Docker Desktop from {{code}}https://www.docker.com/products/docker-desktop/{{/code}}
37 +* Validate if WSL 2.0 is properly installed
38 +* Go to the next section around installing the eMagiz Docker agent
65 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
71 -sudo apt-get update
72 -{{/code}}
73 -
74 -==== 3.2.2 Install Docker ====
75 -
76 -{{code language="cmd"}}
77 -sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
78 -{{/code}}
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 =====
40 +===3.3 Installation requirements Windows Server 2022 (without Docker Desktop) ===
85 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
42 +**Step 1: Install linux distribution**
93 93  
94 94  {{code language="cmd"}}
95 -sudo nano /etc/docker/daemon.json
96 -#Add following lines
97 -{"bip": "<ip-address>"}
45 + wsl --install -d Ubuntu
46 + sudo apt-get update
47 + sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
48 + . /etc/os-release
98 98  {{/code}}
99 99  
100 -{{warning}}Be aware that the customization will only take effect once you have restarted Docker.{{/warning}}
101 101  
102 -==== 3.2.4 Verify succesfull installation of the Docker Engine ====
52 +**Step 2: Install Docker **
103 103  
104 104  {{code language="cmd"}}
105 -sudo docker run hello-world
55 + curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
56 + echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
57 + sudo apt update
58 + sudo apt install docker-ce docker-ce-cli containerd.io
106 106  {{/code}}
107 107  
108 108  {{info}}
... ... @@ -109,60 +109,128 @@
109 109   Requires ~335 Mb space to install
110 110  {{/info}}
111 111  
112 -==== 3.2.5 Install eMagiz Deploy Agent ====
113 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 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:
67 +**Step 3: Install Java **
118 118  
119 119  {{code language="cmd"}}
120 -docker version
70 + wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
71 + echo "deb https://packages.adoptium.net/artifactory/deb $(awk -F= '/^VERSION_CODENAME/{print$2}' /etc/os-release) main" | sudo tee /etc/apt/sources.list.d/adoptium.list
72 + sudo apt update # update if you haven't already
73 + sudo apt install temurin-8-jdk
121 121  {{/code}}
122 122  
123 -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:
76 +{{info}}
77 + Requires ~335 Mb space to install
78 +{{/info}}
124 124  
80 +**Step 3: Ensure Docker is autostarted with WSL **
81 +
125 125  {{code language="cmd"}}
126 -.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
83 +nano .bashrc
84 +
85 + #Add following lines to bashrc
86 + DOCKER_DISTRO="Ubuntu"
87 + DOCKER_LOG_DIR=$HOME/docker_logs
88 + mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
89 + /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
127 127  {{/code}}
128 128  
129 -===3.4 Uninstall Docker===
130 -To uninstall Docker from your machine, execute the following commands in PowerShell with administrative rights:
92 +#Do not ask password dockerd
93 +sudo visudo
131 131  
132 -{{code language="cmd"}}
133 -Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Uninstall-docker/uninstall-docker.ps1" -o uninstall-docker-ce.ps1
134 -{{/code}}
95 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
135 135  
136 -Example usage:
97 +#Set WSL config for memory
98 +USERDIR/.wslconfig
99 + # Settings apply across all Linux distros running on WSL 2
100 + [wsl2]
137 137  
138 -{{code language="cmd"}}
139 -.\uninstall-docker-ce.ps1
140 -{{/code}}
141 -== 4. Key takeaways ==
102 + # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
103 + memory=16GB
142 142  
105 + # Sets the VM to use two virtual processors
106 + processors=2
107 +
108 +(Exit WSL: wsl --shutdown)
109 +
110 +
111 +===3.4 Installation requirements Windows Server 2019 version >1806===
112 +
113 +These are the requirements to allow the installation of the eMagiz Docker agent:
114 +* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
115 +* Validate if WSL 2.0 is properly installed
116 +* Go to the next section around installing the eMagiz Docker agent
117 +
118 +===3.5 Installation requirements Windows Server 2019 version 1806===
119 +
120 +These are the requirements to allow the installation of the eMagiz Docker agent:
121 +* Enable Hyper-V in Windows Server
122 + ** 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.
123 + ** Restart windows
124 +* Cross check is WSL 2.0 is installed
125 + ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
126 +* Install Docker Desktop on the Windows Server
127 + ** Please refer to this link: https://www.docker.com/products/docker-desktop/
128 + ** Restart windows
129 +* Update Docker Desktop configuration
130 + ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
131 + ** Restart Docker
132 +* Open Powershell as Administrator
133 + ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
134 + ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
135 + ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
136 + ** Execute Add-AppxPackage .\ubuntu-2004.appx
137 + *** 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.
138 +* Ubuntu should now be a runnable program (press windows key, type ubuntu)
139 +* Open the ubuntu terminal, and finish the installation.
140 + ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
141 +* Go to the next section around installing the eMagiz Docker agent
142 +
143 +===3.6 Installation requirements Windows Server 2012 R2 ===
144 +
145 +These are the requirements to allow the installation of the eMagiz Docker agent:
146 +* Install & enable Hyper-V in Windows Server
147 + ** 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.
148 + ** Restart windows
149 +* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
150 +* Create a VM in HyperV.
151 + ** 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).
152 + ** Configure a virtual switch.
153 + ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
154 + ** Install an operating system from bootable CD/DVD, ISO file
155 +* Install ubuntu downloaded previously on the VM
156 +* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
157 +* Go to the next section around installing the eMagiz agent
158 +
159 +=== 3.7 eMagiz Docker agent installation ===
160 +
161 +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 under Deploy Architecture. At the runtime connector, there is a right click option called Deploy Agent. That presents either the command or the location where that agent is installed.
162 +
163 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
164 +
165 +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.
166 +
167 +== 4. Assignment ==
168 +
169 +Check out the cheatcheet for Docker command line:
170 +
171 +[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
172 +
173 +== 5. Key takeaways ==
174 +
143 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 144  * eMagiz has a specific agent that manages the download of that image to the on-premises server
145 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 146  
147 -== 5. Suggested Additional Readings ==
148 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 166  
181 +== 6. Suggested Additional Readings ==
167 167  
183 +N/A
184 +
185 +== 7. Silent demonstration video ==
186 +
187 +N/A
188 +
168 168  )))((({{toc/}}))){{/container}}{{/container}}