Skip to Content

Changes for page Install Docker for Linux

Last modified by Erik Bakker on 2026/01/30 10:56
From version 127.1
edited by Erik Bakker
on 2024/11/29 08:20
Change comment: There is no comment for this version
To version 41.1
edited by eMagiz
on 2023/01/26 08:55
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,144 +9,155 @@
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 +
41 + {{code language="cmd"}}
42 + #Install docker
43 +sudo apt-get update
44 +sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
45 +. /etc/os-release
46 +curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
47 +echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
48 +sudo apt update
49 +sudo apt install docker-ce docker-ce-cli containerd.io
61 61  
62 -==== 3.2.1 Set up Docker's apt repository ====
51 +#Install Java
52 +wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
53 +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
54 +sudo apt update # update if you haven't already
55 +sudo apt install temurin-8-jdk
63 63  
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
57 +#Autostart Dockerd with wsl
71 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
78 -{{/code}}
59 +nano .bashrc
79 79  
80 -==== 3.2.2 Install Docker ====
61 + DOCKER_DISTRO="Ubuntu"
62 + DOCKER_LOG_DIR=$HOME/docker_logs
63 + mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
64 + /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
81 81  
82 -{{code language="cmd"}}
83 -sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
84 -{{/code}}
66 +#Do not ask password dockerd
67 +sudo visudo
85 85  
86 -
87 -{{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"]].
88 -{{/info}}
89 -
90 -
91 -==== 3.2.3 Customization ====
69 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
92 92  
93 -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.
71 +#Set WSL config for memory
72 +USERDIR/.wslconfig
73 + # Settings apply across all Linux distros running on WSL 2
74 + [wsl2]
94 94  
95 -===== 3.2.3.1 IP address range =====
96 -
97 -Below you can find the recommended values depending on the range which can be filled in the value <ip-address> below:
98 -* 10.0.0.1/8
99 -** advised value 10.25.0.1/16
100 -* 172.16.0.1/12
101 -** advised value 172.16.0.1/16
102 -* 192.168.0.1/16
103 -** advised value 192.168.0.1/16
76 + # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
77 + memory=16GB
104 104  
105 -{{code language="cmd"}}
106 -sudo nano /etc/docker/daemon.json
107 -#Add following lines
108 -{"bip": "<ip-address>"}
109 -{{/code}}
79 + # Sets the VM to use two virtual processors
80 + processors=2
110 110  
111 -==== 3.2.4 Verify succesfull installation of the Docker Engine ====
82 +(Exit WSL: wsl --shutdown)
83 + {{/code}}
112 112  
113 -{{code language="cmd"}}
114 -sudo docker run hello-world
115 -{{/code}}
85 +===3.4 Installation requirements Windows Server 2019 version >1806===
116 116  
117 -{{info}}
118 - Requires ~335 Mb space to install
119 -{{/info}}
87 +These are the requirements to allow the installation of the eMagiz Docker agent:
88 +* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
89 +* Validate if WSL 2.0 is properly installed
90 +* Go to the next section around installing the eMagiz Docker agent
120 120  
121 -==== 3.2.5 Install eMagiz Deploy Agent ====
92 +===3.5 Installation requirements Windows Server 2019 version 1806===
122 122  
123 -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"]]
94 +These are the requirements to allow the installation of the eMagiz Docker agent:
95 +* Enable Hyper-V in Windows Server
96 + ** 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.
97 + ** Restart windows
98 +* Cross check is WSL 2.0 is installed
99 + ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
100 +* Install Docker Desktop on the Windows Server
101 + ** Please refer to this link: https://www.docker.com/products/docker-desktop/
102 + ** Restart windows
103 +* Update Docker Desktop configuration
104 + ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
105 + ** Restart Docker
106 +* Open Powershell as Administrator
107 + ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
108 + ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
109 + ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
110 + ** Execute Add-AppxPackage .\ubuntu-2004.appx
111 + *** 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.
112 +* Ubuntu should now be a runnable program (press windows key, type ubuntu)
113 +* Open the ubuntu terminal, and finish the installation.
114 + ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
115 +* Go to the next section around installing the eMagiz Docker agent
124 124  
125 -== 4. Key takeaways ==
117 +===3.6 Installation requirements Windows Server 2012 R2 ===
126 126  
119 +These are the requirements to allow the installation of the eMagiz Docker agent:
120 +* Install & enable Hyper-V in Windows Server
121 + ** 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.
122 + ** Restart windows
123 +* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
124 +* Create a VM in HyperV.
125 + ** 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).
126 + ** Configure a virtual switch.
127 + ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
128 + ** Install an operating system from bootable CD/DVD, ISO file
129 +* Install ubuntu downloaded previously on the VM
130 +* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
131 +* Go to the next section around installing the eMagiz agent
132 +
133 +=== 3.7 eMagiz Docker agent installation ===
134 +
135 +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.
136 +
137 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
138 +
139 +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.
140 +
141 +== 4. Assignment ==
142 +
143 +Check out the cheatcheet for Docker command line:
144 +
145 +[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
146 +
147 +== 5. Key takeaways ==
148 +
127 127  * 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
128 128  * eMagiz has a specific agent that manages the download of that image to the on-premises server
129 129  * 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.
130 130  
131 -== 5. Suggested Additional Readings ==
132 132  
133 -* [[Docker official installation guide (External)>>https://docs.docker.com/engine/install/ubuntu/||target="blank"]]
134 -** [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
135 -*** [[eMagiz Runtime Generation 3 (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]]
136 -* [[Release Information (Menu)>>doc:Main.Release Information.WebHome||target="blank"]]
137 -** [[Environment Templates (Navigation)>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]]
138 -* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
139 -** [[eMagiz Runtime Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome||target="blank"]]
140 -*** [[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"]]
141 -*** [[eMagiz Deploy agent (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
142 -* [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]
143 -** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.WebHome||target="blank"]]
144 -*** [[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"]]
145 -* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
146 -** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome||target="blank"]]
147 -*** [[Install Docker for Windows (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-onpremises-server-windows-installguide.WebHome||target="blank"]]
148 -* [[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"]]
149 -* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
150 150  
155 +== 6. Suggested Additional Readings ==
151 151  
157 +N/A
158 +
159 +== 7. Silent demonstration video ==
160 +
161 +N/A
162 +
152 152  )))((({{toc/}}))){{/container}}{{/container}}