Install Docker for Windows
In eMagiz's current runtime architecture, Docker technology is utilized to deploy runtimes efficiently. eMagiz provides specific runtime images that can be deployed within dockerized environments. This section outlines the steps needed to prepare a Windows server for the installation of the eMagiz Deploy Agent, which is responsible for downloading these images from the eMagiz infrastructure.
Should you have any questions, please contact academy@emagiz.com.
1. Prerequisites
- Advanced knowledge of the eMagiz platform
- Good understanding of eMagiz runtimes in general
2. Key concepts
In the current 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 Windows variant is 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
3.2 Installation Windows
When Windows is selected as the operating system, you need Windows Server 2022. Older Windows servers are not supported.
3.2.1 Docker Installation
To install Docker on your machine, execute the following commands in PowerShell with administrative rights:
.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
3.2.2 Customization
After installing Docker, you can stick with the standard configuration or adjust specific settings. Settings that can be of particular interest include the one that defines the IP address range your Docker installation will use to run containers, and the one that defines where to store data (i.e., containers and images). To check the full list of compatible configuration options for Windows, you can check: Configure Docker in Windows.
3.2.2.1 IP address range
Below is the code needed to configure a different IP address range.
#Add the following lines
{"fixed-cidr": "<ip-address>"}
3.2.2.2 Data location
Below is an example of switching from the default C directory (c:\programdata\docker) to the D directory to store Docker data. Based on your internal configuration, you can choose the best suitable variant if needed. To do so, you can add the following attribute to the Docker daemon file:
#Add the following lines
{
"data-root": "d:\\docker"
}
3.2.3 Check installation
After executing the commands above, the server will restart if required. After the restart, execute the following command
If the command returns "command not found," please run the following command again.
3.2.3 Verify Docker functionality
Execute the following command
The result of this call should show the following:
3.2.4 Install eMagiz Deploy Agent
Install the eMagiz Deploy agent as described in this microlearning
3.3 Update Docker
When you are advised to update your Docker version, you can verify whether you are on the correct Docker version by executing the following command in PowerShell with administrative rights:
When this returns a version lower than the advised version shown under the "General requirements" section, you can update Docker on your machine. To do so, execute the following command in PowerShell with administrative rights:
3.4 Uninstall Docker
To uninstall Docker from your machine, execute the following commands in PowerShell with administrative rights:
Example usage:
4. Key takeaways
- eMagiz uses runtime images to deploy the 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 restrictions. If that is not desirable, eMagiz can provide the addresses and ports needed to set up the appropriate firewall rules.
