Skip to Content

Changes for page Install Docker for Linux

Last modified by Erik Bakker on 2025/04/18 13:54
From version 21.1
edited by eMagiz
on 2022/11/11 09:34
Change comment: There is no comment for this version
To version 72.1
edited by eMagiz
on 2023/02/07 14:47
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 +Pre-requisite installation of on-premises server
Content
... ... @@ -1,5 +1,5 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
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.
2 +In this microlearning, we will focus on how an on-premises server can be prepared for a eMagiz Deploy agent installation.
3 3  
4 4  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
... ... @@ -9,45 +9,144 @@
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 -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.5 for the installation of the eMagiz portainer 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 Windows and Linux variants are described in terms of how to prepare the server to allow the eMagiz Deploy agent to be installed. That agent allows to download images from the eMagiz infrastructure.
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 +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 - ** testing.emagiz.com
21 + ** registry.emagiz.com:8443
22 + ** controlplane.emagiz.com:8000
24 24   ** Preferably the entry should be *.emagiz.com
25 -* Install latest version of Docker
26 26  
27 -===3.2 Installation requirements Windows Server 2022===
25 +===3.2 Installation requirements Linux===
26 +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.
27 +**Step 1: Install linux distribution**
28 +Follow all steps in section 3.4
28 28  
29 -These are the requirements to allow the installation of the eMagiz Docker agent:
30 -* Ensure access to the following URLs is enabled
31 - ** registry.emagiz.com
32 - ** testing.emagiz.com
33 - ** Preferably the entry should be *.emagiz.com
34 -* Install latest version of Docker
35 -* Validate if WSL 2.0 is properly installed
30 +**Step 2: Install eMagiz Deploy Agent**
31 +Install the eMagiz Deploy agent as can be found [[on this link>>https://docs.emagiz.com/bin/view/Main/eMagiz%20Academy/Microlearnings/Intermediate%20Level/eMagiz%20Runtime%20Management/intermediate-runtime-management-deploy-agent/||target="_blank"]]
32 +
33 +===3.3 Installation requirements Windows Server 2022 ===
34 +
35 +{{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
36 +
37 +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).
38 +
39 +**Step 1: Install linux distribution**
40 +
41 +{{code language="cmd"}}
42 + wsl --install -d Ubuntu
43 + sudo apt-get update
44 + sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
45 + . /etc/os-release
46 +{{/code}}
47 +
48 +**Step 2: Configure linux system**
49 +Please see section 3.4 for these these steps
36 36  
37 -===3.3 Installation requirements Windows Server 2019 version 1806===
51 +**Step 3: Update wsl config file **
52 +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
38 38  
54 +First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
55 +
56 +{{code language="cmd"}}
57 + #Add following lines
58 +
59 + # Settings apply across all Linux distros running on WSL 2
60 + [wsl2]
61 + # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
62 + memory=16GB
63 + # Sets the VM to use two virtual processors
64 + processors=2
65 +{{/code}}
66 +
67 +
68 +**Step 4: Auto start the linux subsystem when Windows server restarts **
69 +
70 +{{code language="cmd"}}
71 +Press Windows+R
72 +Type shell:startup and press enter
73 +
74 + wsl sudo /usr/bin/dockerd
75 +
76 + {{/code}}
77 +
78 +
79 +**Step 5: Install eMagiz Deploy Agent**
80 +Install the eMagiz Deploy agent as can be found [[on this link>>https://docs.emagiz.com/bin/view/Main/eMagiz%20Academy/Microlearnings/Intermediate%20Level/eMagiz%20Runtime%20Management/intermediate-runtime-management-deploy-agent/||target="_blank"]]
81 +
82 +
83 +===3.4 Installation steps to configure Linux subsystem ===
84 +
85 +**Step 1: Install Docker **
86 +
87 +{{code language="cmd"}}
88 + curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
89 + echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
90 + sudo apt update
91 + sudo apt install docker-ce docker-ce-cli containerd.io
92 +{{/code}}
93 +
94 +{{info}}
95 + Requires ~335 Mb space to install
96 +{{/info}}
97 +
98 +**Step 2: Install Java **
99 +
100 +{{code language="cmd"}}
101 + wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
102 + 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
103 + sudo apt update # update if you haven't already
104 + sudo apt install temurin-8-jdk
105 +{{/code}}
106 +
107 +{{info}}
108 + Requires ~335 Mb space to install
109 +{{/info}}
110 +
111 +**Step 3: Ensure Docker is autostarted with WSL **
112 +
113 +{{code language="cmd"}}
114 +nano .bashrc
115 +
116 + #Add following lines to bashrc
117 + DOCKER_DISTRO="Ubuntu"
118 + DOCKER_LOG_DIR=$HOME/docker_logs
119 + mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
120 + /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
121 +{{/code}}
122 +
123 +**Step 4: Add user to Docker group **
124 +
125 +{{code language="cmd"}}
126 +sudo visudo
127 +
128 + #Add following lines
129 +
130 + # Don't ask for password
131 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
132 +{{/code}}
133 +
134 +
135 +
136 +===3.5 Installation requirements Windows Server 2019 version 1806===
137 +
138 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
139 +
39 39  These are the requirements to allow the installation of the eMagiz Docker agent:
40 -* Ensure access to the following URLs is enabled
41 - ** registry.emagiz.com
42 - ** testing.emagiz.com
43 - ** Preferably the entry should be *.emagiz.com
44 44  * Enable Hyper-V in Windows Server
45 45   ** 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.
46 46   ** Restart windows
144 +* Cross check is WSL 2.0 is installed
145 + ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
47 47  * Install Docker Desktop on the Windows Server
48 48   ** Please refer to this link: https://www.docker.com/products/docker-desktop/
49 49   ** Restart windows
50 -* Update Docker desktop configuration
149 +* Update Docker Desktop configuration
51 51   ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
52 52   ** Restart Docker
53 53  * Open Powershell as Administrator
... ... @@ -59,14 +59,13 @@
59 59  * Ubuntu should now be a runnable program (press windows key, type ubuntu)
60 60  * Open the ubuntu terminal, and finish the installation.
61 61   ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
62 -
63 -===3.4 Installation requirements Windows Server 2012 R2 ===
64 -
161 +* Go to the next section around installing the eMagiz Docker agent
162 +
163 +===3.6 Installation requirements Windows Server 2012 R2 ===
164 +
165 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
166 +
65 65  These are the requirements to allow the installation of the eMagiz Docker agent:
66 -* Ensure access to the following URLs is enabled
67 - ** registry.emagiz.com
68 - ** testing.emagiz.com
69 - ** Preferably the entry should be *.emagiz.com
70 70  * Install & enable Hyper-V in Windows Server
71 71   ** 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.
72 72   ** Restart windows
... ... @@ -78,15 +78,12 @@
78 78   ** Install an operating system from bootable CD/DVD, ISO file
79 79  * Install ubuntu downloaded previously on the VM
80 80  * Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
81 -
82 -=== 3.5 Installation agent ===
83 -
84 -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.
179 +* Go to the next section around installing the eMagiz agent
85 85  
86 86  == 4. Assignment ==
87 87  
88 88  Check out the cheatcheet for Docker command line:
89 -
184 +
90 90  [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
91 91  
92 92  == 5. Key takeaways ==
... ... @@ -93,7 +93,7 @@
93 93  
94 94  * 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
95 95  * eMagiz has a specific agent that manages the download of that image to the on-premises server
96 -* 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.
191 +* 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.
97 97  
98 98  
99 99