Upgrade to AppWrapper v1beta2

1. Upgrade AppWrapper from v1beta1 to v1beta2
2. Remove MCADv1 controller
3. Add AppWrapper controller
4. Remove InstaScale controller
5. Update build, test, and CI accordingly
6. Adjust Dockerfile because go-toolset:1.21 doesn't exist

.github/workflows/e2e_tests.yaml

@@ -45,7 +45,7 @@ jobs:
       - name: Set Go
         uses: actions/setup-go@v5
         with:
-          go-version: v1.20
+          go-version-file: './go.mod'
 
       - name: Set up gotestfmt
         uses: gotesttools/gotestfmt-action@v2

.github/workflows/mnist-job-test-image.yml

@@ -19,7 +19,7 @@ jobs:
     - name: Set Go
       uses: actions/setup-go@v5
       with:
-        go-version: v1.20
+        go-version-file: './go.mod'
 
     - name: Login to Quay.io
       id: podman-login-quay

.github/workflows/olm_tests.yaml

@@ -44,7 +44,7 @@ jobs:
       - name: Set Go
         uses: actions/setup-go@v5
         with:
-          go-version: v1.20
+          go-version-file: './go.mod'
 
       - name: Set up gotestfmt
         uses: gotesttools/gotestfmt-action@v2

.github/workflows/operator-image.yml

@@ -22,7 +22,7 @@ jobs:
     - name: Set Go
       uses: actions/setup-go@v5
       with:
-        go-version: v1.20
+        go-version-file: './go.mod'
 
     - name: Login to Quay.io
       id: podman-login-quay

.github/workflows/precommit.yml

@@ -11,28 +11,38 @@ on:
 jobs:
   precommit:
     runs-on: ubuntu-latest
-    container:
-      image: quay.io/opendatahub/pre-commit-go-toolchain:v0.2  # https://github.com/opendatahub-io/data-science-pipelines-operator/blob/main/.github
-      env:
-        XDG_CACHE_HOME: /cache
-        GOCACHE: /cache/go-build
-        GOMODCACHE: /cache/go-mod
-        PRE_COMMIT_HOME: /cache/pre-commit
-      volumes:
-        - /cache
+    # DISABLED: This container has go 1.20
+    # container:
+    #   image: quay.io/opendatahub/pre-commit-go-toolchain:v0.2  # https://github.com/opendatahub-io/data-science-pipelines-operator/blob/main/.github
+    #   env:
+    #     XDG_CACHE_HOME: /cache
+    #     GOCACHE: /cache/go-build
+    #     GOMODCACHE: /cache/go-mod
+    #     PRE_COMMIT_HOME: /cache/pre-commit
+    #   volumes:
+    #     - /cache
     steps:
       - uses: actions/checkout@v4
 
       - name: Set Go
         uses: actions/setup-go@v5
         with:
-          go-version: v1.20
+          go-version-file: './go.mod'
 
-      - name: Activate cache
-        uses: actions/cache@v4
+      # Compensate for lack of pre-commit-go-toolchain image
+      - name: Set up Python
+        uses: actions/setup-python@v5
         with:
-          path: /cache
-          key: ${{ runner.os }}-cache-${{ hashFiles('**/go.sum', '.pre-commit-config.yaml') }}
+          python-version: '3.9'
+      - name: Install pre-commit
+        run: |
+          pip install pre-commit
+
+      # - name: Activate cache
+      #   uses: actions/cache@v4
+      #   with:
+      #     path: /cache
+      #     key: ${{ runner.os }}-cache-${{ hashFiles('**/go.sum', '.pre-commit-config.yaml') }}
 
       - name: Run pre-commit checks
         run: pre-commit run --all-files

.github/workflows/project-codeflare-release.yml

@@ -10,15 +10,12 @@ on:
       replaces:
         description: 'The previous operator semantic version that this release replaces (for example: v0.0.0)'
         required: true
-      mcad-version:
-        description: 'Version of multi-cluster-app-dispatcher to be released (for example: v0.0.0)'
+      appwrapper-version:
+        description: 'Version of appwrapper to be released (for example: v0.0.0)'
         required: true
       codeflare-sdk-version:
         description: 'Version of CodeFlare-SDK to be released (for example: v0.0.0)'
         required: true
