Changes for page Install Docker for Linux

Last modified by Erik Bakker on 2025/04/18 13:54

From version 100.1
edited by Erik Bakker
on 2024/02/27 08:59
Change comment: There is no comment for this version
To version 40.1
edited by Erik Bakker
on 2023/01/23 12:26
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Install Docker for Linux
1 +On-premise Install Guide
Content
... ... @@ -1,5 +1,5 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -In this microlearning, we will focus on how an on-premises server can be prepared for a eMagiz Deploy agent installation.
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,94 +11,150 @@
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 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.
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 25   ** Preferably the entry should be *.emagiz.com
26 - {{/info}}
27 27  
28 -{{warning}}
29 -* Custom configuration, in case all communication is disabled by default, between your server and eMagiz to ensure communication.
30 -* Ensure access to the following URLs is enabled
31 - ** registry.emagiz.com:443
32 - ** 3.126.123.28
33 - ** 18.194.225.123
34 - ** 54.93.164.84
35 - ** controlplane.emagiz.com:8000
36 - ** controlplane.emagiz.com:443
37 - ** 3.122.22.89:443
38 - ** 3.122.22.89:8000
39 - ** controltower.emagiz.com:443
40 - ** controlbus.emagiz.com:443
41 - ** 35.158.46.28:443
42 - ** 3.74.190.88:443
43 - ** 35.158.46.28:8443
44 - ** 3.74.190.88:8443
45 - ** 35.158.46.28:8444
46 - ** 3.74.190.88:8444
47 - ** 52.28.59.137
48 - ** 3.71.221.73
49 - ** 52.58.23.77
50 -{{/warning}}
26 +
27 +===3.2 Installation requirements Linux===
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.
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}}
31 +* Go to the next section around installing the eMagiz agent
54 54  
55 -==== 3.2.1 Set up Docker's apt repository ====
33 +===3.3 Installation requirements Windows Server 2022===
56 56  
57 -{{code language="cmd"}}
58 -# Add Docker's official GPG key:
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
35 +These are the requirements to allow the installation of the eMagiz Docker agent:
36 +* Install latest version of Docker Desktop from {{code}}https://www.docker.com/products/docker-desktop/{{/code}}
37 +* Validate if WSL 2.0 is properly installed
38 +* Go to the next section around installing the eMagiz Docker agent
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
40 + #Install docker
70 70  sudo apt-get update
71 -{{/code}}
42 +sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
43 +. /etc/os-release
44 +curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
45 +echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
46 +sudo apt update
47 +sudo apt install docker-ce docker-ce-cli containerd.io
72 72  
73 -==== 3.2.2 Install Docker ====
49 +#Install Java
50 +wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
51 +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
52 +sudo apt update # update if you haven't already
53 +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}}
55 +#Autostart Dockerd with wsl
78 78  
79 -==== 3.2.3 Verify succesfull installation of the Docker Engine ====
57 +nano .bashrc
80 80  
81 -{{code language="cmd"}}
82 -sudo docker run hello-world
83 -{{/code}}
59 + DOCKER_DISTRO="Ubuntu"
60 + DOCKER_LOG_DIR=$HOME/docker_logs
61 + mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
62 + /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
84 84  
85 -{{info}}
86 - Requires ~335 Mb space to install
87 -{{/info}}
64 +#Do not ask password dockerd
65 +sudo visudo
88 88  
89 -==== 3.2.4 Install eMagiz Deploy Agent ====
67 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
90 90  
91 -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"]]
69 +#Set WSL config for memory
70 +USERDIR/.wslconfig
71 + # Settings apply across all Linux distros running on WSL 2
72 + [wsl2]
92 92  
93 -== 4. Key takeaways ==
74 + # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
75 + memory=16GB
94 94  
77 + # Sets the VM to use two virtual processors
78 + processors=2
79 +
80 +(Exit WSL: wsl --shutdown)
81 +
82 +===3.4 Installation requirements Windows Server 2019 version >1806===
83 +
84 +These are the requirements to allow the installation of the eMagiz Docker agent:
85 +* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
86 +* Validate if WSL 2.0 is properly installed
87 +* Go to the next section around installing the eMagiz Docker agent
88 +
89 +===3.5 Installation requirements Windows Server 2019 version 1806===
90 +
91 +These are the requirements to allow the installation of the eMagiz Docker agent:
92 +* Enable Hyper-V in Windows Server
93 + ** 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.
94 + ** Restart windows
95 +* Cross check is WSL 2.0 is installed
96 + ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
97 +* Install Docker Desktop on the Windows Server
98 + ** Please refer to this link: https://www.docker.com/products/docker-desktop/
99 + ** Restart windows
100 +* Update Docker Desktop configuration
101 + ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
102 + ** Restart Docker
103 +* Open Powershell as Administrator
104 + ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
105 + ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
106 + ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
107 + ** Execute Add-AppxPackage .\ubuntu-2004.appx
108 + *** 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.
109 +* Ubuntu should now be a runnable program (press windows key, type ubuntu)
110 +* Open the ubuntu terminal, and finish the installation.
111 + ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
112 +* Go to the next section around installing the eMagiz Docker agent
113 +
114 +===3.6 Installation requirements Windows Server 2012 R2 ===
115 +
116 +These are the requirements to allow the installation of the eMagiz Docker agent:
117 +* Install & enable Hyper-V in Windows Server
118 + ** 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.
119 + ** Restart windows
120 +* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
121 +* Create a VM in HyperV.
122 + ** 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).
123 + ** Configure a virtual switch.
124 + ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
125 + ** Install an operating system from bootable CD/DVD, ISO file
126 +* Install ubuntu downloaded previously on the VM
127 +* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
128 +* Go to the next section around installing the eMagiz agent
129 +
130 +=== 3.7 eMagiz Docker agent installation ===
131 +
132 +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.
133 +
134 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
135 +
136 +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.
137 +
138 +== 4. Assignment ==
139 +
140 +Check out the cheatcheet for Docker command line:
141 +
142 +[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
143 +
144 +== 5. Key takeaways ==
145 +
95 95  * 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
96 96  * eMagiz has a specific agent that manages the download of that image to the on-premises server
97 97  * 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.
98 98  
99 -== 5. Suggested Additional Readings ==
100 100  
101 -* [[Docker official installation guide>>https://docs.docker.com/engine/install/ubuntu/||target="blank"]]
102 -* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
103 103  
152 +== 6. Suggested Additional Readings ==
153 +
154 +N/A
155 +
156 +== 7. Silent demonstration video ==
157 +
158 +N/A
159 +
104 104  )))((({{toc/}}))){{/container}}{{/container}}