Changes for page Install Docker for Linux
Last modified by Erik Bakker on 2025/10/19 21:13
Summary
-
Page properties (3 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 - Install DockerforLinux1 +expert-solution-architecture-onpremises-installguide - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. CarlijnKokkeler1 +XWiki.eMagiz - Content
-
... ... @@ -1,5 +1,5 @@ 1 1 {{container}}{{container layoutStyle="columns"}}((( 2 -In this microlearning, we will focus on how an on-premises ser vercanbe preparedfor a eMagizDeployagentinstallation.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 ... ... @@ -11,114 +11,151 @@ 11 11 == 2. Key concepts == 12 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 Linuxvariantis described intermsofhowtopreparethe servertoallowthe[[eMagizDeployAgent>>doc:Main.eMagizAcademy.Microlearnings.IntermediateLevel.eMagizRuntime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]tobeinstalled. That agentallowstodownload imagesfromthe eMagizinfrastructure.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 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 https://docs.docker.com/engine/install/ubuntu/ 31 +* Go to the next section around installing the eMagiz agent 43 43 44 -* When using a cloudslot number **above** 125, the following configuration is needed to communicate to your JMS. 45 - ** 3.74.209.20:443 46 - ** 3.76.127.155:443 47 - ** 3.74.209.20:8443 48 - ** 3.76.127.155:8443 49 - ** 3.74.209.20:8444 50 - ** 3.76.127.155:8444{{/warning}} 33 +===3.3 Installation requirements Windows Server 2022=== 51 51 52 -===3.2 Installation Linux=== 53 -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. 54 - 55 -==== 3.2.1 Set up Docker's apt repository ==== 56 - 57 -{{code language="cmd"}} 58 -# Add Docker's official GPG key: 35 +These are the requirements to allow the installation of the eMagiz Docker agent: 36 +* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/ 37 +* Validate if WSL 2.0 is properly installed 38 +* Go to the next section around installing the eMagiz Docker agent 39 + 40 + 41 + 42 + #Install docker 59 59 sudo apt-get update 60 -sudo apt-get install ca-certificates curl 61 -sudo install -m 0755 -d /etc/apt/keyrings 62 -sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc 63 -sudo chmod a+r /etc/apt/keyrings/docker.asc 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 64 64 65 -# Add the repository to Apt sources: 66 -echo \ 67 - "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \ 68 - $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \ 69 - sudo tee /etc/apt/sources.list.d/docker.list > /dev/null 70 -sudo apt-get update 71 -{{/code}} 50 +sudo apt install docker-ce docker-ce-cli containerd.io 72 72 73 -==== 3.2.2 Install Docker ==== 52 +#Install Java 53 +wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add - 54 +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 55 +sudo apt update # update if you haven't already 56 +sudo apt install temurin-8-jdk 74 74 75 -{{code language="cmd"}} 76 -sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin 77 -{{/code}} 58 +#Autostart Dockerd with wsl 59 +nano .bashrc 78 78 79 -To install or update docker on your machine, execute the following commands in powershell with administrative rights: 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" 80 80 81 -{{code language="cmd"}} 82 -Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/microsoft/Windows-Containers/Main/helpful_tools/Install-DockerCE/install-docker-ce.ps1" -o install-docker-ce.ps1 83 -.\install-docker-ce.ps1 84 -{{/code}} 66 +#Do not ask password dockerd 67 +sudo visudo 85 85 86 - Example usage:69 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd 87 87 88 -{{code language="cmd"}} 89 -.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION 90 -{{/code}} 71 +#Set WSL config for memory 72 +USERDIR/.wslconfig 73 + # Settings apply across all Linux distros running on WSL 2 74 + [wsl2] 91 91 92 -To install the latest version of docker, you can use {{code language="cmd"}}e .\install-update-docker-ce.ps1{{/code}} without specifying the version flag. 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 93 93 94 -{{info}}lIt 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. 95 -{{/info}} 79 + # Sets the VM to use two virtual processors 80 + processors=2 81 + 82 + 83 +(Exit WSL: wsl --shutdown) 96 96 97 - {{warning}}Note:This processis serviceaffecting, your running containerswill be stopped andwillneedtobestarted again.{{/warning}}85 +===3.4 Installation requirements Windows Server 2019 version >1806=== 98 98 99 -==== 3.2.3 Verify succesfull installation of the Docker Engine ==== 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 91 + 92 +===3.5 Installation requirements Windows Server 2019 version 1806=== 100 100 101 -{{code language="cmd"}} 102 -sudo docker run hello-world 103 -{{/code}} 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 116 + 117 +===3.6 Installation requirements Windows Server 2012 R2 === 118 + 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 when the machine is used for the first time deployment of eMagiz runtimes. A popup will appear that displays the commands per type of OS. Once that agent is installed, the image that is generated for every eMagiz release can be downloaded and installed in the Docker instance. 104 104 105 -{{info}} 106 - Requires ~335 Mb space to install 107 -{{/info}} 137 +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. 108 108 109 -== ==3.2.4Install eMagiz Deploy Agent ====139 +== 4. Assignment == 110 110 111 -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"]] 141 +Check out the cheatcheet for Docker command line: 142 + 143 +[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]] 112 112 113 -== 4. Key takeaways ==145 +== 5. Key takeaways == 114 114 115 115 * 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 116 116 * eMagiz has a specific agent that manages the download of that image to the on-premises server 117 -* 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. 149 +* 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. 118 118 119 -== 5. Suggested Additional Readings == 120 120 121 -* [[Docker official installation guide>>https://docs.docker.com/engine/install/ubuntu/||target="blank"]] 122 -* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]] 123 123 153 +== 6. Suggested Additional Readings == 154 + 155 +N/A 156 + 157 +== 7. Silent demonstration video == 158 + 159 +N/A 160 + 124 124 )))((({{toc/}}))){{/container}}{{/container}}