Replace support-tools image with custom one (#67)

* Replace support-tools image with custom one

Using the support-tools image for debug partner pods restricts us to
OpenShift environments in some tests, like diagnostic. We can swap that
one with a UBI8-based image, so those tests can be executed on minikube
or other environments as well.

* Additional debug partner image fixes

- Remove unnecessary REDHAT_RHEL_REGISTRY env var
- In Dockerfile, run yum update before yum install

* Add procps-ng package to debug partner image

It contains the sysctl binary, required for some tests.

Author: javierpena

.github/workflows/debug-partner-image.yaml

@@ -0,0 +1,63 @@
+name: 'Test/push the `debug-partner` image'
+on:
+  push:
+    paths:
+      - 'test-partner/Dockerfile.debug-partner'
+  pull_request:
+defaults:
+  run:
+    shell: bash
+    working-directory: test-partner
+env:
+  REGISTRY: quay.io
+  IMAGE_NAME: testnetworkfunction/debug-partner
+  IMAGE_TAG: latest
+  IMAGE_CONTAINER_FILE_PATH: test-partner/Dockerfile.debug-partner
+
+jobs:
+  test-debug-partner-image:
+    name: 'Build and test the `debug-partner` image'
+    runs-on: ubuntu-20.04
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: 'Build the `debug-partner` image'
+        run: docker build --no-cache -f Dockerfile.debug-partner -t $IMAGE_NAME:$IMAGE_TAG .
+
+      - name: 'Test: Check if lscpu is installed'
+        run: docker run $IMAGE_NAME:$IMAGE_TAG which lscpu
+
+      - name: 'Test: Check if lsblk is installed'
+        run: docker run $IMAGE_NAME:$IMAGE_TAG which lsblk
+
+      - name: 'Test: Check if lspci is installed'
+        run: docker run $IMAGE_NAME:$IMAGE_TAG which lspci
+
+  push-debug-partner-image:
+    if: ${{ github.ref == 'refs/heads/main' }}
+    name: 'Push the new `debug-partner` image to Quay.io'
+    needs: test-debug-partner-image
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: Checkout the main branch
+        uses: actions/checkout@v2
+        with:
+          ref: main
+
+      - name: Authenticate against Quay.io
+        uses: docker/login-action@v1
+        with:
+          registry: ${{ env.REGISTRY }}
+          # Use a Robot Account to authenticate against Quay.io
+          # https://docs.quay.io/glossary/robot-accounts.html
+          username: ${{ secrets.QUAY_ROBOT_USERNAME }}
+          password: ${{ secrets.QUAY_ROBOT_TOKEN }}
+
+      - name: 'Build and push the new `debug-partner` image'
+        uses: docker/build-push-action@v2
+        with:
+          push: true
+          file: ${{ env.IMAGE_CONTAINER_FILE_PATH }}
+          tags: '${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ env.IMAGE_TAG }}'

README.md

@@ -11,7 +11,7 @@ Together, they make up the basic infrastructure required for "testing the tester
 * Pod Under Test (PUT): The Vendor Pod, usually provided by a CNF Partner.
 * Operator Under Test (OT): The Vendor Operator, usually provided by a CNF Partner.
 * Test Partner Pod (TPP): A Universal Base Image (UBI) Pod containing the test tools and dependencies to act as a traffic workload generator or receiver.  For generic cases, this currently includes ICMPv4 only.
-* Debug Pod (DP): A Pod running [RHEL support tool image](https://catalog.redhat.com/software/containers/rhel8/support-tools/5ba3eaf9bed8bd6ee819b78b) deployed as part of a daemon set for accessing node information. DPs is deployed in "default" namespace
+* Debug Pod (DP): A Pod running [a UBI8-based support image](https://quay.io/repository/testnetworkfunction/debug-partner) deployed as part of a daemon set for accessing node information. DPs is deployed in "default" namespace
 * CRD Under Test (CRD): A basic CustomResourceDefinition.
 
 

scripts/deploy-debug-ds.sh

@@ -4,16 +4,11 @@
 SCRIPT_DIR=$(dirname "$0")
 source $SCRIPT_DIR/init-env.sh
 
-export REDHAT_RHEL_REGISTRY="${REDHAT_RHEL_REGISTRY:-registry.redhat.io/rhel8}"
+export SUPPORT_IMAGE="${SUPPORT_IMAGE:-debug-partner:latest}"
 # check if we're using minikube by looking for kube-apiserver-minikube pod
 # if it's minikube, don't install debug partner
-if $TNF_NON_OCP_CLUSTER
-then
-  echo "minikube detected, skip installing debug daemonSet"
-else
-  echo "use registry $REDHAT_RHEL_REGISTRY"
-  mkdir -p ./temp
-  cat ./test-partner/debugpartner.yaml | $SCRIPT_DIR/mo > ./temp/debugpartner.yaml
-  oc apply -f ./temp/debugpartner.yaml
-  rm ./temp/debugpartner.yaml
-fi
+echo "using registry $TNF_PARTNER_REPO"
+mkdir -p ./temp
+cat ./test-partner/debugpartner.yaml | $SCRIPT_DIR/mo > ./temp/debugpartner.yaml
+oc apply -f ./temp/debugpartner.yaml
+rm ./temp/debugpartner.yaml

test-partner/Dockerfile.debug-partner

@@ -0,0 +1,9 @@
+FROM registry.access.redhat.com/ubi8/ubi:latest
+
+RUN \
+    yum -y update && \
+    yum -y install pciutils util-linux net-tools procps-ng && \
+    yum clean all -y && \
+    rm -rf /var/cache/yum
+
+VOLUME ["/host"]

test-partner/debugpartner.yaml

@@ -23,7 +23,7 @@ spec:
       containers:
         - command:
             - /bin/sh
-          image: "{{REDHAT_RHEL_REGISTRY}}/support-tools:latest"
+          image: "{{TNF_PARTNER_REPO}}/{{SUPPORT_IMAGE}}"
           imagePullPolicy: IfNotPresent
           name: container-00
           resources: {}