Skip to content

Commit 800adf0

Browse files
authored
Merge pull request #203992 from johndowns/patch-1
Update Data Factory self-hosted integration runtime documentation - Add link to App Service sample
2 parents 6c36ebf + a2d2d1e commit 800adf0

File tree

1 file changed

+50
-29
lines changed

1 file changed

+50
-29
lines changed

articles/data-factory/how-to-run-self-hosted-integration-runtime-in-windows-container.md

Lines changed: 50 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,51 +8,72 @@ ms.service: data-factory
88
ms.subservice: integration-runtime
99
ms.topic: conceptual
1010
ms.custom: seo-lt-2019
11-
ms.date: 01/28/2022
11+
ms.date: 07/07/2022
1212
---
1313

1414
# How to run Self-Hosted Integration Runtime in Windows container
1515

1616
[!INCLUDE[appliesto-adf-asa-md](includes/appliesto-adf-asa-md.md)]
1717

18-
This article will explain how to run Self-Hosted Integration Runtime in Windows container.
19-
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.
18+
Azure Data Factory provides Windows container support for the Self-Hosted Integration Runtime. You can [download the Docker Build source code](https://github.com/Azure/Azure-Data-Factory-Integration-Runtime-in-Windows-Container) and combine the building and running process in your own continuous delivery pipeline.
19+
20+
> [!TIP]
21+
> This article explains how to run the Self-Hosted Integration Runtime in a Windows container on a compatible physical or virtual machine. If you don't want to manage infrastructure, you can run the Self-Hosted Integration Runtime on Azure App Service. For more information, see the [Azure Data Factory self-hosted integration runtime on App Service](https://github.com/Azure-Samples/azure-data-factory-runtime-app-service) sample.
2022
2123
## Prerequisites
24+
2225
- [Windows container requirements](/virtualization/windowscontainers/deploy-containers/system-requirements)
23-
- Docker Version 2.3 and later
24-
- Self-Hosted Integration Runtime Version 5.2.7713.1 and later
26+
- Docker version 2.3 or later
27+
- Self-Hosted Integration Runtime Version 5.2.7713.1 or later
28+
2529
## Get started
26-
1. Install Docker and enable Windows Container
27-
2. Download the source code from https://github.com/Azure/Azure-Data-Factory-Integration-Runtime-in-Windows-Container
28-
3. Download the latest version SHIR in ‘SHIR’ folder
29-
4. Open your folder in the shell:
30-
```console
31-
cd "yourFolderPath"
32-
```
33-
34-
5. Build the windows docker image:
35-
```console
36-
docker build . -t "yourDockerImageName" 
37-
```
38-
6. Run docker container:
39-
```console
40-
docker run -d -e NODE_NAME="irNodeName" -e AUTH_KEY="IR_AUTHENTICATION_KEY" -e ENABLE_HA=true -e HA_PORT=8060 "yourDockerImageName"   
41-
```
42-
> [!NOTE]
43-
> 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.
44-
45-
## Container health check
46-
After 120 seconds startup period, the health checker will run periodically every 30 seconds. It will provide the IR health status to container engine.
30+
31+
1. [Install Docker and enable Windows containers.](/virtualization/windowscontainers/quick-start/set-up-environment)
32+
33+
1. [Download the container image source code from GitHub.](https://github.com/Azure/Azure-Data-Factory-Integration-Runtime-in-Windows-Container)
34+
35+
1. If you need to use a specific version of the SHIR, you can download it and move it to the *SHIR* folder.
36+
37+
Otherwise, skip this step. The container image build process will download the latest version of the SHIR automatically.
38+
39+
1. Open your folder in the shell:
40+
41+
```console
42+
cd "yourFolderPath"
43+
```
44+
45+
1. Build the Windows container image:
46+
47+
```console
48+
docker build . -t "yourDockerImageName" 
49+
```
50+
51+
1. Run the Docker container:
52+
53+
```console
54+
docker run -d -e NODE_NAME="irNodeName" -e AUTH_KEY="IR_AUTHENTICATION_KEY" -e ENABLE_HA=true -e HA_PORT=8060 "yourDockerImageName"   
55+
```
56+
57+
> [!NOTE]
58+
> The `AUTH_KEY` environment variable is mandatory and must be set to the auth key value for your data factory.
59+
>
60+
> The `NODE_NAME`, `ENABLE_HA` and `HA_PORT` environment variables are optional. If you don't set their values, the command will use default values. The default value of `ENABLE_HA` is `false`, and the default value of `HA_PORT` is `8060`.
61+
62+
## Container health check
63+
64+
After the 120 second startup period, the health check runs periodically every 30 seconds. It provides the SHIR's health status to the container engine.
4765

4866
## Limitations
49-
Currently we don't support below features when running Self-Hosted Integration Runtime in Windows container:
67+
68+
Currently we don't support the below features when running the Self-Hosted Integration Runtime in Windows containers:
69+
5070
- HTTP proxy
51-
- Encrypted Node-node communication with TLS/SSL certificate
71+
- Encrypted node-node communication with TLS/SSL certificate
5272
- Generate and import backup
5373
- Daemon service
54-
- Auto update
74+
- Auto-update
5575

5676
### Next steps
77+
5778
- Review [integration runtime concepts in Azure Data Factory](./concepts-integration-runtime.md).
5879
- Learn how to [create a self-hosted integration runtime in the Azure portal](./create-self-hosted-integration-runtime.md).

0 commit comments

Comments
 (0)