Skip to Content

Changes for page Install Docker for Linux

Last modified by Erik Bakker on 2025/10/19 21:13
From version 126.1
edited by Erik Bakker
on 2024/11/29 08:20
Change comment: There is no comment for this version
To version 50.1
edited by eMagiz
on 2023/02/06 08:44
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,143 +9,179 @@
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}}
22 -* Standard configuration to ensure that communication between your server and eMagiz to ensure communication.
23 - ** registry.emagiz.com:443
21 +* Ensure access to the following URLs is enabled
22 + ** registry.emagiz.com:8443
24 24   ** controlplane.emagiz.com:8000
25 - ** controltower.kpn-dsh.com:443
26 26   ** Preferably the entry should be *.emagiz.com
27 - ** Preferably the entry should be *.kpn-dsh.com{{/info}}
28 28  
29 -{{warning}}
30 -* In case of a very strict firewall configuration, additional configuration is needed to communicate to the eMagiz infrastructure.
31 - ** controltower.emagiz.com:443
32 - ** controltower.kpn-dsh.com:443
33 - ** controlbus.emagiz.com:443
34 - ** controlplane.emagiz.com:443
26 +
27 +===3.2 Installation requirements Linux===
35 35  
36 -* When using cloudslot number **equal to or below** 125, 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 - ** 18.199.123.240
44 - ** 18.184.211.189
45 - ** 3.123.136.31
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
46 46  
33 +===3.3 Installation requirements Windows Server 2022===
47 47  
48 -* When using a cloudslot number **above** 125, the following configuration is needed to communicate to your JMS.
49 - ** 3.74.209.20:443
50 - ** 3.76.127.155:443
51 - ** 3.74.209.20:8443
52 - ** 3.76.127.155:8443
53 - ** 3.74.209.20:8444
54 - ** 3.76.127.155:8444
55 - ** 18.199.123.240
56 - ** 18.184.211.189
57 - ** 3.123.136.31{{/warning}}
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
58 58  
59 -===3.2 Installation Linux===
60 -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.
40 +===3.3 Installation requirements Windows Server 2022 (without Docker Desktop) ===
41 +
42 +**Step 1: Install linux distribution**
61 61  
62 -==== 3.2.1 Set up Docker's apt repository ====
63 -
64 64  {{code language="cmd"}}
65 -# Add Docker's official GPG key:
66 -sudo apt-get update
67 -sudo apt-get install ca-certificates curl
68 -sudo install -m 0755 -d /etc/apt/keyrings
69 -sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
70 -sudo chmod a+r /etc/apt/keyrings/docker.asc
71 -
72 -# Add the repository to Apt sources:
73 -echo \
74 - "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
75 - $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
76 - sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
77 -sudo apt-get update
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
78 78  {{/code}}
79 79  
80 -==== 3.2.2 Install Docker ====
81 81  
52 +**Step 2: Install Docker **
53 +
82 82  {{code language="cmd"}}
83 -sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
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
84 84  {{/code}}
85 85  
86 -{{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"]].
61 +{{info}}
62 + Requires ~335 Mb space to install
87 87  {{/info}}
88 -
89 -
90 -==== 3.2.3 Customization ====
91 91  
92 -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.
65 +**Step 3: Install Java **
93 93  
94 -===== 3.2.3.1 IP address range =====
95 -
96 -Below you can find the recommended values depending on the range which can be filled in the value <ip-address> below:
97 -* 10.0.0.1/8
98 -** advised value 10.25.0.1/16
99 -* 172.16.0.1/12
100 -** advised value 172.16.0.1/16
101 -* 192.168.0.1/16
102 -** advised value 192.168.0.1/16
103 -
104 104  {{code language="cmd"}}
105 -sudo nano /etc/docker/daemon.json
106 -#Add following lines
107 -{"bip": "<ip-address>"}
68 + wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
69 + 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
70 + sudo apt update # update if you haven't already
71 + sudo apt install temurin-8-jdk
108 108  {{/code}}
109 109  
110 -==== 3.2.4 Verify succesfull installation of the Docker Engine ====
74 +{{info}}
75 + Requires ~335 Mb space to install
76 +{{/info}}
111 111  
78 +**Step 3: Ensure Docker is autostarted with WSL **
79 +
112 112  {{code language="cmd"}}
113 -sudo docker run hello-world
81 +nano .bashrc
82 +
83 + #Add following lines to bashrc
84 + DOCKER_DISTRO="Ubuntu"
85 + DOCKER_LOG_DIR=$HOME/docker_logs
86 + mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
87 + /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
114 114  {{/code}}
115 115  
116 -{{info}}
117 - Requires ~335 Mb space to install
118 -{{/info}}
90 +#Do not ask password dockerd
91 +sudo visudo
119 119  
120 -==== 3.2.5 Install eMagiz Deploy Agent ====
93 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
121 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"]]
95 +#Set WSL config for memory
96 +USERDIR/.wslconfig
97 + # Settings apply across all Linux distros running on WSL 2
98 + [wsl2]
123 123  
124 -== 4. Key takeaways ==
100 + # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
101 + memory=16GB
125 125  
103 + # Sets the VM to use two virtual processors
104 + processors=2
105 +
106 +(Exit WSL: wsl --shutdown)
107 +
108 +
109 +===3.4 Installation requirements Windows Server 2019 version >1806===
110 +
111 +These are the requirements to allow the installation of the eMagiz Docker agent:
112 +* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
113 +* Validate if WSL 2.0 is properly installed
114 +* Go to the next section around installing the eMagiz Docker agent
115 +
116 +===3.5 Installation requirements Windows Server 2019 version 1806===
117 +
118 +These are the requirements to allow the installation of the eMagiz Docker agent:
119 +* Enable Hyper-V in Windows Server
120 + ** 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.
121 + ** Restart windows
122 +* Cross check is WSL 2.0 is installed
123 + ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
124 +* Install Docker Desktop on the Windows Server
125 + ** Please refer to this link: https://www.docker.com/products/docker-desktop/
126 + ** Restart windows
127 +* Update Docker Desktop configuration
128 + ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
129 + ** Restart Docker
130 +* Open Powershell as Administrator
131 + ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
132 + ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
133 + ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
134 + ** Execute Add-AppxPackage .\ubuntu-2004.appx
135 + *** 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.
136 +* Ubuntu should now be a runnable program (press windows key, type ubuntu)
137 +* Open the ubuntu terminal, and finish the installation.
138 + ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
139 +* Go to the next section around installing the eMagiz Docker agent
140 +
141 +===3.6 Installation requirements Windows Server 2012 R2 ===
142 +
143 +These are the requirements to allow the installation of the eMagiz Docker agent:
144 +* Install & enable Hyper-V in Windows Server
145 + ** 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.
146 + ** Restart windows
147 +* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
148 +* Create a VM in HyperV.
149 + ** 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).
150 + ** Configure a virtual switch.
151 + ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
152 + ** Install an operating system from bootable CD/DVD, ISO file
153 +* Install ubuntu downloaded previously on the VM
154 +* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
155 +* Go to the next section around installing the eMagiz agent
156 +
157 +=== 3.7 eMagiz Docker agent installation ===
158 +
159 +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.
160 +
161 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
162 +
163 +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.
164 +
165 +== 4. Assignment ==
166 +
167 +Check out the cheatcheet for Docker command line:
168 +
169 +[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
170 +
171 +== 5. Key takeaways ==
172 +
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 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.
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  
179 +== 6. Suggested Additional Readings ==
150 150  
181 +N/A
182 +
183 +== 7. Silent demonstration video ==
184 +
185 +N/A
186 +
151 151  )))((({{toc/}}))){{/container}}{{/container}}