-      instascale-version:
-        description: 'Version of InstaScale to be released (for example: v0.0.0)'
-        required: true
       kuberay-version:
         description: 'Tested version of KubeRay (for example: v0.0.0)'
         required: true
@@ -48,78 +45,46 @@ jobs:
         echo "Below are the release parameters set for the workflow:"
         echo "Operator Version: ${{ github.event.inputs.operator-version }}"
         echo "Replaces: ${{ github.event.inputs.replaces }}"
-        echo "MCAD Version: ${{ github.event.inputs.mcad-version }}"
+        echo "AppWrapper Version: ${{ github.event.inputs.appwrapper-version }}"
         echo "CodeFlare SDK Version: ${{ github.event.inputs.codeflare-sdk-version }}"
-        echo "InstaScale Version: ${{ github.event.inputs.instascale-version }}"
         echo "Tested KubeRay Version: ${{ github.event.inputs.kuberay-version }}"
         echo "Is Stable: ${{ github.event.inputs.is-stable }}"
         echo "CodeFlare Repository Organization: ${{ github.event.inputs.codeflare-repository-organization }}"
         echo "Quay Organization: ${{ github.event.inputs.quay-organization }}"
         echo "Community Operators Prod Organization: ${{ github.event.inputs.community-operators-prod-organization }}"
 
-  release-mcad:
+  release-appwrapper:
     needs: check-kuberay-version
     runs-on: ubuntu-latest
 
     steps:
-    - name: Check if MCAD release does exist
+    - name: Check if AppWrapper release does exist
       run: |
