fpga_crihook

README

Intel FPGA OCI createRuntime hook for Kubernetes

Table of Contents

• Introduction
• Dependencies
• Configuring CRI runtimes

Introduction

The FPGA CDI hook is one of the components used to add support for Intel FPGA devices to Kubernetes.

The FPGA OCI createRuntime hook is passed by the FPGA device plugin as a CDI device attribute to the Kubelet and then to the CRI runtime. It performs discovery of the requested FPGA function bitstream and then programs FPGA devices based on the environment variables in the workload description.

The hook is only required when the FPGA admission webhook is configured for orchestration programmed mode, and is benign (un-used) otherwise.

Note: The fpga CDI hook is usually installed by the same DaemonSet as the FPGA device plugin. If building and installing the hook by hand, it is recommended you reference the fpga plugin DaemonSet YAML for more details.

Dependencies

This component is one of a set of components that work together. You may also want to install the following:

• FPGA device plugin
• FPGA admission controller

All components have the same basic dependencies as the generic plugin framework dependencies

See the development guide for details if you want to deploy a customized version of the CRI hook.

Configuring CRI runtimes

CDI should be enabled for the CRI runtime to call the hook. CRI-O has it enabled by default and for Containerd it should be enabled explicitly in its configuration file as explained in the CDI documentation