Skip to Content

Changes for page Install Docker for Linux

Last modified by Erik Bakker on 2025/04/18 13:54
From version 27.1
edited by eMagiz
on 2022/11/15 14:54
Change comment: There is no comment for this version
To version 62.1
edited by eMagiz
on 2023/02/07 12:26
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
... ... @@ -11,7 +11,7 @@
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 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 17  
... ... @@ -19,36 +19,119 @@
19 19  
20 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 +
25 25  
26 26  ===3.2 Installation requirements Linux===
27 27  
28 -* Install latest version of the Docker engine - see for instance https://docs.docker.com/engine/install/ubuntu/
29 -* 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 +* Follow all steps in section 3.4
30 30  
31 -===3.3 Installation requirements Windows Server 2022===
32 +* Install the eMagiz Deploy agent
32 32  
33 -These are the requirements to allow the installation of the eMagiz Docker agent:
34 -* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
35 -* Validate if WSL 2.0 is properly installed
36 -* Go to the next section around installing the eMagiz agent
34 +===3.3 Installation requirements Windows Server 2022 ===
37 37  
38 -===3.4 Installation requirements Windows Server 2019 version >1806===
36 +{{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
39 39  
40 -These are the requirements to allow the installation of the eMagiz Docker agent:
41 -* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
42 -* Validate if WSL 2.0 is properly installed
43 -* Go to the next section around installing the eMagiz agent
38 +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).
39 +
40 +**Step 1: Install linux distribution**
41 +
42 +{{code language="cmd"}}
43 + wsl --install -d Ubuntu
44 + sudo apt-get update
45 + sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
46 + . /etc/os-release
47 +{{/code}}
48 +
49 +**Step 2: Configure linux system**
50 +Please see section 3.4 for these these steps
44 44  
52 +**Step 3: Update wsl config file **
53 +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
54 +
55 +First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
56 +
57 +{{code language="cmd"}}
58 + #Add following lines
59 +
60 + # Settings apply across all Linux distros running on WSL 2
61 + [wsl2]
62 + # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
63 + memory=16GB
64 + # Sets the VM to use two virtual processors
65 + processors=2
66 +{{/code}}
67 +
45 45  
69 +**Step 4: Auto start the linux subsystem when Windows server restarts **
70 +
71 +
72 +===3.4 Installation steps to configure Linux subsystem ===
73 +
74 +**Step 1: Install Docker **
75 +
76 +{{code language="cmd"}}
77 + curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
78 + echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
79 + sudo apt update
80 + sudo apt install docker-ce docker-ce-cli containerd.io
81 +{{/code}}
82 +
83 +{{info}}
84 + Requires ~335 Mb space to install
85 +{{/info}}
86 +
87 +**Step 2: Install Java **
88 +
89 +{{code language="cmd"}}
90 + wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
91 + 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
92 + sudo apt update # update if you haven't already
93 + sudo apt install temurin-8-jdk
94 +{{/code}}
95 +
96 +{{info}}
97 + Requires ~335 Mb space to install
98 +{{/info}}
99 +
100 +**Step 3: Ensure Docker is autostarted with WSL **
101 +
102 +{{code language="cmd"}}
103 +nano .bashrc
104 +
105 + #Add following lines to bashrc
106 + DOCKER_DISTRO="Ubuntu"
107 + DOCKER_LOG_DIR=$HOME/docker_logs
108 + mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
109 + /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
110 +{{/code}}
111 +
112 +**Step 4: Add user to Docker group **
113 +
114 +{{code language="cmd"}}
115 +sudo visudo
116 +
117 + #Add following lines
118 +
119 + # Don't ask for password
120 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
121 +{{/code}}
122 +
123 +
124 +
46 46  ===3.5 Installation requirements Windows Server 2019 version 1806===
47 47  
127 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
128 +
48 48  These are the requirements to allow the installation of the eMagiz Docker agent:
49 49  * Enable Hyper-V in Windows Server
50 50   ** 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.
51 51   ** Restart windows
133 +* Cross check is WSL 2.0 is installed
134 + ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
52 52  * Install Docker Desktop on the Windows Server
53 53   ** Please refer to this link: https://www.docker.com/products/docker-desktop/
54 54   ** Restart windows
... ... @@ -64,10 +64,12 @@
64 64  * Ubuntu should now be a runnable program (press windows key, type ubuntu)
65 65  * Open the ubuntu terminal, and finish the installation.
66 66   ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
67 -* Go to the next section around installing the eMagiz agent
68 -
150 +* Go to the next section around installing the eMagiz Docker agent
151 +
69 69  ===3.6 Installation requirements Windows Server 2012 R2 ===
70 -
153 +
154 +{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
155 +
71 71  These are the requirements to allow the installation of the eMagiz Docker agent:
72 72  * Install & enable Hyper-V in Windows Server
73 73   ** 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.
... ... @@ -81,17 +81,19 @@
81 81  * Install ubuntu downloaded previously on the VM
82 82  * Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
83 83  * Go to the next section around installing the eMagiz agent
84 -
85 -=== 3.7 eMagiz agent installation agent ===
86 -
87 -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 when the machine is used for the first time deployment of eMagiz runtimes. A popup will appear that displays the commands per type of OS. Once that agent is installed, the image that is generated for every eMagiz release can be downloaded and installed in the Docker instance.
88 88  
170 +=== 3.7 eMagiz Docker agent installation ===
171 +
172 +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.
173 +
174 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
175 +
89 89  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.
90 90  
91 91  == 4. Assignment ==
92 92  
93 93  Check out the cheatcheet for Docker command line:
94 -
181 +
95 95  [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
96 96  
97 97  == 5. Key takeaways ==
... ... @@ -98,7 +98,7 @@
98 98  
99 99  * 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
100 100  * eMagiz has a specific agent that manages the download of that image to the on-premises server
101 -* 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.
188 +* 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.
102 102  
103 103  
104 104