Changes for page Install Docker for Linux

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

From 61.1 to 62.1

From version 62.1

edited by eMagiz
on 2023/02/07 12:26

Change comment: There is no comment for this version

To version 140.1

edited by Erik Bakker
on 2026/01/30 10:56

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 @@
--On-premise Install Guide
++Install Docker for Linux

Author

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

Content

@@ -1,5 +1,5 @@
  {{container}}{{container layoutStyle="columns"}}(((
--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.
++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.
  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
@@ -9,192 +9,197 @@
  * Good understanding of eMagiz runtimes in general
  == 2. Key concepts ==
--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.
++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 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.
++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:
--* Ensure access to the following URLs is enabled
--    ** registry.emagiz.com:8443
--    ** controlplane.emagiz.com:8000
--    ** Preferably the entry should be *.emagiz.com
--
--===3.2 Installation requirements Linux===
++{{info}}It is advised to use Docker version 29.1.3 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}}
--* 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.
--* Follow all steps in section 3.4
++{{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}}
--* Install the eMagiz Deploy agent
++{{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.3 Installation requirements Windows Server 2022 ===
++===3.2 Installation Linux===
--{{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
++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.
--The steps below will install a linux subsystem under Windows. In that Linux system, Docker and Java will be installed. Please note that the Windows server needs to be able to run Virtualized (either via BIOS setting or via Nested Virtualization).
++==== 3.2.1 Uninstall old versions ====
++{{info}}Before you can install Docker Engine, you need to uninstall any conflicting packages.
--**Step 1: Install linux distribution**
++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"}}
--  wsl --install -d Ubuntu
--  sudo apt-get update
--  sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
--  . /etc/os-release
++sudo apt remove $(dpkg --get-selections docker.io docker-compose docker-compose-v2 docker-doc podman-docker containerd runc | cut -f1)
  {{/code}}
--**Step 2: Configure linux system**
--Please see section 3.4 for these these steps
--
--**Step 3: Update wsl config file **
--In this step we need to add or update the WSL config file that manages the resources of the Linux subsystem. Important resources to manage are the assigned memory and number of processors. For memory we recommend to review the mempory settings for the runtime that need to run on this server and add 762 MB to the total value of the heap and non-heap of these runtimes. For processor we recommend to set the value to 2 - depending on the amount of processors available on that machine
++==== 3.2.1 Set up Docker's apt repository ====
--First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
--
  {{code language="cmd"}}
--  #Add following lines
--
--  # Settings apply across all Linux distros running on WSL 2
--  [wsl2]
--  # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
--  memory=16GB
--  # Sets the VM to use two virtual processors
--  processors=2
++# 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}}
--
--**Step 4: Auto start the linux subsystem when Windows server restarts **
--
++==== 3.2.2 Install Docker ====
--===3.4 Installation steps to configure Linux subsystem ===
--
--**Step 1: Install Docker **
++To install a specific version of Docker Engine, start by listing the available versions in the repository:
  {{code language="cmd"}}
--  curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
--  echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
--  sudo apt update
--  sudo apt install docker-ce docker-ce-cli containerd.io
++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}}
--{{info}}
-- Requires ~335 Mb space to install
--{{/info}}
++Select the desired version and install:
--**Step 2: Install Java **
--
  {{code language="cmd"}}
--  wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
--  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
--  sudo apt update # update if you haven't already
--  sudo apt install temurin-8-jdk
++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}}
--{{info}}
-- Requires ~335 Mb space to install
--{{/info}}
++==== 3.2.3 Customization ====
--**Step 3: Ensure Docker is autostarted with WSL **
++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.
--{{code language="cmd"}}
--nano .bashrc
++===== 3.2.3.1 IP address range =====
++
++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
--  #Add following lines to bashrc
--	DOCKER_DISTRO="Ubuntu"
--	DOCKER_LOG_DIR=$HOME/docker_logs
--	mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
--	/mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
++{{code language="cmd"}}
++sudo nano /etc/docker/daemon.json
++#Add following lines
++{"bip": "<ip-address>"}
  {{/code}}
--**Step 4: Add user to Docker group **
++{{warning}}Be aware that the customization will only take effect once you have restarted Docker.{{/warning}}
--{{code language="cmd"}}
--sudo visudo
++==== 3.2.4 Verify succesfull installation of the Docker Engine ====
--  #Add following lines
--
--  # Don't ask for password
--  %docker ALL=(ALL)  NOPASSWD: /usr/bin/dockerd
++{{code language="cmd"}}
++sudo docker run hello-world
  {{/code}}
--
++{{info}}
++ Requires ~335 Mb space to install
++{{/info}}
--===3.5 Installation requirements Windows Server 2019 version 1806===
++==== 3.2.5 Install eMagiz Deploy Agent ====
--{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
++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"]]
--These are the requirements to allow the installation of the eMagiz Docker agent:
--* 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
--* Cross check is WSL 2.0 is installed
--  ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
--* 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
--* Go to the next section around installing the eMagiz Docker agent
++=== 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:
--===3.6 Installation requirements Windows Server 2012 R2 ===
++{{code language="cmd"}}
++apt list --all-versions docker-ce
--{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
++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}}
--These are the requirements to allow the installation of the eMagiz Docker agent:
--* Install & 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
--* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
--* Create a VM in HyperV.
--  ** 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).
--  ** Configure a virtual switch.
--  ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
--  ** Install an operating system from bootable CD/DVD, ISO file
--* Install ubuntu downloaded previously on the VM
--* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
--* Go to the next section around installing the eMagiz agent
++Select the desired version and install.
--=== 3.7 eMagiz Docker agent installation ===
++{{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}}
--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.
++{{warning}}It may happen that, due to the update, your containers are no longer starting up. To resolve this, please restart the containers, which can be done via a deployment plan or the deploy architecture.{{/warning}}
--[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
++===3.4 Uninstall Docker===
++To uninstall Docker from your machine, execute the following command.
--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.
++{{code language="cmd"}}
++sudo apt purge docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin docker-ce-rootless-extras
++{{/code}}
--== 4. Assignment ==
++{{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.
++== 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}}