Changes for page Install Docker for Linux

Last modified by Erik Bakker on 2026/01/30 10:56

From 14.1 to 13.1 From 136.1 to 135.1

From version 135.1

edited by Erik Bakker
on 2026/01/23 13:00

Change comment: There is no comment for this version

To version 14.1

edited by eMagiz
on 2022/10/28 12:21

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

@@ -1,1 +1,1 @@
--Install Docker for Linux
++On-premises deployment new runtime architecture

Author

@@ -1,1 +1,1 @@
--XWiki.ebakker
++XWiki.eMagiz

Content

@@ -1,8 +1,11 @@
  {{container}}{{container layoutStyle="columns"}}(((
--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.
--
++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.
++
  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
++* Last update: June 24th 2021
++* Required reading time: 10 minutes
++
  == 1. Prerequisites ==
  * Advanced knowledge of the eMagiz platform
@@ -9,195 +9,61 @@
  * Good understanding of eMagiz runtimes in general
  == 2. Key concepts ==
--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.
++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
--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.
--
  == 3. On-premises deployments ==
--===3.1 General requirements===
--These are the general requirements to allow the installation of the eMagiz Docker agent:
++===3.1 Installation requirements Windows Server 2019 version 1806===
--{{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"]].
--{{/info}}
++Below the installation step for this version of Windows
--{{info}}
--* Standard configuration to ensure that communication between your server and eMagiz to ensure communication.
--    ** registry.emagiz.com:443
--    ** controlplane.emagiz.com:443
--    ** controlplane-agent.emagiz.com:443
--    ** controltower.emagiz.com:443
--    ** controltower.kpn-dsh.com:443
--    ** controlbus.emagiz.com:443
--    ** Preferably the entry should be *.emagiz.com
--    ** Preferably the entry should be *.kpn-dsh.com{{/info}}
--
--{{warning}}
--* When using **IP Whitelisting**, the following configuration is needed to communicate to your JMS.
--    ** 35.158.46.28:443
--    ** 3.74.190.88:443
--    ** 35.158.46.28:8443
--    ** 3.74.190.88:8443
--    ** 35.158.46.28:8444
--    ** 3.74.190.88:8444
--    ** 3.74.209.20:443
--    ** 3.76.127.155:443
--    ** 3.74.209.20:8443
--    ** 3.76.127.155:8443
--    ** 3.74.209.20:8444
--    ** 3.76.127.155:8444
--    ** 18.199.123.240
--    ** 18.184.211.189
--    ** 3.123.136.31{{/warning}}
--
--===3.2 Installation Linux===
--
--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.
--
--==== 3.2.1 Uninstall old versions ====
--{{info}}Before you can install Docker Engine, you need to uninstall any conflicting packages.
--
--Your Linux distribution may provide unofficial Docker packages, which may conflict with the official packages provided by Docker. You must uninstall these packages before you install the official version of Docker Engine.{{/info}}
--
--{{code language="cmd"}}
--sudo apt remove $(dpkg --get-selections docker.io docker-compose docker-compose-v2 docker-doc podman-docker containerd runc | cut -f1)
--{{/code}}
--
--==== 3.2.1 Set up Docker's apt repository ====
--
--{{code language="cmd"}}
--# Add Docker's official GPG key:
--sudo apt-get update
--sudo apt-get install ca-certificates curl
--sudo install -m 0755 -d /etc/apt/keyrings
--sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
--sudo chmod a+r /etc/apt/keyrings/docker.asc
--
--# Add the repository to Apt sources:
--echo \
--  "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
--  $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
--  sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
--sudo apt-get update
--{{/code}}
--
--==== 3.2.2 Install Docker ====
--
--To install a specific version of Docker Engine, start by listing the available versions in the repository:
--
--{{code language="cmd"}}
--apt list --all-versions docker-ce
--
--docker-ce/noble 5:29.1.5-1~ubuntu.24.04~noble <arch>
--docker-ce/noble 5:29.1.4-1~ubuntu.24.04~noble <arch>
--...
--{{/code}}
--
--Select the desired version and install:
--{{code language="cmd"}}
--VERSION_STRING=5:29.1.5-1~ubuntu.24.04~noble
--sudo apt install docker-ce=$VERSION_STRING docker-ce-cli=$VERSION_STRING containerd.io docker-buildx-plugin docker-compose-plugin
--{{/code}}
--
--==== 3.2.3 Customization ====
--
--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.
--
--===== 3.2.3.1 IP address range =====
++* Enable Hyper-V in Windows Server
++  ** 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.
++  ** Restart windows
++* Install Docker Desktop on the Windows Server
++  ** Please refer to this link: https://www.docker.com/products/docker-desktop/
++  ** Restart windows
++* Update Docker desktop configuration
++  ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
++  ** Restart Docker
++* Open Powershell as Administrator
++  ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
++  ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
++  ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
++  ** Execute Add-AppxPackage .\ubuntu-2004.appx
++    *** 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.
++* Ubuntu should now be a runnable program (press windows key, type ubuntu)
++* Open the ubuntu terminal, and finish the installation.
++  ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
--Below you can find the recommended values depending on the range which can be filled in the value <ip-address> below:
--* 10.0.0.1/8
--** advised value 10.25.0.1/16
--* 172.16.0.1/12
--** advised value 172.16.0.1/16
--* 192.168.0.1/16
--** advised value 192.168.0.1/16
++=== 3.2 Installation agent ===
++
++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.
++
++=== 3.3 Cloud architecture for API Gateway ===
++
++[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-install-runtime-images.png]]
--{{code language="cmd"}}
--sudo nano /etc/docker/daemon.json
--#Add following lines
--{"bip": "<ip-address>"}
--{{/code}}
++== 4. Assignment ==
--{{warning}}Be aware that the customization will only take effect once you have restarted Docker.{{/warning}}
--
--==== 3.2.4 Verify succesfull installation of the Docker Engine ====
--
--{{code language="cmd"}}
--sudo docker run hello-world
--{{/code}}
--
--{{info}}
-- Requires ~335 Mb space to install
--{{/info}}
--
--==== 3.2.5 Install eMagiz Deploy Agent ====
--
--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"]]
--
--=== 3.3 Update Docker ===
--When you are advised to update your Docker version, you can follow the following procedure to update to a specific version of Docker Engine, start by listing the available versions in the repository:
--
--{{code language="cmd"}}
--apt list --all-versions docker-ce
--
--docker-ce/noble 5:29.1.5-1~ubuntu.24.04~noble <arch>
--docker-ce/noble 5:29.1.4-1~ubuntu.24.04~noble <arch>
--...
--{{/code}}
--
--Select the desired version and install.
--
--{{code language="cmd"}}
--VERSION_STRING=5:29.1.5-1~ubuntu.24.04~noble
--sudo apt install docker-ce=$VERSION_STRING docker-ce-cli=$VERSION_STRING containerd.io docker-buildx-plugin docker-compose-plugin
--{{/code}}
--
--===3.4 Uninstall Docker===
--To uninstall Docker from your machine, execute the following command.
--
--{{code language="cmd"}}
--sudo apt purge docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin docker-ce-rootless-extras
--{{/code}}
--
--{{warning}}Images, containers, volumes, or custom configuration files on your host aren't automatically removed. To delete all images, containers, and volumes:
++Check out the cheatcheet for Docker command line:
--{{code language="cmd"}}
--sudo rm -rf /var/lib/docker
--sudo rm -rf /var/lib/containerd
--Remove source list and keyrings
--{{/code}}
++[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
--{{code language="cmd"}}
-- sudo rm /etc/apt/sources.list.d/docker.sources
-- sudo rm /etc/apt/keyrings/docker.asc
--{{/code}}
--{{/warning}}
--== 4. Key takeaways ==
++== 5. Key takeaways ==
  * 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
  * eMagiz has a specific agent that manages the download of that image to the on-premises server
--* 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.
++* 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.
--== 5. Suggested Additional Readings ==
--* [[Docker official installation guide (External)>>https://docs.docker.com/engine/install/ubuntu/||target="blank"]]
--** [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
--*** [[eMagiz Runtime Generation 3 (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]]
--* [[Release Information (Menu)>>doc:Main.Release Information.WebHome||target="blank"]]
--** [[Environment Templates (Navigation)>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]]
--* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
--** [[eMagiz Runtime Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome||target="blank"]]
--*** [[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"]]
--*** [[eMagiz Deploy agent (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
--* [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]
--** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.WebHome||target="blank"]]
--*** [[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"]]
--* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
--** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome||target="blank"]]
--*** [[Install Docker for Windows (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-onpremises-server-windows-installguide.WebHome||target="blank"]]
--* [[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"]]
--* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
++== 6. Suggested Additional Readings ==
++N/A
++
++== 7. Silent demonstration video ==
++
++N/A
++
  )))((({{toc/}}))){{/container}}{{/container}}