Changes for page Install Docker for Linux
Last modified by Erik Bakker on 2026/01/30 10:56
From version 129.1
edited by Erik Bakker
on 2024/11/29 08:23
on 2024/11/29 08:23
Change comment:
There is no comment for this version
To version 20.1
edited by eMagiz
on 2022/11/11 09:28
on 2022/11/11 09:28
Change comment:
There is no comment for this version
Summary
-
Page properties (3 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 - InstallDockerforLinux1 +On-premises deployment new runtime architecture - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki.e bakker1 +XWiki.eMagiz - Content
-
... ... @@ -1,5 +1,5 @@ 1 1 {{container}}{{container layoutStyle="columns"}}((( 2 -In eMagiz's currentruntimearchitecture,Dockertechnologyplays a centralrolein deployingruntimes. eMagiz creates specific runtime imagestailoredfordockerized environments,streamliningdeployment. Thissectionfocuseson preparinga Linuxserverfortheinstallationof the eMagizDeploy Agent, whichfacilitatesdownloading these runtimeimages from the eMagizinfrastructure.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,145 +9,98 @@ 9 9 * Good understanding of eMagiz runtimes in general 10 10 11 11 == 2. Key concepts == 12 -In the currentruntime 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 envirionments 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. 15 - 16 16 == 3. On-premises deployments == 15 + 16 +===3.1 Installation requirements Linux=== 17 17 18 -===3.1 General requirements=== 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 24 - ** controlplane.emagiz.com:8000 25 - ** controltower.kpn-dsh.com:443 18 +These are the requirements to allow the installation of the eMagiz Docker agent: 19 +* Ensure access to the following URLs is enabled 20 + ** registry.emagiz.com 21 + ** testing.emagiz.com 26 26 ** Preferably the entry should be *.emagiz.com 27 - **Preferablythe entryshould be *.kpn-dsh.com{{/info}}23 +* Install latest version of Docker 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 25 +===3.2 Installation requirements Windows Server 2022=== 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 46 - 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}} 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. 61 - 62 -==== 3.2.1 Set up Docker's apt repository ==== 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 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}} 79 - 80 -==== 3.2.2 Install Docker ==== 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}} 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 -==== 3.2.3 Customization ==== 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. 93 - 94 -===== 3.2.3.1 IP address range ===== 27 +These are the requirements to allow the installation of the eMagiz Docker agent: 28 +* Ensure access to the following URLs is enabled 29 + ** registry.emagiz.com 30 + ** testing.emagiz.com 31 + ** Preferably the entry should be *.emagiz.com 32 +* Install latest version of Docker 33 +* Validate if WSL 2.0 is properly installed 95 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 35 +===3.3 Installation requirements Windows Server 2019 version 1806=== 103 103 104 -{{code language="cmd"}} 105 -sudo nano /etc/docker/daemon.json 106 -#Add following lines 107 -{"bip": "<ip-address>"} 108 -{{/code}} 37 +These are the requirements to allow the installation of the eMagiz Docker agent: 38 +* Ensure access to the following URLs is enabled 39 + ** registry.emagiz.com 40 + ** testing.emagiz.com 41 + ** Preferably the entry should be *.emagiz.com 42 +* Enable Hyper-V in Windows Server 43 + ** 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. 44 + ** Restart windows 45 +* Install Docker Desktop on the Windows Server 46 + ** Please refer to this link: https://www.docker.com/products/docker-desktop/ 47 + ** Restart windows 48 +* Update Docker desktop configuration 49 + ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS 50 + ** Restart Docker 51 +* Open Powershell as Administrator 52 + ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine 53 + ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux 54 + ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004 55 + ** Execute Add-AppxPackage .\ubuntu-2004.appx 56 + *** 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. 57 +* Ubuntu should now be a runnable program (press windows key, type ubuntu) 58 +* Open the ubuntu terminal, and finish the installation. 59 + ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375 109 109 110 -{{warning}}Be aware that the customization will only take effect once you have restarted Docker.{{/warning}} 61 +===3.4 Installation requirements Windows Server 2012 R2 === 62 + 63 +These are the requirements to allow the installation of the eMagiz Docker agent: 64 +* Ensure access to the following URLs is enabled 65 + ** registry.emagiz.com 66 + ** testing.emagiz.com 67 + ** Preferably the entry should be *.emagiz.com 68 +* Install & enable Hyper-V in Windows Server 69 + ** 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. 70 + ** Restart windows 71 +* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso ) 72 +* Create a VM in HyperV. 73 + ** 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). 74 + ** Configure a virtual switch. 75 + ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB) 76 + ** Install an operating system from bootable CD/DVD, ISO file 77 +* Install ubuntu downloaded previously on the VM 78 +* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM 79 + 80 +=== 3.5 Installation agent === 81 + 82 +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. 111 111 112 -== ==3.2.4VerifysuccesfullinstallationoftheDocker Engine====84 +== 4. Assignment == 113 113 114 - {{codelanguage="cmd"}}115 - sudodockerrun hello-world116 - {{/code}}86 +Check out the cheatcheet for Docker command line: 87 + 88 +[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]] 117 117 118 -{{info}} 119 - Requires ~335 Mb space to install 120 -{{/info}} 90 +== 5. Key takeaways == 121 121 122 -==== 3.2.5 Install eMagiz Deploy Agent ==== 123 - 124 -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"]] 125 - 126 -== 4. Key takeaways == 127 - 128 128 * 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 129 129 * eMagiz has a specific agent that manages the download of that image to the on-premises server 130 -* 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. 94 +* 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. 131 131 132 -== 5. Suggested Additional Readings == 133 133 134 -* [[Docker official installation guide (External)>>https://docs.docker.com/engine/install/ubuntu/||target="blank"]] 135 -** [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]] 136 -*** [[eMagiz Runtime Generation 3 (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]] 137 -* [[Release Information (Menu)>>doc:Main.Release Information.WebHome||target="blank"]] 138 -** [[Environment Templates (Navigation)>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]] 139 -* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]] 140 -** [[eMagiz Runtime Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome||target="blank"]] 141 -*** [[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"]] 142 -*** [[eMagiz Deploy agent (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]] 143 -* [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]] 144 -** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.WebHome||target="blank"]] 145 -*** [[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"]] 146 -* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]] 147 -** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome||target="blank"]] 148 -*** [[Install Docker for Windows (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-onpremises-server-windows-installguide.WebHome||target="blank"]] 149 -* [[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"]] 150 -* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]] 151 151 98 +== 6. Suggested Additional Readings == 152 152 100 +N/A 101 + 102 +== 7. Silent demonstration video == 103 + 104 +N/A 105 + 153 153 )))((({{toc/}}))){{/container}}{{/container}}