Skip to Content

Wiki source code of On-premise Install Guide

Version 40.1 by Erik Bakker on 2023/01/23 12:26
Hide last authors
eMagiz 1.1 1 {{container}}{{container layoutStyle="columns"}}(((
eMagiz 3.1 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.
Erik Bakker 15.1 3
eMagiz 1.1 4 Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5
6 == 1. Prerequisites ==
7
8 * Advanced knowledge of the eMagiz platform
eMagiz 3.1 9 * Good understanding of eMagiz runtimes in general
eMagiz 1.1 10
11 == 2. Key concepts ==
eMagiz 25.1 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.
eMagiz 3.1 13
eMagiz 30.1 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.
eMagiz 21.1 15
eMagiz 3.1 16 == 3. On-premises deployments ==
eMagiz 25.1 17
18 ===3.1 General requirements===
eMagiz 17.1 19
eMagiz 25.1 20 These are the general requirements to allow the installation of the eMagiz Docker agent:
eMagiz 17.1 21 * Ensure access to the following URLs is enabled
eMagiz 33.1 22 ** registry.emagiz.com:8443
eMagiz 34.1 23 ** controlplane.emagiz.com:8000
eMagiz 17.1 24 ** Preferably the entry should be *.emagiz.com
eMagiz 31.1 25
eMagiz 25.1 26
27 ===3.2 Installation requirements Linux===
28
eMagiz 31.1 29 * Whenever Linux is selected as operating system, the latest version of Ubuntu will work
Erik Bakker 38.1 30 * Install latest version of the Docker engine - see for instance {{code}}https://docs.docker.com/engine/install/ubuntu/{{/code}}
eMagiz 22.1 31 * Go to the next section around installing the eMagiz agent
eMagiz 1.1 32
eMagiz 26.1 33 ===3.3 Installation requirements Windows Server 2022===
eMagiz 18.1 34
35 These are the requirements to allow the installation of the eMagiz Docker agent:
Erik Bakker 38.1 36 * Install latest version of Docker Desktop from {{code}}https://www.docker.com/products/docker-desktop/{{/code}}
eMagiz 17.1 37 * Validate if WSL 2.0 is properly installed
eMagiz 28.1 38 * Go to the next section around installing the eMagiz Docker agent
Erik Bakker 38.1 39
eMagiz 32.1 40 #Install docker
41 sudo apt-get update
42 sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
43 . /etc/os-release
44 curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
45 echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
46 sudo apt update
Erik Bakker 40.1 47 sudo apt install docker-ce docker-ce-cli containerd.io
eMagiz 24.1 48
eMagiz 32.1 49 #Install Java
50 wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
51 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
52 sudo apt update # update if you haven't already
Erik Bakker 40.1 53 sudo apt install temurin-8-jdk
eMagiz 32.1 54
55 #Autostart Dockerd with wsl
Erik Bakker 38.1 56
eMagiz 32.1 57 nano .bashrc
58
59 DOCKER_DISTRO="Ubuntu"
60 DOCKER_LOG_DIR=$HOME/docker_logs
61 mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
62 /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
64 #Do not ask password dockerd
65 sudo visudo
66
67 %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
68
69 #Set WSL config for memory
70 USERDIR/.wslconfig
71 # Settings apply across all Linux distros running on WSL 2
72 [wsl2]
73
74 # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
75 memory=16GB
76
77 # Sets the VM to use two virtual processors
78 processors=2
Erik Bakker 40.1 79
eMagiz 32.1 80 (Exit WSL: wsl --shutdown)
81
eMagiz 26.1 82 ===3.4 Installation requirements Windows Server 2019 version >1806===
eMagiz 24.1 83
84 These are the requirements to allow the installation of the eMagiz Docker agent:
eMagiz 27.1 85 * Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
eMagiz 24.1 86 * Validate if WSL 2.0 is properly installed
eMagiz 28.1 87 * Go to the next section around installing the eMagiz Docker agent
Erik Bakker 40.1 88
eMagiz 26.1 89 ===3.5 Installation requirements Windows Server 2019 version 1806===
eMagiz 17.1 90
eMagiz 18.1 91 These are the requirements to allow the installation of the eMagiz Docker agent:
eMagiz 12.1 92 * Enable Hyper-V in Windows Server
93 ** 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.
94 ** Restart windows
eMagiz 29.1 95 * Cross check is WSL 2.0 is installed
96 ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
eMagiz 12.1 97 * Install Docker Desktop on the Windows Server
98 ** Please refer to this link: https://www.docker.com/products/docker-desktop/
99 ** Restart windows
eMagiz 25.1 100 * Update Docker Desktop configuration
eMagiz 12.1 101 ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
102 ** Restart Docker
103 * Open Powershell as Administrator
104 ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
105 ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
106 ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
107 ** Execute Add-AppxPackage .\ubuntu-2004.appx
eMagiz 14.1 108 *** 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.
eMagiz 12.1 109 * Ubuntu should now be a runnable program (press windows key, type ubuntu)
110 * Open the ubuntu terminal, and finish the installation.
111 ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
eMagiz 28.1 112 * Go to the next section around installing the eMagiz Docker agent
Erik Bakker 40.1 113
eMagiz 26.1 114 ===3.6 Installation requirements Windows Server 2012 R2 ===
Erik Bakker 40.1 115
eMagiz 18.1 116 These are the requirements to allow the installation of the eMagiz Docker agent:
117 * Install & enable Hyper-V in Windows Server
118 ** 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.
119 ** Restart windows
120 * Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
121 * Create a VM in HyperV.
122 ** 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).
eMagiz 19.1 123 ** Configure a virtual switch.
124 ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
125 ** Install an operating system from bootable CD/DVD, ISO file
eMagiz 18.1 126 * Install ubuntu downloaded previously on the VM
127 * Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
eMagiz 22.1 128 * Go to the next section around installing the eMagiz agent
Erik Bakker 40.1 129
eMagiz 28.1 130 === 3.7 eMagiz Docker agent installation ===
Erik Bakker 40.1 131
eMagiz 36.1 132 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.
Erik Bakker 40.1 133
eMagiz 37.1 134 [[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
eMagiz 1.1 135
eMagiz 26.1 136 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.
eMagiz 23.1 137
eMagiz 1.1 138 == 4. Assignment ==
139
eMagiz 9.1 140 Check out the cheatcheet for Docker command line:
Erik Bakker 40.1 141
eMagiz 9.1 142 [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
eMagiz 1.1 143
144 == 5. Key takeaways ==
145
eMagiz 5.1 146 * 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
147 * eMagiz has a specific agent that manages the download of that image to the on-premises server
Erik Bakker 40.1 148 * 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.
eMagiz 1.1 149
150
151
152 == 6. Suggested Additional Readings ==
153
eMagiz 8.1 154 N/A
155
eMagiz 1.1 156 == 7. Silent demonstration video ==
157
eMagiz 3.1 158 N/A
eMagiz 1.1 159
160 )))((({{toc/}}))){{/container}}{{/container}}