Skip to Content
Last modified by Erik Bakker on 2025/04/18 13:54
From version 103.1
edited by Erik Bakker
on 2024/03/01 16:21
Change comment: There is no comment for this version
To version 38.1
edited by Erik Bakker
on 2023/01/23 12:25
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Install Docker for Windows
1 +On-premise Install Guide
Content
... ... @@ -1,5 +1,5 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -In this microlearning, we will focus on how an on-premises server can be prepared for a eMagiz Deploy agent installation.
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.
3 3  
4 4  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
... ... @@ -10,91 +10,154 @@
10 10  
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 -
14 -In the below section the Windows variant is described in terms of how to prepare the server to allow the [[eMagiz Deploy Agent>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]] to be installed. That agent allows to download images from the eMagiz infrastructure.
15 -
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 +
16 16  == 3. On-premises deployments ==
17 17  
18 18  ===3.1 General requirements===
19 -
20 -{{info}}
21 -* Standard configuration to ensure that communication between your server and eMagiz to ensure communication.
22 - ** registry.emagiz.com:443
19 +
20 +These are the general requirements to allow the installation of the eMagiz Docker agent:
21 +* Ensure access to the following URLs is enabled
22 + ** registry.emagiz.com:8443
23 23   ** controlplane.emagiz.com:8000
24 - ** Preferably the entry should be *.emagiz.com{{/info}}
24 + ** Preferably the entry should be *.emagiz.com
25 25  
26 -{{warning}}
27 -* In case of a very strict firewall configuration, additional configuration is needed to communicate to the eMagiz infrastructure.
28 - ** controltower.emagiz.com:443
29 - ** controlbus.emagiz.com:443
30 - ** controlplane.emagiz.com:443
26 +
27 +===3.2 Installation requirements Linux===
31 31  
32 -* When using cloudslot number **equal to or below** 125, the following configuration is needed to communicate to your JMS.
33 - ** 35.158.46.28:443
34 - ** 3.74.190.88:443
35 - ** 35.158.46.28:8443
36 - ** 3.74.190.88:8443
37 - ** 35.158.46.28:8444
38 - ** 3.74.190.88:8444
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
39 39  
40 -* When using a cloudslot number **above** 125, the following configuration is needed to communicate to your JMS.
41 - ** 3.74.209.20:443
42 - ** 3.76.127.155:443
43 - ** 3.74.209.20:8443
44 - ** 3.76.127.155:8443
45 - ** 3.74.209.20:8444
46 - ** 3.76.127.155:8444{{/warning}}
33 +===3.3 Installation requirements Windows Server 2022===
47 47  
48 -===3.2 Installation Windows===
49 -Whenever Windows is selected as operating system, you need to have a Windows Server 2022 version or a 2019 version (> 1806). Older Windows servers are **not** supported.
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
50 50  
40 + #Install docker
41 +{{code language="unix"}}
42 +sudo apt-get update
43 +sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
44 +. /etc/os-release
45 +curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
46 +echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
47 +sudo apt update
48 +sudo apt install docker-ce docker-ce-cli containerd.io{{/code}}
51 51  
52 -==== 3.2.1 Docker Installation ====
53 -In powershell with administrative rights, execute the following commands
50 +#Install Java
51 +{{code language="unix"}}
52 +wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
53 +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
54 +sudo apt update # update if you haven't already
55 +sudo apt install temurin-8-jdk{{/code}}
54 54  
55 -{{code language="cmd"}}
56 -Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/microsoft/Windows-Containers/Main/helpful_tools/Install-DockerCE/install-docker-ce.ps1" -o install-docker-ce.ps1
57 -.\install-docker-ce.ps1
58 -{{/code}}
57 +#Autostart Dockerd with wsl
59 59  
60 -==== 3.2.2 Check installation ====
59 +nano .bashrc
61 61  
62 -After executing the commands above, the server will restart if required. After the restart, execute the following command
61 + DOCKER_DISTRO="Ubuntu"
62 + DOCKER_LOG_DIR=$HOME/docker_logs
63 + mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
64 + /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
63 63  
64 -{{code language="cmd"}}
65 -docker ps
66 -{{/code}}
66 +#Do not ask password dockerd
67 +sudo visudo
67 67  
68 -If the command returns that the command cannot be found, please run the following command again.
69 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
69 69  
70 -{{code language="cmd"}}
71 -.\install-docker-ce.ps1
72 -{{/code}}
71 +#Set WSL config for memory
72 +USERDIR/.wslconfig
73 + # Settings apply across all Linux distros running on WSL 2
74 + [wsl2]
73 73  
74 -==== 3.2.3 Verify docker functionality ====
76 + # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
77 + memory=16GB
75 75  
76 -Execute the following command
79 + # Sets the VM to use two virtual processors
80 + processors=2
81 +
82 +
83 +(Exit WSL: wsl --shutdown)
77 77  
78 -{{code language="cmd"}}
79 -docker ps
80 -{{/code}}
85 +===3.4 Installation requirements Windows Server 2019 version >1806===
81 81  
82 -The result of this call should show the following:
87 +These are the requirements to allow the installation of the eMagiz Docker agent:
88 +* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
89 +* Validate if WSL 2.0 is properly installed
90 +* Go to the next section around installing the eMagiz Docker agent
91 +
92 +===3.5 Installation requirements Windows Server 2019 version 1806===
83 83  
84 -[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
94 +These are the requirements to allow the installation of the eMagiz Docker agent:
95 +* Enable Hyper-V in Windows Server
96 + ** 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.
97 + ** Restart windows
98 +* Cross check is WSL 2.0 is installed
99 + ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
100 +* Install Docker Desktop on the Windows Server
101 + ** Please refer to this link: https://www.docker.com/products/docker-desktop/
102 + ** Restart windows
103 +* Update Docker Desktop configuration
104 + ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
105 + ** Restart Docker
106 +* Open Powershell as Administrator
107 + ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
108 + ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
109 + ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
110 + ** Execute Add-AppxPackage .\ubuntu-2004.appx
111 + *** If errors occur, please consult https://learn.microsoft.com/en-us/windows/wsl/install-on-server. Rename the file to a zip, expand it, and add it to the path variable.
112 +* Ubuntu should now be a runnable program (press windows key, type ubuntu)
113 +* Open the ubuntu terminal, and finish the installation.
114 + ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
115 +* Go to the next section around installing the eMagiz Docker agent
116 +
117 +===3.6 Installation requirements Windows Server 2012 R2 ===
118 +
119 +These are the requirements to allow the installation of the eMagiz Docker agent:
120 +* Install & enable Hyper-V in Windows Server
121 + ** 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.
122 + ** Restart windows
123 +* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
124 +* Create a VM in HyperV.
125 + ** 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).
126 + ** Configure a virtual switch.
127 + ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
128 + ** Install an operating system from bootable CD/DVD, ISO file
129 +* Install ubuntu downloaded previously on the VM
130 +* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
131 +* Go to the next section around installing the eMagiz agent
132 +
133 +=== 3.7 eMagiz Docker agent installation ===
134 +
135 +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.
136 +
137 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
85 85  
86 -==== 3.2.4 Install eMagiz Deploy Agent ====
139 +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.
87 87  
88 -Install the eMagiz Deploy agent as can be found in this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
141 +== 4. Assignment ==
89 89  
90 -== 4. Key takeaways ==
143 +Check out the cheatcheet for Docker command line:
144 +
145 +[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
91 91  
147 +== 5. Key takeaways ==
148 +
92 92  * 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
93 93  * eMagiz has a specific agent that manages the download of that image to the on-premises server
94 -* 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.
151 +* 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.
95 95  
96 -== 5. Suggested Additional Readings ==
97 97  
98 -* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
99 99  
155 +== 6. Suggested Additional Readings ==
156 +
157 +N/A
158 +
159 +== 7. Silent demonstration video ==
160 +
161 +N/A
162 +
100 100  )))((({{toc/}}))){{/container}}{{/container}}