-        status_code=$(curl -s -o /dev/null -w "%{http_code}" https://github.com/project-codeflare/multi-cluster-app-dispatcher/releases/tag/${{ github.event.inputs.mcad-version }})
+        status_code=$(curl -s -o /dev/null -w "%{http_code}" https://github.com/project-codeflare/appwrapper/releases/tag/${{ github.event.inputs.appwrapper-version }})
         if [[ "$status_code" == "200" ]]; then
-          echo "MCAD release with version ${{ github.event.inputs.mcad-version }} already exist. Will not create MCAD release."
+          echo "AppWrapper release with version ${{ github.event.inputs.appwrapper-version }} already exist. Will not create AppWrapper release."
         fi
-        echo "MCAD_RELEASE_STATUS_CODE=$status_code" >> $GITHUB_ENV
+        echo "APPWRAPPER_RELEASE_STATUS_CODE=$status_code" >> $GITHUB_ENV
 
-    - name: Release MCAD
+    - name: Release AppWrapper
       run: |
-        gh workflow run mcad-release.yml --repo ${{ github.event.inputs.codeflare-repository-organization }}/multi-cluster-app-dispatcher --ref go-1.20 --field tag=${{ github.event.inputs.mcad-version }}
+        gh workflow run release.yml --repo ${{ github.event.inputs.codeflare-repository-organization }}/appwrapper --field tag=${{ github.event.inputs.appwrapper-version }}
       env:
         GITHUB_TOKEN: ${{ secrets.CODEFLARE_MACHINE_ACCOUNT_TOKEN }}
       shell: bash
-      if: ${{ env.MCAD_RELEASE_STATUS_CODE != '200' }}
+      if: ${{ env.APPWRAPPER_RELEASE_STATUS_CODE != '200' }}
 
-    - name: Wait for MCAD run to finish
+    - name: Wait for AppWrapper run to finish
       run: |
         # wait for a while for Run to be started
         sleep 5
-        run_id=$(gh run list --workflow mcad-release.yml --repo ${{ github.event.inputs.codeflare-repository-organization }}/multi-cluster-app-dispatcher --limit 1 --json databaseId --jq .[].databaseId)
-        gh run watch ${run_id} --repo ${{ github.event.inputs.codeflare-repository-organization }}/multi-cluster-app-dispatcher --interval 10 --exit-status
+        run_id=$(gh run list --workflow release.yml --repo ${{ github.event.inputs.codeflare-repository-organization }}/appwrapper --limit 1 --json databaseId --jq .[].databaseId)
+        gh run watch ${run_id} --repo ${{ github.event.inputs.codeflare-repository-organization }}/appwrapper --interval 10 --exit-status
       env:
         GITHUB_TOKEN: ${{ secrets.CODEFLARE_MACHINE_ACCOUNT_TOKEN }}
       shell: bash
-      if: ${{ env.MCAD_RELEASE_STATUS_CODE != '200' }}
-
-  release-instascale:
-    needs: release-mcad
-    runs-on: ubuntu-latest
-
-    steps:
-    - name: Check if Instascale release does exist
-      run: |
-        status_code=$(curl -s -o /dev/null -w "%{http_code}" https://github.com/project-codeflare/instascale/releases/tag/${{ github.event.inputs.instascale-version }})
-        if [[ "$status_code" == "200" ]]; then
-          echo "Instascale release with version ${{ github.event.inputs.instascale-version }} already exist. Will not create Instascale release."
-        fi
-        echo "INSTASCALE_RELEASE_STATUS_CODE=$status_code" >> $GITHUB_ENV
+      if: ${{ env.APPWRAPPER_RELEASE_STATUS_CODE != '200' }}
 
-    - name: Release InstaScale
-      run: |
-        gh workflow run instascale-release.yml --repo ${{ github.event.inputs.codeflare-repository-organization }}/instascale --ref ${{ github.ref }} --field tag=${{ github.event.inputs.instascale-version }} --field mcad-version=${{ github.event.inputs.mcad-version }}
-      env:
-        GITHUB_TOKEN: ${{ secrets.CODEFLARE_MACHINE_ACCOUNT_TOKEN }}
-      shell: bash
-      if: ${{ env.INSTASCALE_RELEASE_STATUS_CODE != '200' }}
-
-    - name: Wait for InstaScale run to finish
-      run: |
-        # wait for a while for Run to be started
-        sleep 5
-        run_id=$(gh run list --workflow instascale-release.yml --repo ${{ github.event.inputs.codeflare-repository-organization }}/instascale --limit 1 --json databaseId --jq .[].databaseId)
-        gh run watch ${run_id} --repo ${{ github.event.inputs.codeflare-repository-organization }}/instascale --interval 10 --exit-status
-      env:
-        GITHUB_TOKEN: ${{ secrets.CODEFLARE_MACHINE_ACCOUNT_TOKEN }}
-      shell: bash
-      if: ${{ env.INSTASCALE_RELEASE_STATUS_CODE != '200' }}
 
   release-codeflare-sdk:
     needs: check-kuberay-version
@@ -156,13 +121,13 @@ jobs:
       if: ${{ env.SDK_RELEASE_STATUS_CODE != '200' }}
 
   release-codeflare-operator:
-    needs: [release-mcad, release-instascale, release-codeflare-sdk]
+    needs: [release-appwrapper, release-codeflare-sdk]
     runs-on: ubuntu-latest
 
     steps:
     - name: Release CodeFlare operator
       run: |
-        gh workflow run tag-and-build.yml --repo ${{ github.event.inputs.codeflare-repository-organization }}/codeflare-operator --ref ${{ github.ref }} --field is-stable=${{ github.event.inputs.is-stable }} --field version=${{ github.event.inputs.operator-version }} --field replaces=${{ github.event.inputs.replaces }} --field mcad-version=${{ github.event.inputs.mcad-version }} --field codeflare-sdk-version=${{ github.event.inputs.codeflare-sdk-version }} --field instascale-version=${{ github.event.inputs.instascale-version }} --field kuberay-version=${{ github.event.inputs.kuberay-version }} --field quay-organization=${{ github.event.inputs.quay-organization }} --field community-operators-prod-fork-organization=${{ github.event.inputs.codeflare-repository-organization }} --field community-operators-prod-organization=${{ github.event.inputs.community-operators-prod-organization }}
+        gh workflow run tag-and-build.yml --repo ${{ github.event.inputs.codeflare-repository-organization }}/codeflare-operator --ref ${{ github.ref }} --field is-stable=${{ github.event.inputs.is-stable }} --field version=${{ github.event.inputs.operator-version }} --field replaces=${{ github.event.inputs.replaces }} --field appwrapper-version=${{ github.event.inputs.appwrapper-version }} --field codeflare-sdk-version=${{ github.event.inputs.codeflare-sdk-version }} --field kuberay-version=${{ github.event.inputs.kuberay-version }} --field quay-organization=${{ github.event.inputs.quay-organization }} --field community-operators-prod-fork-organization=${{ github.event.inputs.codeflare-repository-organization }} --field community-operators-prod-organization=${{ github.event.inputs.community-operators-prod-organization }}
       env:
         GITHUB_TOKEN: ${{ secrets.CODEFLARE_MACHINE_ACCOUNT_TOKEN }}
       shell: bash

.github/workflows/tag-and-build.yml

@@ -12,18 +12,14 @@ on:
         description: 'The previous semantic version that this tag replaces.'
         required: true
         default: 'v0.0.0-dev'
-      mcad-version:
-        description: 'Published version of multi-cluster-app-dispatcher'
+      appwrapper-version:
+        description: 'Published version of appwrapper'
         required: true
         default: 'v0.0.0-dev'
       codeflare-sdk-version:
         description: 'Published version of CodeFlare-SDK'
         required: true
         default: 'v0.0.0-dev'
-      instascale-version:
-        description: 'Published version of InstaScale'
-        required: true
-        default: 'v0.0.0-dev'
       kuberay-version:
         description: 'Tested version of KubeRay'
         required: true
@@ -64,7 +60,7 @@ jobs:
     - name: Set Go
       uses: actions/setup-go@v5
       with:
-        go-version: v1.20
+        go-version-file: './go.mod'
 
     - name: Verify that release doesn't exist yet
       shell: bash {0}
@@ -90,16 +86,14 @@ jobs:
     - name: Adjust Compatibility Matrix in readme
       run: |
         sed -i -E "s|(.*CodeFlare Operator.*\[).*(\].*releases/tag/).*(\).*)|\1${{ github.event.inputs.version }}\2${{ github.event.inputs.version }}\3|" README.md
-        sed -i -E "s|(.*Multi-Cluster App Dispatcher.*\[).*(\].*releases/tag/).*(\).*)|\1${{ github.event.inputs.mcad-version }}\2${{ github.event.inputs.mcad-version }}\3|" README.md
+        sed -i -E "s|(.*AppWrapper.*\[).*(\].*releases/tag/).*(\).*)|\1${{ github.event.inputs.appwrapper-version }}\2${{ github.event.inputs.appwrapper-version }}\3|" README.md
         sed -i -E "s|(.*CodeFlare-SDK.*\[).*(\].*releases/tag/).*(\).*)|\1${{ github.event.inputs.codeflare-sdk-version }}\2${{ github.event.inputs.codeflare-sdk-version }}\3|" README.md
-        sed -i -E "s|(.*InstaScale.*\[).*(\].*releases/tag/).*(\).*)|\1${{ github.event.inputs.instascale-version }}\2${{ github.event.inputs.instascale-version }}\3|" README.md
         sed -i -E "s|(.*KubeRay.*\[).*(\].*releases/tag/).*(\).*)|\1${{ github.event.inputs.kuberay-version }}\2${{ github.event.inputs.kuberay-version }}\3|" README.md
 
-    - name: Adjust MCAD, SDK and InstaScale dependencies in the code
+    - name: Adjust AppWrapper and SDK dependencies in the code
       run: |
-        sed -i -E "s/(.*MCAD_VERSION \?= ).*/\1${{ github.event.inputs.mcad-version }}/" Makefile
-        sed -i -E "s/(.*MCAD_REF \?= ).*/\1release-\${MCAD_VERSION}/" Makefile
-        sed -i -E "s/(.*INSTASCALE_VERSION \?= ).*/\1${{ github.event.inputs.instascale-version }}/" Makefile
+        sed -i -E "s/(.*APPWRAPPER_VERSION \?= ).*/\1${{ github.event.inputs.appwrapper-version }}/" Makefile
+        sed -i -E "s/(.*APPWRAPPER_REF \?= ).*/\1release-\${APPWRAPPER_VERSION}/" Makefile
         sed -i -E "s/(.*KUBERAY_VERSION \?= ).*/\1${{ github.event.inputs.kuberay-version }}/" Makefile
 
     - name: Update image version in params.env
@@ -192,8 +186,7 @@ jobs:
       env:
         VERSION: ${{ github.event.inputs.version }}
         PREVIOUS_VERSION: ${{ github.event.inputs.replaces }}
-        INSTASCALE_VERSION: ${{ github.event.inputs.instascale-version }}
-        MCAD_VERSION: ${{ github.event.inputs.mcad-version }}
+        APPWRAPPER_VERSION: ${{ github.event.inputs.appwrapper-version }}
         GH_TOKEN: ${{ secrets.CODEFLARE_MACHINE_ACCOUNT_TOKEN }}
         OPERATORS_REPO_FORK_ORG: ${{ github.event.inputs.community-operators-prod-fork-organization }}
         OPERATORS_REPO_ORG: ${{ github.event.inputs.community-operators-prod-organization }}

.github/workflows/unit_tests.yml

@@ -12,22 +12,23 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
-    container:
-      image: quay.io/opendatahub/pre-commit-go-toolchain:v0.2  # https://github.com/opendatahub-io/data-science-pipelines-operator/blob/main/.github
-      env:
-        XDG_CACHE_HOME: /cache
-        GOCACHE: /cache/go-build
-        GOMODCACHE: /cache/go-mod
-        PRE_COMMIT_HOME: /cache/pre-commit
-      volumes:
-        - /cache
+    # DISABLED: This container has go 1.20
+    # container:
+    #   image: quay.io/opendatahub/pre-commit-go-toolchain:v0.2  # https://github.com/opendatahub-io/data-science-pipelines-operator/blob/main/.github
+    #   env:
+    #     XDG_CACHE_HOME: /cache
+    #     GOCACHE: /cache/go-build
+    #     GOMODCACHE: /cache/go-mod
+    #     PRE_COMMIT_HOME: /cache/pre-commit
+    #   volumes:
+    #     - /cache
     steps:
       - uses: actions/checkout@v4
 
       - name: Set Go
         uses: actions/setup-go@v5
         with:
-          go-version: v1.20
+          go-version-file: './go.mod'
 
       - name: Activate cache
         uses: actions/cache@v4

.github/workflows/verify_generated_files.yml

@@ -24,7 +24,7 @@ jobs:
     - name: Set Go
       uses: actions/setup-go@v5
       with:
-        go-version: v1.20
+        go-version-file: './go.mod'
     - name: Verify that imports are organized
       run: make verify-imports
 
@@ -35,6 +35,6 @@ jobs:
     - name: Set Go
       uses: actions/setup-go@v5
       with:
-        go-version: v1.20
+        go-version-file: './go.mod'
     - name: Verify that the latest WebhookConfigurations, ClusterRoles, and CustomResourceDefinitions have been generated
       run: make manifests && git diff --exit-code

.pre-commit-config.yaml

@@ -21,8 +21,15 @@ repos:
         entry: yamllint --strict
 
   - repo: https://github.com/dnephin/pre-commit-golang
-    rev: c17f835cf9
+    rev: v0.5.1
     hooks:
       - id: go-fmt
-      - id: golangci-lint
       - id: go-mod-tidy
+
+  - repo: local
+    hooks:
+    - id: golangci-lint
+      name: golangci-lint
+      entry: make lint
+      language: system
+      pass_filenames: false

CONTRIBUTING.md

@@ -14,14 +14,14 @@ The following should be installed in your working environment:
 ## Basic Overview
 The main entrypoint for the operator is `main.go`
 
-The MCAD and InstaScale custom resources are defined under the `api` dir:
- - See `mcad_types.go` and `instascale_types.go`
+The AppWrapper custom resources are defined under the `api` dir:
+ - See `appwraper_types.go`
 
-The MCAD and InstaScale resource templates can be found under `config/internal`:
- - Sorted under `mcad` and `instascale` subdirs
+The AppWrapper resource templates can be found under `config/internal`:
+ - Sorted under `appwrapper` subdirs
 
-The code for MCAD/InstaScale resource reconcilliation can be found in the `controllers` dir:
- - See `mcad_controller.go` and `instascale_controller.go`
+The code for AppWrapper resource reconcilliation can be found in the `controllers` dir:
+ - See `appwrapper_controller.go`
 
 ## Building and Deployment
 If changes are made in the `api` dir, run: `make manifests`
@@ -53,7 +53,7 @@ The CodeFlare Operator currently has unit tests and pre-commit checks
  - Note that both are required for CI to pass on pull requests
 
 To write and inspect unit tests:
- - MCAD and InstaScale unit tests under `mcad_controller_test.go` and `instascale_controller_test.go` in the `controllers` dir
+ - AppWrapper unit tests under `appwrapper_controller_test.go` in the `controllers` dir
  - Unit test functions are defined in `suite_test.go` (with utils in `util/util.go`) in the `controllers dir`
  - Test cases defined under `controllers/testdata`