Skip to Content

Changes for page Install Docker for Linux

Last modified by Erik Bakker on 2025/04/18 13:54
From version 16.1
edited by eMagiz
on 2022/11/02 08:40
Change comment: There is no comment for this version
To version 71.1
edited by eMagiz
on 2023/02/07 14:20
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,25 +9,137 @@
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 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 +
14 14  == 3. On-premises deployments ==
15 15  
16 -===3.1 Installation requirements Windows Server 2019 version 1806===
17 -
18 -Below the installation step for this version of Windows
19 -
18 +===3.1 General requirements===
19 +These are the general requirements to allow the installation of the eMagiz Docker agent:
20 20  * Ensure access to the following URLs is enabled
21 - ** registry.emagiz.com
22 - ** testing.emagiz.com
21 + ** registry.emagiz.com:8443
22 + ** controlplane.emagiz.com:8000
23 23   ** Preferably the entry should be *.emagiz.com
24 +
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
29 +
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
50 +
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
53 +
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 + wsl sudo /usr/bin/dockerd
71 +
72 +**Step 5: Install eMagiz Deploy Agent**
73 +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"]]
74 +
75 +
76 +===3.4 Installation steps to configure Linux subsystem ===
77 +
78 +**Step 1: Install Docker **
79 +
80 +{{code language="cmd"}}
81 + curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
82 + echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
83 + sudo apt update
84 + sudo apt install docker-ce docker-ce-cli containerd.io
85 +{{/code}}
86 +
87 +{{info}}
88 + Requires ~335 Mb space to install
89 +{{/info}}
90 +
91 +**Step 2: Install Java **
92 +
93 +{{code language="cmd"}}
94 + wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
95 + 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
96 + sudo apt update # update if you haven't already
97 + sudo apt install temurin-8-jdk
98 +{{/code}}
99 +
100 +{{info}}
101 + Requires ~335 Mb space to install
102 +{{/info}}
103 +
104 +**Step 3: Ensure Docker is autostarted with WSL **
105 +
106 +{{code language="cmd"}}
107 +nano .bashrc
108 +
109 + #Add following lines to bashrc
110 + DOCKER_DISTRO="Ubuntu"
111 + DOCKER_LOG_DIR=$HOME/docker_logs
112 + mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
113 + /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
114 +{{/code}}
115 +
116 +**Step 4: Add user to Docker group **
117 +
118 +{{code language="cmd"}}
119 +sudo visudo
120 +
121 + #Add following lines
122 +
123 + # Don't ask for password
124 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
125 +{{/code}}
126 +
127 +
128 +
129 +===3.5 Installation requirements Windows Server 2019 version 1806===
130 +
131 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
132 +
133 +These are the requirements to allow the installation of the eMagiz Docker agent:
24 24  * Enable Hyper-V in Windows Server
25 25   ** 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.
26 26   ** Restart windows
137 +* Cross check is WSL 2.0 is installed
138 + ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
27 27  * Install Docker Desktop on the Windows Server
28 28   ** Please refer to this link: https://www.docker.com/products/docker-desktop/
29 29   ** Restart windows
30 -* Update Docker desktop configuration
142 +* Update Docker Desktop configuration
31 31   ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
32 32   ** Restart Docker
33 33  * Open Powershell as Administrator
... ... @@ -39,19 +39,30 @@
39 39  * Ubuntu should now be a runnable program (press windows key, type ubuntu)
40 40  * Open the ubuntu terminal, and finish the installation.
41 41   ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
42 -
43 -=== 3.2 Installation agent ===
44 -
45 -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.
46 -
47 -=== 3.3 Cloud architecture for API Gateway ===
48 -
49 -[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-install-runtime-images.png]]
154 +* Go to the next section around installing the eMagiz Docker agent
50 50  
156 +===3.6 Installation requirements Windows Server 2012 R2 ===
157 +
158 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
159 +
160 +These are the requirements to allow the installation of the eMagiz Docker agent:
161 +* Install & enable Hyper-V in Windows Server
162 + ** 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.
163 + ** Restart windows
164 +* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
165 +* Create a VM in HyperV.
166 + ** 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).
167 + ** Configure a virtual switch.
168 + ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
169 + ** Install an operating system from bootable CD/DVD, ISO file
170 +* Install ubuntu downloaded previously on the VM
171 +* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
172 +* Go to the next section around installing the eMagiz agent
173 +
51 51  == 4. Assignment ==
52 52  
53 53  Check out the cheatcheet for Docker command line:
54 -
177 +
55 55  [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
56 56  
57 57  == 5. Key takeaways ==
... ... @@ -58,7 +58,7 @@
58 58  
59 59  * 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
60 60  * eMagiz has a specific agent that manages the download of that image to the on-premises server
61 -* 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.
184 +* 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.
62 62  
63 63  
64 64