Merge pull request #534 from bart0sh/PR0097-dsa-demo

implement DSA demo

Author: rojkov

.github/workflows/ci.yaml

@@ -79,6 +79,7 @@ jobs:
 
           # Demo images
           - crypto-perf
+          - dsa-accel-config-demo
           - opae-nlb-demo
           - openssl-qat-engine
           - sgx-sdk-demo

cmd/dsa_plugin/README.md

@@ -14,6 +14,7 @@ Table of Contents
         * [Build the plugin](#build-the-plugin)
         * [Run the plugin as administrator](#run-the-plugin-as-administrator)
     * [Verify plugin registration](#verify-plugin-registration)
+    * [Testing the plugin](#testing-the-plugin)
 
 ## Introduction
 
@@ -128,3 +129,64 @@ master
   dsa.intel.com/wq-user-dedicated:  1
   dsa.intel.com/wq-user-shared:     1
 ```
+
+### Testing the plugin
+
+We can test the plugin is working by deploying the provided example accel-config test image.
+
+1. Build a Docker image with an accel-config tests:
+
+    ```bash
+    $ make dsa-accel-config-demo
+    ...
+    Successfully tagged dsa-accel-config-demo:devel
+    ```
+
+1. Create a pod running unit tests off the local Docker image:
+
+    ```bash
+    $ kubectl apply -f ${INTEL_DEVICE_PLUGINS_SRC}/demo/dsa-accel-config-demo-pod.yaml
+    pod/dsa-accel-config-demo created
+    ```
+
+1. Wait until pod is completed:
+
+    ```bash
+    $ kubectl get pods  |grep dsa-accel-config-demo
+    dsa-accel-config-demo    0/1     Completed   0          31m
+
+1. Review the job's logs:
+
+    ```bash
+    $ kubectl logs dsa-accel-config-demo | tail
+    [debug] PF in sub-task[6], consider as passed
+    [debug] PF in sub-task[7], consider as passed
+    [debug] PF in sub-task[8], consider as passed
+    [debug] PF in sub-task[9], consider as passed
+    [debug] PF in sub-task[10], consider as passed
+    [debug] PF in sub-task[11], consider as passed
+    [debug] PF in sub-task[12], consider as passed
+    [debug] PF in sub-task[13], consider as passed
+    [debug] PF in sub-task[14], consider as passed
+    [debug] PF in sub-task[15], consider as passed
+    ```
+
+    If the pod did not successfully launch, possibly because it could not obtain the DSA
+    resource, it will be stuck in the `Pending` status:
+
+    ```bash
+    $ kubectl get pods
+    NAME                      READY   STATUS    RESTARTS   AGE
+    dsa-accel-config-demo     0/1     Pending   0          7s
+    ```
+
+    This can be verified by checking the Events of the pod:
+
+    ```bash
+
+    $ kubectl describe pod dsa-accel-config-demo | grep -A3 Events:
+    Events:
+      Type     Reason            Age    From               Message
+      ----     ------            ----   ----               -------
+      Warning  FailedScheduling  2m26s  default-scheduler  0/1 nodes are available: 1 Insufficient dsa.intel.com/wq-user-dedicated, 1 Insufficient dsa.intel.com/wq-user-shared.
+    ```

demo/dsa-accel-config-demo-pod.yaml

@@ -0,0 +1,16 @@
+apiVersion: v1
+kind: Pod
+metadata:
+  name: dsa-accel-config-demo
+spec:
+  containers:
+  - name: dsa-accel-config-demo
+    image: dsa-accel-config-demo:devel
+    imagePullPolicy: IfNotPresent
+    resources:
+      limits:
+        dsa.intel.com/wq-user-dedicated: 1
+        dsa.intel.com/wq-user-shared: 1
+        cpu: 1
+
+  restartPolicy: Never

demo/dsa-accel-config-demo/Dockerfile

@@ -0,0 +1,29 @@
+FROM fedora:32 AS builder
+
+RUN dnf install -y wget autoconf automake libtool m4 diffutils file make dnf-utils
+RUN dnf install -y libuuid-devel json-c-devel kmod-devel libudev-devel
+
+ARG ACCEL_CONFIG_VERSION=v2.8
+
+RUN wget -O- https://github.com/intel/idxd-config/archive/accel-config-$ACCEL_CONFIG_VERSION.tar.gz | tar -zx
+
+RUN cd idxd-config-accel-config-$ACCEL_CONFIG_VERSION && \
+    mkdir m4 && \
+    ./autogen.sh && \
+    ./configure CFLAGS='-g -O2' --prefix=/usr --sysconfdir=/etc --libdir=/usr/lib64 --enable-test=yes --disable-docs && \
+    make && \
+    make check && \
+    make install
+
+FROM fedora:32
+
+RUN dnf install -y libuuid json-c kmod udev
+
+COPY --from=builder /lib64/libaccel-config.so.1 /lib64/
+COPY --from=builder /lib64/libaccel-config.so.1.0.0 /lib64/
+RUN ldconfig
+
+COPY --from=builder /usr/bin/accel-config /usr/bin/
+COPY --from=builder /usr/share/accel-config/test /test
+
+ENTRYPOINT cd /test && sed '/_cleanup$/d;/start_dsa$/d;/enable_wqs$/d;/stop_dsa$/d;/disable_wqs$/d' dsa_user_test_runner.sh | sh