Skip to Content

Changes for page Install Docker for Linux

Last modified by Erik Bakker on 2025/04/18 13:54
From version 20.1
edited by eMagiz
on 2022/11/11 09:28
Change comment: There is no comment for this version
To version 61.1
edited by eMagiz
on 2023/02/07 12:15
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -On-premises deployment new runtime architecture
1 +On-premise Install Guide
Content
... ... @@ -9,43 +9,143 @@
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 envirionments
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 -== 3. On-premises deployments ==
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 -===3.1 Installation requirements Linux===
16 +== 3. On-premises deployments ==
17 17  
18 -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:
19 19  * Ensure access to the following URLs is enabled
20 - ** registry.emagiz.com
21 - ** testing.emagiz.com
22 + ** registry.emagiz.com:8443
23 + ** controlplane.emagiz.com:8000
22 22   ** Preferably the entry should be *.emagiz.com
23 -* Install latest version of Docker
24 24  
25 -===3.2 Installation requirements Windows Server 2022===
26 +
27 +===3.2 Installation requirements Linux===
26 26  
29 +* 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.
30 +* Install latest version of the Docker engine - see for instance this link below. For other Linux distributions similar install guides are available on this link.
31 +
32 +{{code}}https://docs.docker.com/engine/install/ubuntu/{{/code}}
33 +
34 +
35 +* Install the eMagiz Deploy agent
36 +
37 +===3.3 Installation requirements Windows Server 2022 (Docker Desktop)===
38 +
39 +{{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
40 +
27 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
42 +* Install latest version of Docker Desktop from
43 +
44 +{{code}}https://www.docker.com/products/docker-desktop/{{/code}}
45 +
33 33  * Validate if WSL 2.0 is properly installed
47 +* Install the eMagiz Deploy agent
48 +
49 +===3.3 Installation requirements Windows Server 2022 (without Docker Desktop) ===
50 +
51 +{{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
52 +
53 +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).
54 +
55 +**Step 1: Install linux distribution**
56 +
57 +{{code language="cmd"}}
58 + wsl --install -d Ubuntu
59 + sudo apt-get update
60 + sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
61 + . /etc/os-release
62 +{{/code}}
63 +
64 +
65 +**Step 2: Install Docker **
66 +
67 +{{code language="cmd"}}
68 + curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
69 + echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
70 + sudo apt update
71 + sudo apt install docker-ce docker-ce-cli containerd.io
72 +{{/code}}
73 +
74 +{{info}}
75 + Requires ~335 Mb space to install
76 +{{/info}}
77 +
78 +**Step 3: Install Java **
79 +
80 +{{code language="cmd"}}
81 + wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
82 + 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
83 + sudo apt update # update if you haven't already
84 + sudo apt install temurin-8-jdk
85 +{{/code}}
86 +
87 +{{info}}
88 + Requires ~335 Mb space to install
89 +{{/info}}
90 +
91 +**Step 4: Ensure Docker is autostarted with WSL **
92 +
93 +{{code language="cmd"}}
94 +nano .bashrc
95 +
96 + #Add following lines to bashrc
97 + DOCKER_DISTRO="Ubuntu"
98 + DOCKER_LOG_DIR=$HOME/docker_logs
99 + mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
100 + /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
101 +{{/code}}
102 +
103 +**Step 5: Add user to Docker group **
104 +
105 +{{code language="cmd"}}
106 +sudo visudo
107 +
108 + #Add following lines
109 +
110 + # Don't ask for password
111 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
112 +{{/code}}
113 +
114 +**Step 6: Update wsl config file **
115 +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
116 +
117 +First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
118 +
119 +
120 +{{code language="cmd"}}
121 + #Add following lines
122 +
123 + # Settings apply across all Linux distros running on WSL 2
124 + [wsl2]
125 + # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
126 + memory=16GB
127 + # Sets the VM to use two virtual processors
128 + processors=2
129 +{{/code}}
130 +
34 34  
35 -===3.3 Installation requirements Windows Server 2019 version 1806===
132 +**Step 7: Auto start the linux subsystem when server restarts **
133 +
36 36  
135 +===3.5 Installation requirements Windows Server 2019 version 1806===
136 +
137 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
138 +
37 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 42  * Enable Hyper-V in Windows Server
43 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 44   ** Restart windows
143 +* Cross check is WSL 2.0 is installed
144 + ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
45 45  * Install Docker Desktop on the Windows Server
46 46   ** Please refer to this link: https://www.docker.com/products/docker-desktop/
47 47   ** Restart windows
48 -* Update Docker desktop configuration
148 +* Update Docker Desktop configuration
49 49   ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
50 50   ** Restart Docker
51 51  * Open Powershell as Administrator
... ... @@ -57,14 +57,13 @@
57 57  * Ubuntu should now be a runnable program (press windows key, type ubuntu)
58 58  * Open the ubuntu terminal, and finish the installation.
59 59   ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
60 -
61 -===3.4 Installation requirements Windows Server 2012 R2 ===
62 -
160 +* Go to the next section around installing the eMagiz Docker agent
161 +
162 +===3.6 Installation requirements Windows Server 2012 R2 ===
163 +
164 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
165 +
63 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 68  * Install & enable Hyper-V in Windows Server
69 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 70   ** Restart windows
... ... @@ -76,15 +76,20 @@
76 76   ** Install an operating system from bootable CD/DVD, ISO file
77 77  * Install ubuntu downloaded previously on the VM
78 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.
178 +* Go to the next section around installing the eMagiz agent
83 83  
180 +=== 3.7 eMagiz Docker agent installation ===
181 +
182 +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.
183 +
184 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
185 +
186 +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.
187 +
84 84  == 4. Assignment ==
85 85  
86 86  Check out the cheatcheet for Docker command line:
87 -
191 +
88 88  [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
89 89  
90 90  == 5. Key takeaways ==
... ... @@ -91,7 +91,7 @@
91 91  
92 92  * 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
93 93  * eMagiz has a specific agent that manages the download of that image to the on-premises server
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.
198 +* 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.
95 95  
96 96  
97 97