Merge pull request #199 from kad/opae1.3.2

FPGA: Migrate to ClearLinux, use native go and kernel APIs

Author: bart0sh

.gitignore

@@ -8,5 +8,12 @@ coverage.txt
 cmd/fpga_admissionwebhook/fpga_admissionwebhook
 cmd/fpga_crihook/fpga_crihook
 cmd/fpga_plugin/fpga_plugin
+cmd/fpga_tool/fpga_tool
 cmd/gpu_plugin/gpu_plugin
 cmd/qat_plugin/qat_plugin
+
+*.h
+*.gbs
+*.gbs.*
+*.aocx
+*.aocx.*

.travis.yml

@@ -23,6 +23,7 @@ before_install:
   - if [[ "$src" != "$dest" ]]; then mv "$src" "$dest"; cd ../../intel/$repo; export TRAVIS_BUILD_DIR=`dirname $TRAVIS_BUILD_DIR`/$repo; fi
   ## install buildah build deps
   - cdir=$(pwd)
+  - sudo apt-get update
   - sudo apt-get -y install e2fslibs-dev libfuse-dev libgpgme11-dev libdevmapper-dev libglib2.0-dev libprotobuf-dev
   # build buildah
   - mkdir -p $GOPATH/src/github.com/containers
@@ -47,7 +48,7 @@ script:
   - make vet
   - make cyclomatic-check
   - make test BUILDTAGS=kerneldrv
-  - make images
+  - make -j4 images
   - make images BUILDER=buildah
   - make demos
   - make demos BUILDER=buildah

Jenkinsfile

