Changes for page Install Docker for Windows

Last modified by Erik Bakker on 2025/04/18 13:54

From 47.1 to 48.1 From 92.1 to 93.1

From version 48.1

edited by eMagiz
on 2023/02/06 08:37

Change comment: There is no comment for this version

To version 92.1

edited by Erik Bakker
on 2023/09/08 11:07

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

@@ -1,1 +1,1 @@
--On-premise Install Guide
++Pre-requisite installation of on-premises server

Author

@@ -1,1 +1,1 @@
--XWiki.eMagiz
++XWiki.ebakker

Content

@@ -1,5 +1,5 @@
  {{container}}{{container layoutStyle="columns"}}(((
--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.
++In this microlearning, we will focus on how an on-premises server can be prepared for a eMagiz Deploy agent installation.
  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
@@ -11,34 +11,31 @@
  == 2. Key concepts ==
  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.
--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.
++In the below section the Windows and Linux variants are described in terms of how to prepare the server to allow the eMagiz Deploy agent to be installed. That agent allows to download images from the eMagiz infrastructure.
  == 3. On-premises deployments ==
  ===3.1 General requirements===
--
  These are the general requirements to allow the installation of the eMagiz Docker agent:
  * Ensure access to the following URLs is enabled
--    ** registry.emagiz.com:8443
++    ** registry.emagiz.com:5443
      ** controlplane.emagiz.com:8000
      ** Preferably the entry should be *.emagiz.com
--
  ===3.2 Installation requirements Linux===
++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.
++**Step 1: Install linux distribution**
++Follow the relevant steps in section 3.4
--* Whenever Linux is selected as operating system, the latest version of Ubuntu will work
--* Install latest version of the Docker engine - see for instance {{code}}https://docs.docker.com/engine/install/ubuntu/{{/code}}
--* Go to the next section around installing the eMagiz agent
++**Step 2: Install eMagiz Deploy Agent**
++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"]]
--===3.3 Installation requirements Windows Server 2022===
++===3.3 Installation requirements Windows Server 2022 ===
--These are the requirements to allow the installation of the eMagiz Docker agent:
--* Install latest version of Docker Desktop from  {{code}}https://www.docker.com/products/docker-desktop/{{/code}}
--* Validate if WSL 2.0 is properly installed
--* Go to the next section around installing the eMagiz Docker agent
++{{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
--===3.3 Installation requirements Windows Server 2022 (without Docker Desktop) ===
--
++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).
++
  **Step 1: Install linux distribution**
  {{code language="cmd"}}
@@ -48,29 +48,47 @@
    . /etc/os-release
  {{/code}}
++**Step 2: Configure linux system**
++Please see section 3.4 for these these steps
--**Step 2: Install Docker **
++**Step 3: Update wsl config file **
++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
++First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
++
  {{code language="cmd"}}
--  curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
--  echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
--  sudo apt update
--  sudo apt install docker-ce docker-ce-cli containerd.io
++  #Add following lines
++
++  # Settings apply across all Linux distros running on WSL 2
++  [wsl2]
++  # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
++  memory=16GB
++  # Sets the VM to use two virtual processors
++  processors=2
  {{/code}}
--{{info}}
-- Requires ~335 Mb space to install
--{{/info}}
++**Step 4: Auto start the linux subsystem when Windows server restarts **
++{{code language="cmd"}}
++* Press Windows+R
++* Type shell:startup and press enter
++* Add or update file start_wsl.bat
++* Add following line into the document and save file
++  * wsl sudo /usr/bin/dockerd
++  {{/code}}
++**Step 5: Install eMagiz Deploy Agent**
++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"]].
--**Step 3: Install Java **
++===3.4 Installation steps to configure Linux subsystem ===
++**Step 1: Install Docker **
++
  {{code language="cmd"}}
--  wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
--  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
--  sudo apt update # update if you haven't already
--  sudo apt install temurin-8-jdk
++  curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
++  echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
++  sudo apt update
++  sudo apt install docker-ce docker-ce-cli containerd.io
  {{/code}}
  {{info}}
@@ -77,44 +77,60 @@
   Requires ~335 Mb space to install
  {{/info}}
++**Step 3: Ensure Docker is autostarted with WSL **
--#Autostart Dockerd with wsl
++{{info}}
++This remark is valid for Windows based installations only
++{{/info}}
++{{code language="cmd"}}
  nano .bashrc
++  #Add following lines to bashrc
  	DOCKER_DISTRO="Ubuntu"
  	DOCKER_LOG_DIR=$HOME/docker_logs
  	mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
  	/mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
++{{/code}}
--#Do not ask password dockerd
++**Step 4: Add user to Docker group **
++
++{{code language="cmd"}}
  sudo visudo
--	%docker ALL=(ALL)  NOPASSWD: /usr/bin/dockerd
++  #Add following lines
--#Set WSL config for memory
--USERDIR/.wslconfig
--	# Settings apply across all Linux distros running on WSL 2
--	[wsl2]
++  # Don't ask for password
++  %docker ALL=(ALL)  NOPASSWD: /usr/bin/dockerd
++{{/code}}
--	# Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
--	memory=16GB
++**Step 5: Ensure safe IP range for WSL **
--	# Sets the VM to use two virtual processors
--	processors=2
++{{info}}
++This remark is valid for Windows based installations only
++{{/info}}
--(Exit WSL: wsl --shutdown)
--
++This step ensures that the IP address range of the machine doesn't conflict with any IP address of the Linux subsystem. Below the recommended values depending on the range which can be filled in the value <ip-address> below:
++* 10.0.0.1/8
++  ** advised value 10.25.0.1/16
++* 172.16.0.1/12
++  ** advised value 172.16.0.1/16
++* 192.168.0.1/16
++  ** advised value 192.168.0.1/16
--===3.4 Installation requirements Windows Server 2019 version >1806===
++{{code language="cmd"}}
++sudo nano /etc/docker/daemon.json
--These are the requirements to allow the installation of the eMagiz Docker agent:
--* Install latest version of Docker Desktop from  https://www.docker.com/products/docker-desktop/
--* Validate if WSL 2.0 is properly installed
--* Go to the next section around installing the eMagiz Docker agent
++  #Add following lines
++  {"bip": "<ip-address>"}
++{{/code}}
++
++
  ===3.5 Installation requirements Windows Server 2019 version 1806===
++{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
++
  These are the requirements to allow the installation of the eMagiz Docker agent:
  * Enable Hyper-V in Windows Server
    ** 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.
@@ -121,7 +121,10 @@
    ** Restart windows
  * Cross check is WSL 2.0 is installed
    ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
--* Install Docker Desktop on the Windows Server
++* Please follow the instructions for preparing a Windows 2022 installation in section 3.3
++
++{{info}}
++  * Install Docker Desktop on the Windows Server
    ** Please refer to this link: https://www.docker.com/products/docker-desktop/
    ** Restart windows
  * Update Docker Desktop configuration
@@ -137,17 +137,20 @@
  * Open the ubuntu terminal, and finish the installation.
    ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
  * Go to the next section around installing the eMagiz Docker agent
++{{/info}}
  ===3.6 Installation requirements Windows Server 2012 R2 ===
++{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
++
  These are the requirements to allow the installation of the eMagiz Docker agent:
  * Install & enable Hyper-V in Windows Server
    ** 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.
    ** Restart windows
  * Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
--* Create a VM in HyperV.
++* Create a VM in HyperV.
    ** 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).
--  ** Configure a virtual switch.
++  ** Configure a virtual switch.
    ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
    ** Install an operating system from bootable CD/DVD, ISO file
  * Install ubuntu downloaded previously on the VM
@@ -154,34 +154,14 @@
  * Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
  * Go to the next section around installing the eMagiz agent
--=== 3.7 eMagiz Docker agent installation ===
++== 4. Key takeaways ==
--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.
--
--[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
--
--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.
--
--== 4. Assignment ==
--
--Check out the cheatcheet for Docker command line:
--
--[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
--
--== 5. Key takeaways ==
--
  * 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
  * eMagiz has a specific agent that manages the download of that image to the on-premises server
  * 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.
++== 5. Suggested Additional Readings ==
++* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
--== 6. Suggested Additional Readings ==
--
--N/A
--
--== 7. Silent demonstration video ==
--
--N/A
--
  )))((({{toc/}}))){{/container}}{{/container}}

Changes for page Install Docker for Windows

Summary

Details

Navigation