Feature/v1.0.1 (#4)

* Updating the runtime to v5.12

* In progress

* save: checkpoint

* save: checkpoint

* save: checkpoint

* Ready for release

Author: Teodor Kostadinov

CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 1.0.1 (2021-11-24)
+
+### Improvements
+
+- [general] - Updating the ADF Runtime to v5.12.7984.1
+- [drivers] - Adding IBM DB2 ODBC Driver (v5.11.4)
+
+
 ## 1.0.0 (2021-09-21)
 
 ### Improvements

Dockerfile

@@ -2,14 +2,15 @@ FROM mcr.microsoft.com/windows/servercore:ltsc2019
 
 LABEL maintainer="Ingeii"
 
-ENV RUNTIME_DOWNLOAD_URL="https://download.microsoft.com/download/E/4/7/E4771905-1079-445B-8BF9-8A1A075D8A10/IntegrationRuntime_5.10.7918.2.msi"
+ENV RUNTIME_DOWNLOAD_URL="https://download.microsoft.com/download/E/4/7/E4771905-1079-445B-8BF9-8A1A075D8A10/IntegrationRuntime_5.12.7984.1.msi"
 
 WORKDIR "C:/adf-runtime"
 
 COPY scripts .
+COPY drivers ./drivers
 
-RUN ["powershell", "./build.ps1", "-RuntimeDownloadUrl $env:RUNTIME_DOWNLOAD_URL"]
-
+RUN ["powershell", "./install-runtime.ps1", "-RuntimeDownloadUrl $env:RUNTIME_DOWNLOAD_URL"]
+RUN ["powershell", "./install-drivers.ps1"]
 CMD ["powershell", "./entrypoint.ps1"]
 
 HEALTHCHECK --start-period=120s CMD ["powershell", "./healthcheck.ps1"]

README.md

@@ -27,6 +27,8 @@
       - [Solution](#solution)
     - [Error Code 1500](#error-code-1500)
       - [Solution](#solution-1)
+    - [Error SQLSTATE IM004, SQLAllocHandle on SQL_HANDLE_ENV](#error-sqlstate-im004-sqlallochandle-on-sql_handle_env)
+      - [Solution](#solution-2)
   - [Thanks](#thanks)
   - [Future Improvements](#future-improvements)
 
@@ -36,13 +38,14 @@ This is a working solution on how to use Azure Data Factory Self-Hosted Integrat
 
 ## Version Matrix
 
-| Image Version  | ADF Self-Hosted Runtime Version |
-| -------------- | ------------------------------- |
-| 1.0.0 (latest) | 5.10.7918.2                     |
+| Image Version  | ADF Self-Hosted Runtime Version | Bundled Drivers            |
+| -------------- | ------------------------------- | -------------------------- |
+| 1.0.0          | 5.10.7918.2                     | N/A                        |
+| 1.0.1 (latest) | 5.12.7984.1                     | IBM DB2 ODBC Driver 5.11.4 |
 
 ## Docker Hub
 
-You can find a pre-built vesion of the image in our Docker Hub account:
+You can find a pre-built version of the image in our Docker Hub account:
 
 [Ingenii Solutions](https://hub.docker.com/r/ingeniisolutions/adf-self-hosted-integration-runtime/tags)
 
@@ -60,7 +63,7 @@ Below are the environment variables the image understands.
 | AUTH_KEY                                   | No (Required)        | The [ADF authentication key](https://docs.microsoft.com/en-us/azure/data-factory/create-self-hosted-integration-runtime?tabs=data-factory#create-a-self-hosted-ir-via-ui) |
 | NODE_NAME                                  | `container hostname` | The name of the node that will be displayed in ADF.                                                                                                                       |
 | OFFLINE_NODE_AUTO_DELETION_TIME_IN_SECONDS | `601` (10 minutes)   | The number of seconds that a node has to be offline to be automatically cleaned up from ADF. (it has to be the same for all nodes in the same runtime)                    |
-| ENABLE_HA                                  | `false`              | If you are planning to use multiple containers (nodes) in a single runtime, pleasae set this to true.                                                                     |
+| ENABLE_HA                                  | `false`              | If you are planning to use multiple containers (nodes) in a single runtime, please set this to true.                                                                     |
 | HA_PORT                                    | `8060`               | The HA port used for communication between the nodes.                                                                                                                     |
 
 ## Usage
@@ -150,6 +153,19 @@ Also, if you are to have more than one node, you need to set ENABLE_HA to `true`
 
 You most likely have 4 registered nodes with the current runtime. Azure Data Factory supports only 4 registered nodes per integration runtime.
 
+### Error SQLSTATE IM004, SQLAllocHandle on SQL_HANDLE_ENV
+
+Applies to: IBM DB2 ODBC Driver Only
+
+The error is generated whenever the docker image is executed with [isolation mode](https://docs.microsoft.com/en-us/virtualization/windowscontainers/manage-containers/hyperv-container) set to `hyperv` and not `process`.  
+This typically occurs on Windows Desktop OS as that defaults to isolated: hyperv mode and Windows Server OS defaults to isolated: process mode. 
+
+#### Solution
+
+If you are going to be using IBM DB2 ODBC Driver, it is highly suggested to run the image inside Windows Server 2019 or above. [Isolation mode](https://docs.microsoft.com/en-us/virtualization/windowscontainers/manage-containers/hyperv-container) should be set to `process`.
+
+
+
 ## Thanks
 
 This repository was heavily inspired by what was already done [here](https://github.com/Azure/Azure-Data-Factory-Integration-Runtime-in-Windows-Container) by [@wxygeek](https://github.com/wxygeek)

docker-compose.dtp.yml

@@ -8,17 +8,20 @@ services:
         ENABLE_HA: "true"
         AUTH_KEY: $PRODUCTION_CONNECTION_STRING
     restart: always
+    isolation: process
 
   test:
     image: $IMAGE_REGISTRY/$IMAGE_REPOSITORY:$IMAGE_VERSION
     environment:
         ENABLE_HA: "true"
         AUTH_KEY: $TEST_CONNECTION_STRING
     restart: always
+    isolation: process
 
   dev:
     image: $IMAGE_REGISTRY/$IMAGE_REPOSITORY:$IMAGE_VERSION
     environment:
         ENABLE_HA: "true"
         AUTH_KEY: $DEV_CONNECTION_STRING
-    restart: always
+    restart: always
+    isolation: process

docker-compose.single.yml

@@ -7,4 +7,5 @@ services:
     environment:
         ENABLE_HA: "true"
         AUTH_KEY: $PRODUCTION_CONNECTION_STRING
-    restart: always
+    restart: always
+    isolation: process

drivers/README.md

@@ -0,0 +1,23 @@
+# Install Additional Drivers
+
+## Overview
+
+Each additional driver to be installed has to be created according to the directory structure and installation mechanism.
+
+## Directory Structure
+
+`<vendor>`/[`vendor sub-type`]/`<driver type>`
+
+Examples:
+
+* `ibm`/`db2`/`odbc`
+* `mariadb`/`odbc`
+* `postgresql`/`pgsql`
+
+
+## Install Script
+
+Each driver directory has an `install.ps1` script plus (if needed) additional files required for the installation. The `install.ps1` script will be called by the `install-drivers.ps1` script inside the `scripts` directory.  
+
+Please make sure to add all necessary steps to automate the installation of the additional driver inside the `install.ps1` script. It is also 
+recommended to have clean-up steps to remove setup files, zip files etc. That would help to keep the image small. 

drivers/ibm/db2/odbc/dsdriver.rsp

@@ -0,0 +1,7 @@
+PROD				= IBM_DATA_SERVER_DRIVER
+LIC_AGREEMENT       = ACCEPT
+FILE                = C:\Program Files\IBM\IBM DATA SERVER DRIVER 
+COMP				= ODBC_SUPPORT
+COPY_NAME 			= IBMDBCL
+DB2_ODBC_DSN_TYPE 	= SYSTEM
+DB2_ODBC_DSN_ACTION = ADD

drivers/ibm/db2/odbc/install.ps1

@@ -0,0 +1,40 @@
+function Write-Log() {
+    Param(
+        [string] $Message,
+        [string] $TextColor = "White"
+    )
+
+    $timeNow = Get-Date -Format "dd/MM/yyyy HH:mm:ss"
+
+    Write-Host "[$timeNow] $Message" -ForegroundColor $TextColor
+}
+
+function Install-Driver {
+    Write-Log -Message "Installing the IBM DB2 ODBC Driver..."
+
+    $setupFile = (Get-ChildItem -Path $PSScriptRoot | Where-Object { $_.Name -Match "setup.exe" })[0].Name
+    $setupFilePath = Join-Path -Path $PSScriptRoot -ChildPath $setupFile
+    
+    Write-Log -Message $setupFilePath
+
+    Start-Process $setupFilePath -Wait -ArgumentList "/n Default /u dsdriver.rsp" -WorkingDirectory $PSScriptRoot
+    if (!$?) {
+        Write-Log -Message "Installation failed."
+        exit 1
+    }
+
+    Write-Log -Message "Installaton complete."
+
+    # Clean up the driver directory
+    $setupFilePath | Remove-Item -Force
+}
+
+# Install the driver
+try {
+    Install-Driver
+}
+catch {
+    Write-Log -Message "Unable to install the driver."
+    Write-Log -Message $_
+    exit 1
+}

drivers/ibm/db2/odbc/setup.exe

@@ -0,0 +1,21 @@
+Param(
+    $Workdir = $(Get-Location)
+)
+
+Import-Module $PSScriptRoot\common.ps1
+
+Write-Log -Message "Installing additional drivers.."
+
+# Install vendor drivers
+$DriversPath = Join-Path -Path $Workdir -ChildPath "drivers"
+$InstallScriptName = "install.ps1"
+
+$DriverInstallScripts = Get-ChildItem -Path $DriversPath -Filter $InstallScriptName -Recurse
+
+# Find the install.ps1 script in each driver directory and call it.
+ForEach ($script in $DriverInstallScripts) {
+    # Call the install script in the driver folder.
+    &$script.FullName
+}
+
+Write-Log -Message "Additional drivers installed."