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 55.1
edited by eMagiz
on 2023/02/07 11:39
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,25 +9,133 @@
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.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 +
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 +
20 +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
22 + ** registry.emagiz.com:8443
23 + ** controlplane.emagiz.com:8000
23 23   ** Preferably the entry should be *.emagiz.com
25 +
26 +
27 +===3.2 Installation requirements Linux===
28 +
29 +* Whenever Linux is selected as operating system, the latest version of Ubuntu will work
30 +* Install latest version of the Docker engine - see for instance {{code}}https://docs.docker.com/engine/install/ubuntu/{{/code}}
31 +* Go to the next section around installing the eMagiz agent
32 +
33 +===3.3 Installation requirements Windows Server 2022===
34 +
35 +These are the requirements to allow the installation of the eMagiz Docker agent:
36 +* Install latest version of Docker Desktop from {{code}}https://www.docker.com/products/docker-desktop/{{/code}}
37 +* Validate if WSL 2.0 is properly installed
38 +* Go to the next section around installing the eMagiz Docker agent
39 +
40 +===3.3 Installation requirements Windows Server 2022 (without Docker Desktop) ===
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 +
52 +**Step 2: Install Docker **
53 +
54 +{{code language="cmd"}}
55 + curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
56 + echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
57 + sudo apt update
58 + sudo apt install docker-ce docker-ce-cli containerd.io
59 +{{/code}}
60 +
61 +{{info}}
62 + Requires ~335 Mb space to install
63 +{{/info}}
64 +
65 +**Step 3: Install Java **
66 +
67 +{{code language="cmd"}}
68 + wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
69 + 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
70 + sudo apt update # update if you haven't already
71 + sudo apt install temurin-8-jdk
72 +{{/code}}
73 +
74 +{{info}}
75 + Requires ~335 Mb space to install
76 +{{/info}}
77 +
78 +**Step 4: Ensure Docker is autostarted with WSL **
79 +
80 +{{code language="cmd"}}
81 +nano .bashrc
82 +
83 + #Add following lines to bashrc
84 + DOCKER_DISTRO="Ubuntu"
85 + DOCKER_LOG_DIR=$HOME/docker_logs
86 + mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
87 + /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
88 +{{/code}}
89 +
90 +**Step 5: Add user to Docker group **
91 +
92 +{{code language="cmd"}}
93 +sudo visudo
94 +
95 + #Add following lines
96 +
97 + # Don't ask for password
98 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
99 +{{/code}}
100 +
101 +**Step 6: Update wsl config file **
102 +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
103 +
104 +First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
105 +
106 +{{code language="cmd"}}
107 + #Add following lines
108 +
109 + # Settings apply across all Linux distros running on WSL 2
110 + [wsl2]
111 + # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
112 + memory=16GB
113 + # Sets the VM to use two virtual processors
114 + processors=2
115 +{{/code}}
116 +
117 +**Step 7: Auto start the linux subsystem when server restarts **
118 +
119 +
120 +===3.4 Installation requirements Windows Server 2019 version >1806===
121 +
122 +These are the requirements to allow the installation of the eMagiz Docker agent:
123 +* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
124 +* Validate if WSL 2.0 is properly installed
125 +* Go to the next section around installing the eMagiz Docker agent
126 +
127 +===3.5 Installation requirements Windows Server 2019 version 1806===
128 +
129 +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
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
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
138 +* 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,36 @@
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]]
150 +* Go to the next section around installing the eMagiz Docker agent
50 50  
152 +===3.6 Installation requirements Windows Server 2012 R2 ===
153 +
154 +These are the requirements to allow the installation of the eMagiz Docker agent:
155 +* Install & enable Hyper-V in Windows Server
156 + ** 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.
157 + ** Restart windows
158 +* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
159 +* Create a VM in HyperV.
160 + ** 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).
161 + ** Configure a virtual switch.
162 + ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
163 + ** Install an operating system from bootable CD/DVD, ISO file
164 +* Install ubuntu downloaded previously on the VM
165 +* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
166 +* Go to the next section around installing the eMagiz agent
167 +
168 +=== 3.7 eMagiz Docker agent installation ===
169 +
170 +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.
171 +
172 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
173 +
174 +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.
175 +
51 51  == 4. Assignment ==
52 52  
53 53  Check out the cheatcheet for Docker command line:
54 -
179 +
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.
186 +* 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