Merge pull request #187 from AzureCosmosDB/copilot/fix-148

Add Docker container support for CI/CD pipelines

Author: philnach

.dockerignore

@@ -0,0 +1,42 @@
+# Git files
+.git
+.gitignore
+.gitattributes
+
+# Build results
+[Bb]in/
+[Oo]bj/
+[Dd]ebug/
+[Rr]elease/
+x64/
+x86/
+build/
+bld/
+[Ll]og/
+
+# User-specific files
+*.user
+*.userosscache
+*.suo
+*.userprefs
+*.vs
+
+# Test results
+TestResults/
+coverage/
+
+# Docker files (for clean recursive builds)
+Dockerfile
+.dockerignore
+
+# NuGet packages
+*.nupkg
+*.snupkg
+**/packages/*
+!**/packages/build/
+
+# Temp files
+.DS_Store
+Thumbs.db
+*.tmp
+*~

.github/workflows/docker-publish.yml

@@ -0,0 +1,54 @@
+name: Build and Publish Docker Image
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: 'Docker tag (default: latest)'
+        required: false
+        default: 'latest'
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: ghcr.io/${{ github.repository }}
+          tags: |
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            ${{ github.event.inputs.tag || 'latest' }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

Dockerfile

@@ -0,0 +1,42 @@
+# Build stage
+FROM mcr.microsoft.com/dotnet/sdk:8.0 AS build
+WORKDIR /src
+
+# Copy solution file and project files
+COPY ["CosmosDbDataMigrationTool.sln", "."]
+COPY ["Directory.Packages.props", "."]
+COPY ["Core/", "Core/"]
+COPY ["Interfaces/", "Interfaces/"]
+COPY ["Extensions/", "Extensions/"]
+
+# Restore dependencies
+# Increase the timeout and number of retries for NuGet
+RUN dotnet nuget list source | grep -q 'nuget.org' || dotnet nuget add source https://api.nuget.org/v3/index.json --name nuget.org
+ENV NUGET_PACKAGES=/nuget-packages
+ENV NUGET_HTTP_CACHE_PATH=/nuget-http-cache
+RUN mkdir -p /nuget-packages /nuget-http-cache
+
+# Restore and build the main project and the core project
+RUN dotnet restore "Core/Cosmos.DataTransfer.Core/Cosmos.DataTransfer.Core.csproj" --disable-parallel
+RUN dotnet build "Core/Cosmos.DataTransfer.Core/Cosmos.DataTransfer.Core.csproj" -c Release -o /app/build/Core --no-restore
+RUN dotnet publish "Core/Cosmos.DataTransfer.Core/Cosmos.DataTransfer.Core.csproj" -c Release -o /app/publish/Core --no-restore
+
+# Build and publish ALL extensions
+RUN find Extensions -name "*.csproj" | grep -v "UnitTests" | xargs -I {} sh -c 'dotnet publish "{}" -c Release -o /app/publish/Core/Extensions || echo "Skipping $(basename $(dirname {}))"'
+
+# Runtime stage
+FROM mcr.microsoft.com/dotnet/runtime:8.0 AS runtime
+WORKDIR /app
+
+# Copy published files from build stage
+COPY --from=build /app/publish/Core ./
+
+# Create volumes for configuration and data
+VOLUME /config
+VOLUME /data
+
+# Optional volume for custom extensions
+VOLUME /extensions
+
+# Set the entrypoint
+ENTRYPOINT ["dotnet", "dmt.dll"]

README.md

@@ -26,7 +26,56 @@ The Azure Cosmos DB Desktop Data Migration Tool is an open-source project contai
 
 ## Quick Installation
 
-To use the tool, download the latest archive file for your platform (win-x64, win-arm64, mac-x64, mac-arm64, linux-x64, linux-arm64) from [Releases](https://github.com/AzureCosmosDB/data-migration-desktop-tool/releases) and extract all files to your desired install location. To begin a data transfer operation, first populate the `migrationsettings.json` file with appropriate settings for your data source and sink (see [detailed instructions](#using-the-command-line) below or [review examples](ExampleConfigs.md)), and then run the application from a command line: `dmt.exe` on Windows or `dmt` on other platforms. 
+To use the tool, download the latest archive file for your platform (win-x64, win-arm64, mac-x64, mac-arm64, linux-x64, linux-arm64) from [Releases](https://github.com/AzureCosmosDB/data-migration-desktop-tool/releases) and extract all files to your desired install location. To begin a data transfer operation, first populate the `migrationsettings.json` file with appropriate settings for your data source and sink (see [detailed instructions](#using-the-command-line) below or [review examples](ExampleConfigs.md)), and then run the application from a command line: `dmt.exe` on Windows or `dmt` on other platforms.
+
+## Docker Container
+
+You can also run the Data Migration Tool as a Docker container, which is useful for CI/CD pipelines or environments where installing the tool directly isn't preferred.
+
+### Using Pre-built Docker Image
+
+The easiest way to use the container is to pull the pre-built image from GitHub Container Registry:
+
+```bash
+docker pull ghcr.io/azurecosmosdb/data-migration-desktop-tool:latest
+docker run -v $(pwd)/config:/config -v $(pwd)/data:/data ghcr.io/azurecosmosdb/data-migration-desktop-tool:latest run --settings /config/migrationsettings.json
+```
+
+### Building the Docker Image Locally
+
+To build the Docker image locally:
+
+```bash
+docker build -t data-migration-tool .
+```
+
+### Running the Container
+
+Run the container with your configuration files mounted:
+
+```bash
+docker run -v $(pwd)/config:/config -v $(pwd)/data:/data data-migration-tool run --settings /config/migrationsettings.json
+```
+
+Where:
+- `/config` contains your configuration files including `migrationsettings.json`
+- `/data` is the directory for your data files
+
+You can also mount custom extensions:
+
+```bash
+docker run -v $(pwd)/config:/config -v $(pwd)/data:/data -v $(pwd)/extensions:/extensions data-migration-tool run --source customsource --sink customsink --settings /config/migrationsettings.json
+```
+
+### Docker Compose Example
+
+A `docker-compose.yml` file is provided as an example:
+
+```bash
+docker-compose up
+```
+
+This will build the image and run the container with the mounted volumes. You can modify the `docker-compose.yml` file to customize the command and volumes.
 
 ### Special Extensions
 

config/.gitignore

@@ -0,0 +1,4 @@
+# Ignore all files in this directory
+*
+# Except this file
+!.gitignore

data/.gitignore

@@ -0,0 +1,6 @@
+# Ignore all files in this directory
+*
+# Except this file
+!.gitignore
+# And except the sample file
+!sample-data.json

data/sample-data.json

@@ -0,0 +1,12 @@
+[
+  {
+    "id": "1",
+    "name": "Sample Item 1",
+    "description": "This is a sample item for testing the data migration tool"
+  },
+  {
+    "id": "2",
+    "name": "Sample Item 2",
+    "description": "This is another sample item"
+  }
+]

docker-compose.yml

@@ -0,0 +1,20 @@
+version: '3'
+
+services:
+  data-migration-tool:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    volumes:
+      # Mount configuration files from the host
+      - ./config:/config
+      # Mount data files for import/export
+      - ./data:/data
+    # Example command (customize based on your needs)
+    # The default entrypoint is "dotnet dmt.dll"
+    command: run --settings /config/migrationsettings.json
+    # Uncomment these environment variables to use RBAC authentication
+    # environment:
+    #   - AZURE_TENANT_ID=your-tenant-id
+    #   - AZURE_CLIENT_ID=your-client-id
+    #   - AZURE_CLIENT_SECRET=your-client-secret