Add testing DSS with Canonical Kubernetes (New)

.github/workflows/checkbox-dss-build.yaml

@@ -0,0 +1,65 @@
+name: checkbox-dss Snap build
+permissions:
+  contents: read
+on:
+  push:
+    branches: [ main ]
+    paths:
+      - contrib/checkbox-dss-validation/checkbox-provider-dss/**
+      - .github/workflows/checkbox-dss-build.yaml
+  pull_request:
+    branches: [ main ]
+    paths:
+      - contrib/checkbox-dss-validation/checkbox-provider-dss/**
+      - .github/workflows/checkbox-dss-build.yaml
+  workflow_dispatch:
+  workflow_call:
+    outputs:
+      artifact-url:
+        value: ${{ jobs.snap_frontend_native.outputs.artifact-url }}
+
+jobs:
+  snap_frontend_native:
+    outputs:
+      artifact-url: ${{ steps.upload_artifact.outputs.artifact-url }}
+    runs-on:
+      group: "Canonical self-hosted runners"
+      labels: ["self-hosted", "linux", "jammy", "large", "X64"]
+    timeout-minutes: 1200 #20h, this will timeout sooner due to inner timeouts
+    name: Checkbox DSS validation snap
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - id: snap_build
+        uses: Wandalen/wretry.action@71a909ebf09f3ffdc6f42a17bd54ecb43481da49
+        name: Building the snaps
+        timeout-minutes: 600 # 10hours
+        with:
+          action: snapcore/[email protected]
+          attempt_delay: 600000 # 10min
+          attempt_limit: 5
+          with: |
+            path: contrib/checkbox-dss-validation/
+            snapcraft-channel: 8.x/stable
+
+      - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
+        name: Upload logs on failure
+        if: failure()
+        with:
+          name: snapcraft-log-checkbox-dss-snap
+          path: |
+            /home/runner/.cache/snapcraft/log/
+            /home/runner/.local/state/snapcraft/log/
+            contrib/checkbox-dss-validation/checkbox*.txt
+
+      - id: upload_artifact
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
+        name: Upload the snaps as artifact
+        with:
+          name: checkbox-dss.snap
+          path: ${{ steps.snap_build.outputs.snap }}
+
+      # NOTE:@motjuste: We currently don't publish the checkbox-dss Snap

.github/workflows/testflinger-contrib-dss-regression.yaml

@@ -1,39 +1,51 @@
 name: Data Science Stack (DSS) Regression Testing
+run-name: Testing DSS ${{ inputs.dss_channel }} on ${{ inputs.k8s_type }} ${{ inputs.k8s_channel }}
 permissions:
   contents: read
 on:
   workflow_dispatch:
-  # schedule:
-  #   - cron: "0 7 * * 1" # every Monday 07:00 UTC
-  # push:
-  #   branches:
-  #     - main
-  # pull_request:
-  #   branches:
-  #     - main
+    inputs:
+      dss_channel:
+        description: "Channel of the DSS snap to test"
+        default: latest/edge
+        required: false
+        type: choice
+        options:
+          - latest/edge
+          - latest/stable
+          - 1.1/edge
+          - 1.1/stable
+          - 1.0/edge
+          - 1.0/stable
+      k8s_type:
+        description: "The type of K8s to deploy"
+        default: "canonical-k8s"
+        required: false
+        type: choice
+        options:
+          - canonical-k8s
+          - microk8s
+      k8s_channel:
+        description: "Channel of the K8s snap to deploy"
+        default: "1.32-classic/stable"
+        type: string
 
 env:
   BRANCH: ${{ github.head_ref || github.ref_name }}
 
 jobs:
+  dss-snap-frontend-native-build:
+    uses: ./.github/workflows/checkbox-dss-build.yaml
+
   regression-tests:
+    needs: dss-snap-frontend-native-build
     name: Regression tests
     runs-on: [testflinger]
-    defaults:
-      run:
-        working-directory: contrib/checkbox-dss-validation
     strategy:
       fail-fast: false
       matrix:
-        dss_channel:
-          - 1/stable
-          - 1/candidate
-          - latest/edge
-        microk8s_channel:
-          - 1.28/stable
-          - 1.31/stable
         queue:
-          - name: dell-precision-3470-c30322 #ADL iGPU + NVIDIA GPU
+          - name: dell-precision-3470-c30320 #ADL iGPU + NVIDIA GPU
             provision_data: "distro: jammy"
           - name: dell-precision-5680-c31665 #RPL iGPU + Arc Pro A60M dGPU
             provision_data: "url: http://10.102.196.9/somerville/Platforms/jellyfish-muk/X96_A00/dell-bto-jammy-jellyfish-muk-X96-20230419-19_A00.iso"
@@ -44,15 +56,29 @@ jobs:
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
         with:
           persist-credentials: false
+      - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093
+        name: Download the artifact with the built snap
+        with:
+          name: checkbox-dss.snap
+      - name: Rename snap artifact to match attachment
+        run: |
+          ls -lah checkbox-dss*.snap
+          mv checkbox-dss*.snap checkbox-dss.snap
+          ls -lah checkbox-dss*.snap
       - name: Build job file from template
+        env:
+          DSS_CHANNEL: ${{ inputs.dss_channel }}
+          K8S_TYPE: ${{ inputs.k8s_type }}
+          K8S_CHANNEL: ${{ inputs.k8s_channel }}
         run: |
-          sed -e "s|REPLACE_BRANCH|${BRANCH}|" \
-          -e "s|REPLACE_QUEUE|${{ matrix.queue.name }}|" \
+          sed -e "s|REPLACE_QUEUE|${{ matrix.queue.name }}|" \
           -e "s|REPLACE_PROVISION_DATA|${{ matrix.queue.provision_data }}|" \
-          -e "s|REPLACE_DSS_CHANNEL|${{ matrix.dss_channel }}|" \
-          -e "s|REPLACE_MICROK8S_CHANNEL|${{ matrix.microk8s_channel }}|" \
+          -e "s|REPLACE_DSS_CHANNEL|${DSS_CHANNEL}|" \
+          -e "s|REPLACE_K8S_TYPE|${K8S_TYPE}|" \
+          -e "s|REPLACE_K8S_CHANNEL|${K8S_CHANNEL}|" \
           ${GITHUB_WORKSPACE}/contrib/checkbox-dss-validation/testflinger/job-def.yaml > \
           ${GITHUB_WORKSPACE}/job.yaml
+          cat ${GITHUB_WORKSPACE}/job.yaml
       - name: Submit testflinger job
         uses: canonical/testflinger/.github/actions/submit@a5c430ce76f981b5f344c65d82201a27f1e8c18a
         with:

contrib/checkbox-dss-validation/README.md

@@ -21,7 +21,7 @@ lxd init --auto
 git clone https://github.com/canonical/checkbox
 cd checkbox/contrib/checkbox-dss-validation
 snapcraft
-sudo snap install --dangerous --classic ./checkbox-dss_3.0_amd64.snap
+sudo snap install --dangerous --classic ./checkbox-dss_3.1_amd64.snap
 ```
 
 Make sure that the provider service is running and active:
@@ -38,21 +38,37 @@ Some test need dependencies, and a helper script is available to install them:
 checkbox-dss.install-deps
 ```
 
-By default this will install the `data-science-stack` snap from the `latest/stable`
-channel. To instead install from `latest/edge` use:
+By default this will install the `data-science-stack` snap from the `1.0/stable`
+channel. To instead install from `1.1/edge` use:
 
 ```shell
-checkbox-dss.install-deps --dss-snap-channel latest/edge
+checkbox-dss.install-deps --dss-snap-channel 1.1/edge
 ```
 
-Furthermore, the default `microk8s` snap channel is `1.28/stable` in classic mode,
-but this can be customized as
+Furthermore, by default, `microk8s` snap from channel `1.28/stable` is installed
+in classic mode.
+The channel for `microk8s` can be customized as
 (please note that this snap must to be `--classic` to enable GPU support):
 
 ```shell
-checkbox-dss.install-deps --microk8s-snap-channel 1.31/stable
+checkbox-dss.install-deps --microk8s-snap-channel 1.32/stable
 ```
 
+It is also possible to install [Canonical Kubernetes](https://snapcraft.io/k8s)
+**instead** of `microk8s`.
+**Only one of, and at least one of either**
+`microk8s` or Canonical Kubernetes must be installed.
+Canonical Kubernetes will be installed instead of `microk8s` if the argument
+`--canonical-k8s-snap-channel` is provided with a value:
+
+```shell
+checkbox-dss.install-deps --canonical-k8s-snap-channel 1.32/stable --dss-snap-channel 1.1/edge
+```
+
+When Canonical Kubernetes is install, the snape `helm` will also be installed from the
+default channel in `--classic` mode.
+`helm` will be used to enable NVIDIA GPU in the Canonical Kubernetes cluster.
+
 These validations also need the `kubectl` snap installed, and the default channel
 used for that is `1.29/stable`, but can be customized as shown previously by passing
 the appropriate channel name for `--kubectl-snap-channel`.

contrib/checkbox-dss-validation/bin/install-deps

@@ -1,7 +1,7 @@
 #!/bin/bash
 set -e
 
-dss_snap_channel="latest/stable"
+dss_snap_channel="1.0/stable"
 microk8s_snap_channel="1.28/stable"
 kubectl_snap_channel="1.29/stable"
 
@@ -35,24 +35,46 @@ setup_microk8s_snap() {
         deployment/coredns \
         deployment/hostpath-provisioner
     sudo microk8s.kubectl -n kube-system rollout status ds/calico-node
+
+    # hack as redirecting stdout anywhere but /dev/null throws a permission denied error
+    # see: https://forum.snapcraft.io/t/eksctl-cannot-write-to-stdout/17254/4
+    sudo microk8s.kubectl config view --raw | tee "${SNAP_REAL_HOME}/.kube/config" >/dev/null
 }
 
 setup_kubectl_snap() {
     # This is needed to overcome the following bug within microk8s:
     # https://github.com/canonical/microk8s/issues/4453
     echo -e "\nInstalling kubectl snap from channel $1"
     sudo snap install kubectl --classic --channel="$1"
+}
+
+setup_canonical_k8s_snap() {
+    echo -e "\nInstalling Canonical k8s snap from channel $1"
+    sudo snap install k8s --classic --channel "$1"
+    sudo k8s bootstrap
+    sudo k8s enable local-storage
+
+    # Directory needed for kubeconfig
+    mkdir -p "${SNAP_REAL_HOME}/.kube"
+
     # hack as redirecting stdout anywhere but /dev/null throws a permission denied error
     # see: https://forum.snapcraft.io/t/eksctl-cannot-write-to-stdout/17254/4
-    sudo microk8s.kubectl config view --raw | tee "${SNAP_REAL_HOME}/.kube/config" >/dev/null
+    sudo k8s config | tee "${SNAP_REAL_HOME}/.kube/config" >/dev/null
 }
 
 help_function() {
-    echo "This script is used install all dependencies for checkbox-dss to run; defaults for optional arguments are shown in usage"
-    echo "Usage: checkbox-dss.install-deps [--dss-snap-channel $dss_snap_channel] [--microk8s-snap-channel $microk8s_snap_channel] [--kubectl-snap-channel $kubectl_snap_channel]"
+    echo "This script is used install all dependencies for checkbox-dss to run;"
+    echo "defaults for optional arguments are shown in usage except for"
+    echo "'--canonical-k8s-channel':"
+    echo "if this arg is not provided, then microk8s will be installed from its default value,"
+    echo "otherwise Canonical k8s will be installed from the given channel instead of microk8s."
+    echo "Usage: checkbox-dss.install-deps [--dss-snap-channel $dss_snap_channel] [--canonical-k8s-channel NO-DEFAULT | --microk8s-snap-channel $microk8s_snap_channel] [--kubectl-snap-channel $kubectl_snap_channel]"
+    exit 2
 }
 
 main() {
+    sudo snap refresh snapd
+
     while [ $# -ne 0 ]; do
         case $1 in
         --dss-snap-channel)
@@ -67,12 +89,23 @@ main() {
             kubectl_snap_channel="$2"
             shift 2
             ;;
+        --canonical-k8s-snap-channel)
+            canonical_k8s_snap_channel="$2"
+            shift 2
+            ;;
         *) help_function ;;
         esac
     done
 
-    echo -e "\n Step 1/4: Setting up microk8s"
-    setup_microk8s_snap "$microk8s_snap_channel"
+    if [[ -n "$canonical_k8s_snap_channel" ]]; then
+        echo -e "\n Step 1/4: Setting up Canonical k8s and helm"
+        setup_canonical_k8s_snap "$canonical_k8s_snap_channel"
+    else
+        echo -e "\n Step 1/4: Setting up microk8s and helm"
+        setup_microk8s_snap "$microk8s_snap_channel"
+    fi
+    echo -e "\n Installing the helm snap"
+    sudo snap install helm --classic
 
     echo -e "\n Step 2/4: Setting up kubectl"
     setup_kubectl_snap "$kubectl_snap_channel"