Move runtime ownership into druid-cli (#76)

* feat: refactor runtime for container backends

* feat: move runtime ownership to druid cli

* chore: trim unused runtime helpers

* chore: sloppy draft

* feat: add namespace support for runtime resources

- Introduced a new `namespace` field in the OpenAPI specification for runtime resources, applicable to Kubernetes backends.
- Updated the runtime supervisor and related services to handle the new namespace parameter during scroll creation and management.
- Enhanced error handling and logging in the runtime daemon for better observability.
- Refactored related tests to accommodate the namespace changes and ensure proper functionality.

* feat: enhance runtime scroll creation with UUID generation and timeout settings

- Added UUID generation for runtime scroll IDs when omitted during creation, ensuring unique identifiers.
- Implemented a timeout for HTTP clients in the OpenAPI client to improve reliability.
- Updated OpenAPI specifications and related documentation to reflect changes in ID handling.
- Refactored error handling in the runtime supervisor to manage scroll creation more effectively.
- Enhanced tests to cover new functionality and ensure robustness in scroll management.

* feat: implement worker callback configuration for runtime daemon

- Introduced a new `RuntimeWorkerCallbackConfig` structure to manage callback settings for the runtime daemon.
- Enhanced the `runRuntimeDaemon` function to load environment variables and configure worker callbacks dynamically.
- Added `openWorkerCallbackListener` function to handle TCP listener creation for worker callbacks.
- Updated the Docker backend to support worker callback defaults and URL generation after listener setup.
- Added unit tests for the new callback listener functionality and its integration with the runtime daemon.

* feat: enhance runtime command handling with routing and error management

- Added support for routing assignments in the runtime command structure, allowing for better management of network configurations.
- Introduced a new error type for non-retryable command errors, improving error handling in the queue manager and procedure launcher.
- Updated the Docker backend to utilize routing information during container creation and command execution.
- Enhanced unit tests to validate the new routing functionality and error handling improvements.

* refactor(runtime): slim daemon backends

* fix(runtime): retry incomplete materialization

* test: fix docker runtime integration checks

* test: avoid docker e2e port and cleanup conflicts

* test: make docker integration cleanup reliable

* test: fix runtime cleanup races

* test: load worker image into kind

* fix: harden runtime daemon

Author: MarcStdt

.docker/druid-install-command.sh

@@ -10,10 +10,8 @@ fi
 BASEDIR=$(dirname "$0")
 
 wget --show-progress -q -O $BASEDIR/druid https://github.com/highcard-dev/druid-cli/releases/$URL_PATH/druid
-wget --show-progress -q -O $BASEDIR/druid_rcon https://github.com/highcard-dev/druid-cli/releases/$URL_PATH/druid_rcon 
-wget --show-progress -q -O $BASEDIR/druid_rcon_web_rust https://github.com/highcard-dev/druid-cli/releases/$URL_PATH/druid_rcon_web_rust
 wget --show-progress -q -O $BASEDIR/entrypoint.sh https://github.com/highcard-dev/druid-cli/releases/$URL_PATH/entrypoint.sh 
-chmod +x $BASEDIR/druid $BASEDIR/druid_rcon $BASEDIR/druid_rcon_web_rust
+chmod +x $BASEDIR/druid
 
 # Modify the PATH variable to prioritize /app/resources
 export PATH=$BASEDIR:$PATH

.docker/entrypoint.sh

@@ -1,7 +1,6 @@
 #!/usr/bin/env bash
 
 set -e
-SD="./"
 input=$@
 
 # Global args derived from envs that apply to multiple commands
@@ -16,123 +15,24 @@ then
     global_args+=("--config=$DRUID_CONFIG")
 fi
 
-# Migrate legacy .scroll layout:
-#   Before: .scroll/<scroll files> + <serverfiles>
-#   After:  <scroll files> + data/<serverfiles>
-if [ -d "${SD}.scroll" ]; then
-    echo "Migrating legacy .scroll layout..."
-    mkdir -p "${SD}data"
-    for item in "${SD}"* "${SD}".[!.]*; do
-        [ -e "$item" ] || continue
-        name=$(basename "$item")
-        [ "$name" != "data" ] && [ "$name" != ".scroll" ] && mv "$item" "${SD}data/"
-    done
-    mv "${SD}.scroll"/* "${SD}"
-    rm -rf "${SD}.scroll"
-    echo "Legacy migration complete"
-fi
-
 echo "Druid Version: $(druid version)"
 
-if [ ! -z "${DRUID_REGISTRY_HOST}" ] && [ ! -z "${DRUID_REGISTRY_USER}" ] && [ ! -z "${DRUID_REGISTRY_PASSWORD}" ];
-then
-    echo "Logging into registry ${DRUID_REGISTRY_HOST}"
-    druid registry login --host "${DRUID_REGISTRY_HOST}" -u "${DRUID_REGISTRY_USER}" -p "${DRUID_REGISTRY_PASSWORD}"
+if [ "$1" = "druid-coldstarter" ] || [ "$1" = "/usr/bin/druid-coldstarter" ]; then
+    exec "$@"
 fi
 
-if [ "${ENSURE_NIX}" = "true" ];
+if [ ! -z "${DRUID_REGISTRY_HOST}" ] && [ ! -z "${DRUID_REGISTRY_USER}" ] && [ ! -z "${DRUID_REGISTRY_PASSWORD}" ];
 then
-    if [ ! -e "$HOME/.nix-profile" ];
-    then
-        echo "Installing Nix package manager"
-        sh <(curl --proto '=https' --tlsv1.2 -L https://nixos.org/nix/install) --no-daemon
-        echo "Nix installed"
-    fi
-    nix-channel --update
+    echo "Logging into registry ${DRUID_REGISTRY_HOST}"
+    druid login --host "${DRUID_REGISTRY_HOST}" -u "${DRUID_REGISTRY_USER}" -p "${DRUID_REGISTRY_PASSWORD}"
 fi
 
-#Check if we should serve as default or when only artifact is specified
-if [ -z "$input" ] || [[ $input =~ ([^/]+)/([^:]+):([^/]+) ]] &&  [[ $input != *" "* ]]; then    artifact="${input}"
-    if [ -z "${artifact}" ];
-    then
-        artifact=$DRUID_SCROLL_ARTIFACT
-    fi
-
-    echo "Artifact: $artifact"
-
-    #Update command
-    if [ "${DRUID_AUTO_UPDATE}" = "true" ] && [ -f "${SD}/scroll.yaml" ];
-    then
-        echo "Updating artifact"
-
-        # Build args for `druid update` so that global envs apply as well
-        update_args=(update "${global_args[@]}")
-
-        druid "${update_args[@]}"
-        echo "Updated artifact"
-    fi
-
-
-    #ignore-version-check otherwise we have missmatch after update
-    args=(serve --ignore-version-check --additional-endpoints annotations)
-
-    if [ ! -z "${artifact}" ];
-    then
-        args+=($artifact)
-    fi
-
-    # Map envs to args (--cwd = scroll dir, --config = path to .druid.yaml)
-    if [ ! -z "${DRUID_JWKS_SERVER}" ];
-    then
-        args+=("--jwks-server" "${DRUID_JWKS_SERVER}")
-    fi
-    
-    if [ ! -z "${DRUID_USER_ID}" ];
-    then
-        args+=("--user-id" "${DRUID_USER_ID}")
-    fi
-
-    if [ ! -z "${DRUID_PORT}" ];
-    then
-        args+=("--port" "${DRUID_PORT}")
-    fi
-
-    if [ ! -z "${DRUID_IDLE}" ];
-    then
-        args+=("--idle=$DRUID_IDLE")
-    fi
-    if [ ! -z "${DRUID_WATCH_PORTS}" ];
-    then
-        args+=("--watch-ports=$DRUID_WATCH_PORTS")
-    fi
-
-    if [ ! -z "${DRUID_WATCH_PORTS_INTERFACES}" ];
-    then
-        args+=("--watch-ports-interfaces" "${DRUID_WATCH_PORTS_INTERFACES}")
-    fi
-
-    if [ ! -z "${DRUID_COLDSTARTER}" ];
-    then
-        args+=("--coldstarter=$DRUID_COLDSTARTER")
-    fi
-
-    if [ ! -z "${DRUID_INIT_SNAPSHOT_URL}" ];
-    then
-        args+=("--init-snapshot-url=$DRUID_INIT_SNAPSHOT_URL")
-    fi
-
-    if [ ! -z "${DRUID_SKIP_ARTIFACT_DOWNLOAD}" ];
-    then
-        args+=("--skip-artifact-download")
-    fi
+# Daemon is the default container mode when no command is provided.
+if [ -z "$input" ]; then
+    args=(daemon)
 
     # Reuse global args (cwd/config) for serve as well
     args+=("${global_args[@]}")
-
-    if [ ! -z "${PPROF_BIND}" ];
-    then
-        args+=("--pprof=$PPROF_BIND")
-    fi
 
     echo "Running druid with args from env: ${args[@]}"
     exec druid "${args[@]}"
@@ -156,4 +56,4 @@ else
     done
 
     exec druid "${args[@]}"
-fi
+fi

.dockerignore

@@ -1,2 +1,10 @@
 examples
 __debug_bin*
+.git
+.runtime-state
+bin
+dist
+tmp
+*.db
+*.sock
+.DS_Store

.github/workflows/build.yml

@@ -9,9 +9,10 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-go@v5
         with:
-          go-version: "^1.21"
-      - run: make test-integration-docker
-        name: Run integration tests inside Docker
+          go-version: "^1.24"
+      - uses: azure/setup-kubectl@v4
+      - run: make test-integration
+        name: Run CLI backend integration tests
       - run: make test
         name: Unit tests
 
@@ -21,19 +22,16 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-go@v5
         with:
-          go-version: "^1.21"
+          go-version: "^1.24"
       - run: make build
         name: Build
-      - run: make build-plugins
-        name: Build plugins
       - uses: actions/upload-artifact@v4
         name: Upload build artifacts
         with:
           name: build-artifacts
           path: |
             bin/druid
-            bin/druid_rcon
-            bin/druid_rcon_web_rust
+            bin/druid-coldstarter
             .docker/entrypoint.sh
             .docker/druid-install-command.sh
 
@@ -57,8 +55,6 @@ jobs:
         name: Build
         env:
           VERSION: ${{ steps.version.outputs.version_tag }}
-      - run: make build-plugins
-        name: Build plugins
       - name: Release
         uses: softprops/action-gh-release@v2
         with:
@@ -67,8 +63,7 @@ jobs:
           make_latest: true
           files: |
             bin/druid
-            bin/druid_rcon
-            bin/druid_rcon_web_rust
+            bin/druid-coldstarter
             .docker/entrypoint.sh
             .docker/druid-install-command.sh
 

.github/workflows/docker-builds.yml

@@ -1,4 +1,4 @@
-# Reusable workflow: all Docker image builds (base, manifests, steamcmd, nix).
+# Reusable workflow: all Docker image builds (base, manifests, steamcmd).
 # Used by master build.yml and PR pr.yml to avoid duplication.
 name: Docker builds (reusable)
 on:
@@ -120,98 +120,3 @@ jobs:
       DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
       DRUID_ARTIFACTS_REGISTRY_USERNAME: ${{ secrets.DRUID_ARTIFACTS_REGISTRY_USERNAME }}
       DRUID_ARTIFACTS_REGISTRY_TOKEN: ${{ secrets.DRUID_ARTIFACTS_REGISTRY_TOKEN }}
-
-  docker-nix-amd64:
-    needs: [docker-base-manifest, docker-base-manifest-artifacts]
-    uses: ./.github/workflows/docker-build-reusable.yml
-    with:
-      dockerfile: Dockerfile.nix
-      runs_on: ubuntu-latest
-      tags: |
-        highcard/druid:${{ inputs.version_tag }}-nix-amd64
-        artifacts.druid.gg/druid-team/druid:${{ inputs.version_tag }}-nix-amd64
-      build_args: |
-        VERSION=${{ inputs.version_tag }}
-    secrets:
-      DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
-      DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
-      DRUID_ARTIFACTS_REGISTRY_USERNAME: ${{ secrets.DRUID_ARTIFACTS_REGISTRY_USERNAME }}
-      DRUID_ARTIFACTS_REGISTRY_TOKEN: ${{ secrets.DRUID_ARTIFACTS_REGISTRY_TOKEN }}
-
-  docker-nix-arm64:
-    needs: [docker-base-manifest, docker-base-manifest-artifacts]
-    uses: ./.github/workflows/docker-build-reusable.yml
-    with:
-      dockerfile: Dockerfile.nix
-      runs_on: ubuntu-24.04-arm
-      tags: |
-        highcard/druid:${{ inputs.version_tag }}-nix-arm64
-        artifacts.druid.gg/druid-team/druid:${{ inputs.version_tag }}-nix-arm64
-      build_args: |
-        VERSION=${{ inputs.version_tag }}
-    secrets:
-      DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
-      DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
-      DRUID_ARTIFACTS_REGISTRY_USERNAME: ${{ secrets.DRUID_ARTIFACTS_REGISTRY_USERNAME }}
-      DRUID_ARTIFACTS_REGISTRY_TOKEN: ${{ secrets.DRUID_ARTIFACTS_REGISTRY_TOKEN }}
-
-  docker-nix-steamcmd:
-    needs: [docker-steamcmd]
-    uses: ./.github/workflows/docker-build-reusable.yml
-    with:
-      dockerfile: Dockerfile.nix
-      tags: |
-        highcard/druid:${{ inputs.version_tag }}-nix-steamcmd
-        artifacts.druid.gg/druid-team/druid:${{ inputs.version_tag }}-nix-steamcmd
-        ${{ inputs.is_pr != true && format('highcard/druid:latest-nix-steamcmd') || '' }}
-        ${{ inputs.is_pr != true && format('highcard/druid:stable-nix-steamcmd') || '' }}
-        ${{ inputs.is_pr != true && format('highcard/druid:{0}-nix-steamcmd', inputs.version) || '' }}
-        ${{ inputs.is_pr != true && format('artifacts.druid.gg/druid-team/druid:latest-nix-steamcmd') || '' }}
-        ${{ inputs.is_pr != true && format('artifacts.druid.gg/druid-team/druid:stable-nix-steamcmd') || '' }}
-        ${{ inputs.is_pr != true && format('artifacts.druid.gg/druid-team/druid:{0}-nix-steamcmd', inputs.version) || '' }}
-      build_args: |
-        VERSION=${{ inputs.version_tag }}-steamcmd
-    secrets:
-      DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
-      DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
-      DRUID_ARTIFACTS_REGISTRY_USERNAME: ${{ secrets.DRUID_ARTIFACTS_REGISTRY_USERNAME }}
-      DRUID_ARTIFACTS_REGISTRY_TOKEN: ${{ secrets.DRUID_ARTIFACTS_REGISTRY_TOKEN }}
-
-  docker-nix-manifest:
-    name: Create multi-arch nix manifests
-    needs: [docker-nix-amd64, docker-nix-arm64]
-    runs-on: ubuntu-latest
-    steps:
-      - name: Login to Docker Hub
-        uses: docker/login-action@v3
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-      - name: Create and push nix manifests
-        uses: Noelware/docker-manifest-action@v1
-        with:
-          inputs: highcard/druid:${{ inputs.version_tag }}-nix-amd64,highcard/druid:${{ inputs.version_tag }}-nix-arm64
-          tags: >-
-            highcard/druid:${{ inputs.version }}-nix,
-            highcard/druid:${{ inputs.version_tag }}-nix${{ inputs.is_pr != true && ',highcard/druid:latest-nix,highcard/druid:stable-nix' || '' }}
-          push: true
-
-  docker-nix-manifest-artifacts:
-    name: Create multi-arch nix manifests (artifacts registry)
-    needs: [docker-nix-amd64, docker-nix-arm64]
-    runs-on: ubuntu-latest
-    steps:
-      - name: Login to Artifacts Registry
-        uses: docker/login-action@v3
-        with:
-          registry: artifacts.druid.gg
-          username: ${{ secrets.DRUID_ARTIFACTS_REGISTRY_USERNAME }}
-          password: ${{ secrets.DRUID_ARTIFACTS_REGISTRY_TOKEN }}
-      - name: Create and push nix manifests (artifacts)
-        uses: Noelware/docker-manifest-action@v1
-        with:
-          inputs: artifacts.druid.gg/druid-team/druid:${{ inputs.version_tag }}-nix-amd64,artifacts.druid.gg/druid-team/druid:${{ inputs.version_tag }}-nix-arm64
-          tags: >-
-            artifacts.druid.gg/druid-team/druid:${{ inputs.version }}-nix,
-            artifacts.druid.gg/druid-team/druid:${{ inputs.version_tag }}-nix${{ inputs.is_pr != true && ',artifacts.druid.gg/druid-team/druid:latest-nix,artifacts.druid.gg/druid-team/druid:stable-nix' || '' }}
-          push: true

.github/workflows/pr.yml

@@ -20,8 +20,9 @@ jobs:
       - uses: actions/setup-go@v5
         with:
           go-version: "^1.24"
-      - run: make test-integration-docker
-        name: Run integration tests inside Docker
+      - uses: azure/setup-kubectl@v4
+      - run: make test-integration
+        name: Run CLI backend integration tests
 
   validate-api:
     runs-on: ubuntu-latest
@@ -42,15 +43,12 @@ jobs:
           go-version: "^1.24"
       - run: make build
         name: Build
-      - run: make build-plugins
-        name: Build Plugins
       - uses: actions/upload-artifact@v4
         with:
           name: build-artifacts
           path: |
             bin/druid
-            bin/druid_rcon
-            bin/druid_rcon_web_rust
+            bin/druid-coldstarter
             .docker/entrypoint.sh
             .docker/druid-install-command.sh
 
@@ -76,8 +74,7 @@ jobs:
           prerelease: true
           files: |
             bin/druid
-            bin/druid_rcon
-            bin/druid_rcon_web_rust
+            bin/druid-coldstarter
             .docker/entrypoint.sh
             .docker/druid-install-command.sh
 

.gitignore

@@ -4,6 +4,10 @@
 *.tar.gz
 
 druid**
+!apps/
+!apps/**
+!config/
+!config/**
 dlv.log
 
 .DS_Store
@@ -15,4 +19,5 @@ druid-cli-test
 
 !.docker/**
 
-.env
+.env
+.runtime-state