How to run Self-Hosted Integration Runtime in Windows container

APPLIES TO: Azure Data Factory Azure Synapse Analytics

This article will explain how to run Self-Hosted Integration Runtime in Windows container. Azure Data Factory are delivering the official windows container support of Self-Hosted Integration Runtime. You can download the docker build source code and combine the building and running process in your own continuous delivery pipeline.

Prerequisites

Get started

  1. Install Docker and enable Windows Container
  2. Download the source code from https://github.com/Azure/Azure-Data-Factory-Integration-Runtime-in-Windows-Container
  3. Download the latest version SHIR in ‘SHIR’ folder
  4. Open your folder in the shell:
cd "yourFolderPath"
  1. Build the windows docker image:
docker build . -t "yourDockerImageName" 
  1. Run docker container:
docker run -d -e NODE_NAME="irNodeName" -e AUTH_KEY="IR_AUTHENTICATION_KEY" -e ENABLE_HA=true -e HA_PORT=8060 "yourDockerImageName"    

Note

AUTH_KEY is mandatory for this command. NODE_NAME, ENABLE_HA and HA_PORT are optional. If you don't set the value, the command will use default values. The default value of ENABLE_HA is false and HA_PORT is 8060.

Container health check

After 120 seconds startup period, the health checker will run periodically every 30 seconds. It will provide the IR health status to container engine.

Limitations

Currently we don't support below features when running Self-Hosted Integration Runtime in Windows container:

  • HTTP proxy
  • Encrypted Node-node communication with TLS/SSL certificate
  • Generate and import backup
  • Daemon service
  • Auto update

Next steps