Changes for page Install Docker for Linux
Last modified by Erik Bakker on 2025/04/18 13:54
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 -On-premise sdeploymentnew runtimearchitecture1 +On-premise Install Guide - Content
-
... ... @@ -9,47 +9,135 @@ 9 9 * Good understanding of eMagiz runtimes in general 10 10 11 11 == 2. Key concepts == 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 envir ionments.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 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. 5for 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.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 - 18 -===3.1 Installation requirements Linux=== 19 19 20 -These are the requirements to allow the installation of the eMagiz Docker agent: 18 +===3.1 General requirements=== 19 + 20 +These are the general requirements to allow the installation of the eMagiz Docker agent: 21 21 * Ensure access to the following URLs is enabled 22 - ** registry.emagiz.com 23 - ** t esting.emagiz.com22 + ** registry.emagiz.com:8443 23 + ** controlplane.emagiz.com:8000 24 24 ** Preferably the entry should be *.emagiz.com 25 -* Install latest version of Docker 25 + 26 + 27 +===3.2 Installation requirements Linux=== 28 + 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}} 26 26 * Go to the next section around installing the eMagiz agent 27 27 28 -===3. 2Installation requirements Windows Server 2022===33 +===3.3 Installation requirements Windows Server 2022=== 29 29 30 30 These are the requirements to allow the installation of the eMagiz Docker agent: 31 -* Ensure access to the following URLs is enabled 32 - ** registry.emagiz.com 33 - ** testing.emagiz.com 34 - ** Preferably the entry should be *.emagiz.com 35 -* Install latest version of Docker 36 +* Install latest version of Docker Desktop from {{code}}https://www.docker.com/products/docker-desktop/{{/code}} 36 36 * Validate if WSL 2.0 is properly installed 37 -* Go to the next section around installing the eMagiz agent 38 +* Go to the next section around installing the eMagiz Docker agent 39 + 40 +===3.3 Installation requirements Windows Server 2022 (without Docker Desktop) === 38 38 39 - ===3.3InstallationrequirementsWindowsServer 2019 version1806===42 +**Step 1: Install linux distribution** 40 40 44 +{{code language="cmd"}} 45 + wsl --install -d Ubuntu 46 + sudo apt-get update 47 + sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2 48 + . /etc/os-release 49 +{{/code}} 50 + 51 + 52 +**Step 2: Install Docker ** 53 + 54 +{{code language="cmd"}} 55 + curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc 56 + echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list 57 + sudo apt update 58 + sudo apt install docker-ce docker-ce-cli containerd.io 59 +{{/code}} 60 + 61 +{{info}} 62 + Requires ~335 Mb space to install 63 +{{/info}} 64 + 65 +**Step 3: Install Java ** 66 + 67 +{{code language="cmd"}} 68 + wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add - 69 + 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 70 + sudo apt update # update if you haven't already 71 + sudo apt install temurin-8-jdk 72 +{{/code}} 73 + 74 +{{info}} 75 + Requires ~335 Mb space to install 76 +{{/info}} 77 + 78 +**Step 4: Ensure Docker is autostarted with WSL ** 79 + 80 +{{code language="cmd"}} 81 +nano .bashrc 82 + 83 + #Add following lines to bashrc 84 + DOCKER_DISTRO="Ubuntu" 85 + DOCKER_LOG_DIR=$HOME/docker_logs 86 + mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR" 87 + /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1" 88 +{{/code}} 89 + 90 +**Step 5: Add user to Docker group ** 91 + 92 +{{code language="cmd"}} 93 +sudo visudo 94 + 95 + #Add following lines 96 + 97 + # Don't ask for password 98 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd 99 +{{/code}} 100 + 101 +**Step 6: Update wsl config file ** 102 +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 103 + 104 +First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension) 105 + 106 + 107 +{{code language="cmd"}} 108 + #Add following lines 109 + 110 + # Settings apply across all Linux distros running on WSL 2 111 + [wsl2] 112 + # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB 113 + memory=16GB 114 + # Sets the VM to use two virtual processors 115 + processors=2 116 +{{/code}} 117 + 118 + 119 +**Step 7: Auto start the linux subsystem when server restarts ** 120 + 121 + 122 +===3.4 Installation requirements Windows Server 2019 version >1806=== 123 + 41 41 These are the requirements to allow the installation of the eMagiz Docker agent: 42 -* Ensure access to the following URLs is enabled 43 - ** registry.emagiz.com 44 - ** testing.emagiz.com 45 - ** Preferably the entry should be *.emagiz.com 125 +* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/ 126 +* Validate if WSL 2.0 is properly installed 127 +* Go to the next section around installing the eMagiz Docker agent 128 + 129 +===3.5 Installation requirements Windows Server 2019 version 1806=== 130 + 131 +These are the requirements to allow the installation of the eMagiz Docker agent: 46 46 * Enable Hyper-V in Windows Server 47 47 ** 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. 48 48 ** Restart windows 135 +* Cross check is WSL 2.0 is installed 136 + ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux 49 49 * Install Docker Desktop on the Windows Server 50 50 ** Please refer to this link: https://www.docker.com/products/docker-desktop/ 51 51 ** Restart windows 52 -* Update Docker desktop configuration140 +* Update Docker Desktop configuration 53 53 ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS 54 54 ** Restart Docker 55 55 * Open Powershell as Administrator ... ... @@ -61,15 +61,11 @@ 61 61 * Ubuntu should now be a runnable program (press windows key, type ubuntu) 62 62 * Open the ubuntu terminal, and finish the installation. 63 63 ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375 64 -* Go to the next section around installing the eMagiz agent 65 - 66 -===3. 4Installation requirements Windows Server 2012 R2 ===67 - 152 +* Go to the next section around installing the eMagiz Docker agent 153 + 154 +===3.6 Installation requirements Windows Server 2012 R2 === 155 + 68 68 These are the requirements to allow the installation of the eMagiz Docker agent: 69 -* Ensure access to the following URLs is enabled 70 - ** registry.emagiz.com 71 - ** testing.emagiz.com 72 - ** Preferably the entry should be *.emagiz.com 73 73 * Install & enable Hyper-V in Windows Server 74 74 ** 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. 75 75 ** Restart windows ... ... @@ -82,22 +82,19 @@ 82 82 * Install ubuntu downloaded previously on the VM 83 83 * Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM 84 84 * Go to the next section around installing the eMagiz agent 85 - 86 -=== 3.5 eMagiz agent installation agent === 87 - 88 -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. 89 89 90 -After installing the agent, validate it runs by checking if a docker container runs on ubuntu. 91 -* wget https://download.docker.com/linux/static/stable/x86_64/docker-20.10.5.tgz 92 -* tar zxvf docker-20.10.5.tgz 93 -* cd docker 94 -* ./docker psg 170 +=== 3.7 eMagiz Docker agent installation === 95 95 172 +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. 96 96 174 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]] 175 + 176 +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. 177 + 97 97 == 4. Assignment == 98 98 99 99 Check out the cheatcheet for Docker command line: 100 - 181 + 101 101 [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]] 102 102 103 103 == 5. Key takeaways == ... ... @@ -104,7 +104,7 @@ 104 104 105 105 * 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 106 106 * eMagiz has a specific agent that manages the download of that image to the on-premises server 107 -* 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. 188 +* 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. 108 108 109 109 110 110