diff --git a/demo/readme.md b/demo/readme.md new file mode 100644 index 00000000..74577356 --- /dev/null +++ b/demo/readme.md @@ -0,0 +1,52 @@ +# Intel Device Plugin Demo for Kubernetes + +## Demo overview + +Acceleration of compute and data processing of workloads like video +transcoding, compression, and encryption is enabled in Kubernetes with +the [Device Plugin Framework](https://kubernetes.io/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins/). This repository +contains a set of Kubernetes plugins and instructions to enable Intel devices +for the acceleration of your workloads orchestrated by Kubernetes. + +The current list of supported Intel Device Plugins includes: + +- [GPU Device Plugin](https://github.com/intel/intel-device-plugins-for-kubernetes/blob/master/cmd/gpu_plugin/README.md) with support for [Intel® Graphics Technology](https://www.intel.com/content/www/us/en/architecture-and-technology/visual-technology/graphics-overview.html) + +- [Intel® FPGA Device Plugin](https://github.com/intel/intel-device-plugins-for-kubernetes/blob/master/cmd/fpga_plugin/README.md) + +- [Intel® QuickAssist Technology (QAT) Device Plugin](https://github.com/intel/intel-device-plugins-for-kubernetes/blob/master/cmd/qat_plugin/README.md) + +We have included an example demo and configuration information for the Intel +Device Plugins for Kubernetes below. Please join us on the sig-node-rtk channel +on [kubernetes.slack.com](https://kubernetes.slack.com/) to ask questions, +contribute to the community, and learn about the work we are doing with +Kubernetes and the Device Plugin Framework. + +## Intel® FPGA Device Plugin demo video + +The screencast demonstrates the deployment of the Intel® FPGA Device Plugin for +Kubernetes and executes a sample GZIP compression workload. The demo begins +with a fully configured Kubernetes cluster with the +[Go runtime](https://golang.org/doc/install). + +### Demo platform configuration + +- 1-node, 2x Intel® Xeon® E5-2680 CPU @ 2.4 GHz +- Total memory 251 GB +- Intel® Arria® 10 GX FPGA +- Software +- OpenSUSE 15 (Kernel: 4.18.9-200.fc28.x86_64) +- Kubernetes 1.11 +- CRI-O 1.11.1 +- Intel® FPGA Device Plugin built from master branch + +### Demo steps + +1. Validate the status of the [Kubernetes cluster](https://kubernetes.io/docs/setup/independent/create-cluster-kubeadm/). +2. Clone the [Intel Device Plugins for Kubernetes source](https://github.com/intel/intel-device-plugins-for-kubernetes). +3. Provision the [admission controller webhook](https://github.com/intel/intel-device-plugins-for-kubernetes/blob/master/cmd/fpga_admissionwebhook/README.md). +4. Provision the [Intel® FPGA Device Plugin](https://github.com/intel/intel-device-plugins-for-kubernetes/blob/master/cmd/fpga_plugin/README.md). +5. Create bitstream storage for the Intel® FPGA. +6. Run the sample GZIP compression workload. + +[comment]: # (Video placeholder https://asciinema.org/a/UEZg2y8NLFUVARfzspBD5jIli)