Skip to Content

Changes for page Install Docker for Linux

Last modified by Erik Bakker on 2025/04/18 13:54
From version 23.1
edited by eMagiz
on 2022/11/11 09:38
Change comment: There is no comment for this version
To version 65.3
edited by eMagiz
on 2023/02/07 12:41
Change comment: Update document after refactoring.

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -On-premises deployment new runtime architecture
1 +expert-solution-architecture-onpremises-installguide
Content
... ... @@ -9,47 +9,138 @@
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 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 - ** testing.emagiz.com
22 + ** registry.emagiz.com:8443
23 + ** controlplane.emagiz.com:8000
24 24   ** Preferably the entry should be *.emagiz.com
25 -* Install latest version of Docker
26 -* Go to the next section around installing the eMagiz agent
27 27  
28 -===3.2 Installation requirements Windows Server 2022===
26 +
27 +===3.2 Installation requirements Linux===
29 29  
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 -* Validate if WSL 2.0 is properly installed
37 -* Go to the next section around installing the eMagiz agent
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 +**Step 1: Install linux distribution**
31 +Follow all steps in section 3.4
32 +
33 +**Step 2: Install eMagiz Deploy Agent**
34 +Install the eMagiz Deploy agent as can be found here
35 +
36 +===3.3 Installation requirements Windows Server 2022 ===
37 +
38 +{{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
39 +
40 +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).
41 +
42 +**Step 1: Install linux distribution**
43 +
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 +**Step 2: Configure linux system**
52 +Please see section 3.4 for these these steps
38 38  
39 -===3.3 Installation requirements Windows Server 2019 version 1806===
54 +**Step 3: Update wsl config file **
55 +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
40 40  
57 +First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
58 +
59 +{{code language="cmd"}}
60 + #Add following lines
61 +
62 + # Settings apply across all Linux distros running on WSL 2
63 + [wsl2]
64 + # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
65 + memory=16GB
66 + # Sets the VM to use two virtual processors
67 + processors=2
68 +{{/code}}
69 +
70 +
71 +**Step 4: Auto start the linux subsystem when Windows server restarts **
72 +
73 +**Step 5: Install eMagiz Deploy Agent**
74 +Install the eMagiz Deploy agent as can be found here
75 +
76 +
77 +===3.4 Installation steps to configure Linux subsystem ===
78 +
79 +**Step 1: Install Docker **
80 +
81 +{{code language="cmd"}}
82 + curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
83 + echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
84 + sudo apt update
85 + sudo apt install docker-ce docker-ce-cli containerd.io
86 +{{/code}}
87 +
88 +{{info}}
89 + Requires ~335 Mb space to install
90 +{{/info}}
91 +
92 +**Step 2: Install Java **
93 +
94 +{{code language="cmd"}}
95 + wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
96 + 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
97 + sudo apt update # update if you haven't already
98 + sudo apt install temurin-8-jdk
99 +{{/code}}
100 +
101 +{{info}}
102 + Requires ~335 Mb space to install
103 +{{/info}}
104 +
105 +**Step 3: Ensure Docker is autostarted with WSL **
106 +
107 +{{code language="cmd"}}
108 +nano .bashrc
109 +
110 + #Add following lines to bashrc
111 + DOCKER_DISTRO="Ubuntu"
112 + DOCKER_LOG_DIR=$HOME/docker_logs
113 + mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
114 + /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
115 +{{/code}}
116 +
117 +**Step 4: Add user to Docker group **
118 +
119 +{{code language="cmd"}}
120 +sudo visudo
121 +
122 + #Add following lines
123 +
124 + # Don't ask for password
125 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
126 +{{/code}}
127 +
128 +
129 +
130 +===3.5 Installation requirements Windows Server 2019 version 1806===
131 +
132 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
133 +
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
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
138 +* Cross check is WSL 2.0 is installed
139 + ** 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 configuration
143 +* 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,13 @@
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.4 Installation requirements Windows Server 2012 R2 ===
67 -
155 +* Go to the next section around installing the eMagiz Docker agent
156 +
157 +===3.6 Installation requirements Windows Server 2012 R2 ===
158 +
159 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
160 +
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,11 @@
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
95 -
96 -
97 97  == 4. Assignment ==
98 98  
99 99  Check out the cheatcheet for Docker command line:
100 -
178 +
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.
185 +* 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