@@ -36,6 +36,7 @@ pipeline {
         }
         stage("buildah") {
           steps {
+            sh "sudo apt-get update"
             sh "sudo apt-get -y install e2fslibs-dev libfuse-dev libgpgme11-dev libdevmapper-dev libglib2.0-dev libprotobuf-dev"
             sh "mkdir -p ${GOPATH}/src/github.com/containers"
             dir(path: "${GOPATH}/src/github.com/containers") {

build/docker/intel-fpga-admissionwebhook.Dockerfile

@@ -1,10 +1,35 @@
-FROM golang:1.11 as builder
+# CLEAR_LINUX_BASE and CLEAR_LINUX_VERSION can be used to make the build
+# reproducible by choosing an image by its hash and installing an OS version
+# with --version=:
+# CLEAR_LINUX_BASE=clearlinux@sha256:b8e5d3b2576eb6d868f8d52e401f678c873264d349e469637f98ee2adf7b33d4
+# CLEAR_LINUX_VERSION="--version=29970"
+#
+# This is used on release branches before tagging a stable version.
+# The master branch defaults to using the latest Clear Linux.
+ARG CLEAR_LINUX_BASE=clearlinux/golang:latest
+
+FROM ${CLEAR_LINUX_BASE} as builder
+
+ARG CLEAR_LINUX_VERSION=
+
+RUN swupd update --no-boot-update ${CLEAR_LINUX_VERSION}
+RUN mkdir /install_root \
+    && swupd os-install \
+    ${CLEAR_LINUX_VERSION} \
+    --path /install_root \
+    --statedir /swupd-state \
+    --bundles=os-core \
+    --no-boot-update \
+    && rm -rf /install_root/var/lib/swupd/*
+
 ARG DIR=/go/src/github.com/intel/intel-device-plugins-for-kubernetes
 WORKDIR $DIR
 COPY . .
 RUN cd cmd/fpga_admissionwebhook; go install
-RUN chmod a+x /go/bin/fpga_admissionwebhook
+RUN chmod a+x /go/bin/fpga_admissionwebhook \
+    && install -D /go/bin/fpga_admissionwebhook /install_root/usr/local/bin/intel_fpga_admissionwebhook \
+    && install -D ${DIR}/LICENSE /install_root/usr/local/share/package-licenses/intel-device-plugins-for-kubernetes/LICENSE
 
-FROM gcr.io/distroless/base
-COPY --from=builder /go/bin/fpga_admissionwebhook /usr/bin/intel_fpga_admissionwebhook
-CMD ["/usr/bin/intel_fpga_admissionwebhook"]
+FROM scratch as final
+COPY --from=builder /install_root /
+CMD ["/usr/local/bin/intel_fpga_admissionwebhook"]

build/docker/intel-fpga-initcontainer.Dockerfile

@@ -0,0 +1,67 @@
+# CLEAR_LINUX_BASE and CLEAR_LINUX_VERSION can be used to make the build
+# reproducible by choosing an image by its hash and installing an OS version
+# with --version=:
+# CLEAR_LINUX_BASE=clearlinux@sha256:b8e5d3b2576eb6d868f8d52e401f678c873264d349e469637f98ee2adf7b33d4
+# CLEAR_LINUX_VERSION="--version=29970"
+#
+# This is used on release branches before tagging a stable version.
+# The master branch defaults to using the latest Clear Linux.
+ARG CLEAR_LINUX_BASE=clearlinux/golang:latest
+
+FROM ${CLEAR_LINUX_BASE} as builder
+
+ARG CLEAR_LINUX_VERSION=
+
+RUN swupd update --no-boot-update ${CLEAR_LINUX_VERSION}
+RUN mkdir /install_root \
+    && swupd os-install \
+    ${CLEAR_LINUX_VERSION} \
+    --path /install_root \
+    --statedir /swupd-state \
+    --bundles=os-core,rsync \
+    --no-boot-update \
+    && rm -rf /install_root/var/lib/swupd/*
+
+# Build CRI Hook
+ARG DIR=/go/src/github.com/intel/intel-device-plugins-for-kubernetes
+WORKDIR $DIR
+COPY . .
+RUN cd $DIR/cmd/fpga_crihook && \
+    go install && \
+    chmod a+x /go/bin/fpga_crihook && \
+    cd $DIR/cmd/fpga_tool && \
+    go install && \
+    chmod a+x /go/bin/fpga_tool && \
+    install -D ${DIR}/LICENSE /install_root/usr/local/share/package-licenses/intel-device-plugins-for-kubernetes/LICENSE
+
+# Minimal result image
+FROM scratch as final
+COPY --from=builder /install_root /
+
+ARG SRC_DIR=/usr/local/fpga-sw.src
+ARG DST_DIR=/opt/intel/fpga-sw
+
+# CRI hook
+ARG CRI_HOOK=intel-fpga-crihook
+ARG FPGA_TOOL=fpgatool
+ARG HOOK_CONF=$CRI_HOOK.json
+ARG HOOK_CONF_SRC=$SRC_DIR/$HOOK_CONF
+ARG HOOK_CONF_DST=$DST_DIR/$HOOK_CONF
+
+COPY --from=builder /go/bin/fpga_crihook $SRC_DIR/$CRI_HOOK
+COPY --from=builder /go/bin/fpga_tool $SRC_DIR/$FPGA_TOOL
+
+RUN echo -e "{\n\
+    \"hook\" : \"$DST_DIR/$CRI_HOOK\",\n\
+    \"stage\" : [ \"prestart\" ],\n\
+    \"annotation\": [ \"fpga.intel.com/region\" ]\n\
+}\n">>$HOOK_CONF_SRC
+
+RUN echo -e "#!/bin/sh\n\
+rsync -a --delete $SRC_DIR/ $DST_DIR\n\
+mkdir -p /etc/containers/oci/hooks.d\n\
+ln -sf $HOOK_CONF_DST /etc/containers/oci/hooks.d/$HOOK_CONF\n\
+rm $DST_DIR/deploy.sh\n\
+">> $SRC_DIR/deploy.sh && chmod +x $SRC_DIR/deploy.sh
+
+CMD [ "/opt/intel/fpga-sw.src/deploy.sh" ]

build/docker/intel-fpga-plugin.Dockerfile

@@ -1,10 +1,35 @@
-FROM golang:1.11 as builder
+# CLEAR_LINUX_BASE and CLEAR_LINUX_VERSION can be used to make the build
+# reproducible by choosing an image by its hash and installing an OS version
+# with --version=:
+# CLEAR_LINUX_BASE=clearlinux@sha256:b8e5d3b2576eb6d868f8d52e401f678c873264d349e469637f98ee2adf7b33d4
+# CLEAR_LINUX_VERSION="--version=29970"
+#
+# This is used on release branches before tagging a stable version.
+# The master branch defaults to using the latest Clear Linux.
+ARG CLEAR_LINUX_BASE=clearlinux/golang:latest
+
+FROM ${CLEAR_LINUX_BASE} as builder
+
+ARG CLEAR_LINUX_VERSION=
+
+RUN swupd update --no-boot-update ${CLEAR_LINUX_VERSION}
+RUN mkdir /install_root \
+    && swupd os-install \
+    ${CLEAR_LINUX_VERSION} \
+    --path /install_root \
+    --statedir /swupd-state \
+    --bundles=os-core \
+    --no-boot-update \
+    && rm -rf /install_root/var/lib/swupd/*
+
 ARG DIR=/go/src/github.com/intel/intel-device-plugins-for-kubernetes
 WORKDIR $DIR
 COPY . .
 RUN cd cmd/fpga_plugin; go install
-RUN chmod a+x /go/bin/fpga_plugin
+RUN chmod a+x /go/bin/fpga_plugin \
+    && install -D /go/bin/fpga_plugin /install_root/usr/local/bin/intel_fpga_device_plugin \
+    && install -D ${DIR}/LICENSE /install_root/usr/local/share/package-licenses/intel-device-plugins-for-kubernetes/LICENSE
 
-FROM gcr.io/distroless/base
-COPY --from=builder /go/bin/fpga_plugin /usr/bin/intel_fpga_device_plugin
-CMD ["/usr/bin/intel_fpga_device_plugin"]
+FROM scratch as final
+COPY --from=builder /install_root /
+CMD ["/usr/local/bin/intel_fpga_device_plugin"]

cmd/fpga_crihook/README.md

@@ -21,14 +21,9 @@ $ cd $GOPATH/src/github.com/intel/intel-device-plugins-for-kubernetes
 $ make fpga_crihook
 ```
 
-### Download 'Acceleration Stack for Runtime' tarball
-```
-Download a10_gx_pac_ias_1_1_pv_rte_installer.tar.gz from https://www.intel.com/content/www/us/en/programmable/solutions/acceleration-hub/downloads.html into $GOPATH/src/github.com/intel/intel-device-plugins-for-kubernetes/deployments/fpga_plugin directory
-```
-
-### Build init container that contains CRI hook and all its dependencies:
-```
-$ cd $GOPATH/src/github.com/intel/intel-device-plugins-for-kubernetes/deployments/fpga_plugin
-$ ./build-initcontainer-image.sh
-```
+### Ensure that CRI-O is configured to allow OCI hooks
 
+Recent versions of CRI-O are shipped with default configuration file that prevents
+CRI-O to discover and configure hooks automatically.
+For FPGA orchestration programmed mode, the OCI hooks are the key component.
+Thus, please make sure that in your `/etc/crio/crio.conf` parameter `hooks_dir` is either unset (to enable default search paths for OCI hooks configuration) or contains directory `/etc/containers/oci/hooks.d`