crihook: update documentation

Author: bart0sh

README.md

@@ -66,7 +66,7 @@ The FPGA plugin comes as three parts.
 
 - the [device plugin](#device-plugin)
 - the [admission controller](#admission-controller)
-- the [CRIO-O prestart hook](#cri-o-prestart-hook)
+- the [CDI prestart hook](#CDI-prestart-hook)
 
 Refer to each individual sub-components documentation for more details.
 Brief overviews of the sub-components are below.
@@ -88,9 +88,9 @@ is responsible for performing mapping from user-friendly function IDs to the
 Interface ID and Bitstream ID that are required for FPGA programming. It also
 implements access control by namespacing FPGA configuration information.
 
-#### CRI-O Prestart Hook
+#### CDI Prestart Hook
 
-The [FPGA prestart CRI-O hook](cmd/fpga_crihook/README.md) performs discovery
+The [FPGA CDI prestart hook](cmd/fpga_crihook/README.md) performs discovery
 of the requested FPGA function bitstream and programs FPGA devices based on the
 environment variables in the workload description.
 

cmd/fpga_admissionwebhook/README.md

@@ -23,7 +23,7 @@ devices to Kubernetes.
 
 The FPGA admission controller webhook is responsible for performing mapping from user-friendly
 function IDs to the Interface ID and Bitstream ID that are required for FPGA programming by
-the [FPGA CRI-O hook](../fpga_crihook/README.md).
+the [FPGA CDI prestart hook](../fpga_crihook/README.md).
 
 Mappings are stored in namespaced custom resource definition (CRD) objects, therefore the admission
 controller also performs access control, determining which bitstream can be used for which namespace.
@@ -39,7 +39,7 @@ This component is one of a set of components that work together. You may also wa
 install the following:
 
 -   [FPGA device plugin](../fpga_plugin/README.md)
--   [FPGA prestart CRI-O hook](../fpga_crihook/README.md)
+-   [FPGA CDI prestart hook](../fpga_crihook/README.md)
 
 All components have the same basic dependencies as the
 [generic plugin framework dependencies](../../README.md#about)
@@ -129,7 +129,7 @@ The same mapping, but with its mode field set to `region`, would translate
 and the corresponding AF IDs are set in environment variables for the container.
 Though in this case the cluster administrator would probably want to rename
 the mapping `arria10.dcp1.2-nlb0-preprogrammed` to something like `arria10.dcp1.2-nlb0-orchestrated`
-to reflect its mode. The [FPGA CRI-O hook](../fpga_crihook/README.md) then loads the requested
+to reflect its mode. The [FPGA CDI prestart hook](../fpga_crihook/README.md) then loads the requested
 bitstream to a region before the container is started.
 
 Mappings of resource names are configured with objects of `AcceleratorFunction` and
@@ -183,4 +183,4 @@ and they are applicable to pods created in the corresponding namespaces.
 
 ## Next steps
 
-Continue with [FPGA prestart CRI-O hook](../fpga_crihook/README.md).
+Continue with [FPGA CDI prestart hook](../fpga_crihook/README.md).

cmd/fpga_crihook/README.md

@@ -1,27 +1,26 @@
-# Intel FPGA prestart CRI-O webhook for Kubernetes
+# Intel FPGA CDI prestart hook for Kubernetes
 
 Table of Contents
 
 * [Introduction](#introduction)
 * [Dependencies](#dependencies)
-* [Configuring CRI-O](#configuring-cri-o)
+* [Configuring CRI runtimes](#configuring-cri-runtimes)
 
 ## Introduction
 
-The FPGA CRI-O webhook is one of the components used to add support for Intel FPGA
+The FPGA CDI hook is one of the components used to add support for Intel FPGA
 devices to Kubernetes.
 
-The FPGA prestart CRI-O hook is triggered by container annotations, such as set by the
-[FPGA device plugin](../fpga_plugin/README.md).  It performs discovery of the requested FPGA
-function bitstream and then programs FPGA devices based on the environment variables
-in the workload description.
+The FPGA prestart hook is passed by the [FPGA device plugin](../fpga_plugin/README.md) 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 CRI-O prestart hook is only *required* when the
-[FPGA admission webhook](../fpga_admissionwebhook/README.md) is configured for orchestration
-programmed mode, and is benign (un-used) otherwise.
+The hook is only *required* when the [FPGA admission webhook](../fpga_admissionwebhook/README.md)
+is configured for orchestration programmed mode, and is benign (un-used) otherwise.
 
-> **Note:** The fpga CRI-O webhook is usually installed by the same DaemonSet as the
-> FPGA device plugin. If building and installing the CRI-O webhook by hand, it is
+> **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](/deployments/fpga_plugin/base/intel-fpga-plugin-daemonset.yaml ) for
 > more details.
@@ -39,11 +38,8 @@ All components have the same basic dependencies as the
 
 See [the development guide](../../DEVEL.md) for details if you want to deploy a customized version of the CRI hook.
 
-## Configuring CRI-O
+## Configuring CRI runtimes
 
-Recent versions of [CRI-O](https://github.com/cri-o/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.
-Please ensure that your `/etc/crio/crio.conf` parameter `hooks_dir` is either unset
-(to enable default search paths for OCI hooks configuration) or contains the directory
-`/etc/containers/oci/hooks.d`.
+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](https://github.com/cncf-tags/container-device-interface?tab=readme-ov-file#how-to-configure-cdi)

cmd/fpga_plugin/README.md

@@ -47,18 +47,18 @@ Kubernetes:
     which can be used to dynamically convert logical resource names in pod specifications into actual FPGA
     resource names, as advertised by the device plugin.
 
-    The webhook can also set environment variables to instruct the CRI-O prestart hook to program the FPGA
+    The webhook can also set environment variables to instruct the CDI prestart hook to program the FPGA
     before launching the container.
 
     > **NOTE:** Installation of the [FPGA admission controller webhook](../fpga_admissionwebhook/README.md) can be skipped if the
     > FPGA device plugin is operated with the Intel Device Plugins Operator
     > since it integrates the controller's functionality.
     > However, [the mappings](../fpga_admissionwebhook/README.md#mappings-deployment) still must be deployed."
 
--   [FPGA CRI-O prestart hook](../fpga_crihook/README.md)
+-   [FPGA CDI prestart hook](../fpga_crihook/README.md)
 
-    A [CRI-O](https://github.com/cri-o/cri-o) prestart hook that, upon instruction from the FPGA admission
-    controller, allocates and programs the FPGA before the container is launched.
+    A [CDI](https://github.com/cncf-tags/container-device-interface) prestart hook that, upon instruction from the FPGA admission
+    controller, programs the FPGA before the container is launched.
 
 The repository also contains an [FPGA helper tool](../fpga_tool/README.md) that may be useful during
 development, initial deployment and debugging.
@@ -102,15 +102,14 @@ major components:
 
 -   [FPGA device plugin](README.md) (this component)
 -   [FPGA admission controller webhook](../fpga_admissionwebhook/README.md)
--   [FPGA prestart CRI-O hook](../fpga_crihook/README.md)
+-   [FPGA CDI prestart hook](../fpga_crihook/README.md)
 
-The CRI-O hook is only *required* if `region` mode is being used, but is installed by default by the
+The CDI hook is only *required* if `region` mode is being used, but is installed by default by the
 [FPGA plugin DaemonSet YAML](/deployments/fpga_plugin/base/intel-fpga-plugin-daemonset.yaml), and is benign
 in `af` mode.
 
-If using the `af` mode, and therefore *not* using the
-CRI-O prestart hook, runtimes other than CRI-O can be used (that is, the CRI-O hook presently
-*only* works with the CRI-O runtime).
+If using the `af` mode, and therefore *not* using the CDI prestart hook, any runtime can be used
+(that is, the CDI is not supported by all runtimes).
 
 The FPGA device plugin requires a Linux Kernel FPGA driver to be installed and enabled to
 operate. The plugin supports the use of either of following two drivers, and auto detects
@@ -147,7 +146,7 @@ The following images are available on the Docker hub:
 
 - [The FPGA plugin](https://hub.docker.com/r/intel/intel-fpga-plugin)
 - [The FPGA admisson webhook](https://hub.docker.com/r/intel/intel-fpga-admissionwebhook)
-- [The FPGA CRI-O prestart hook (in the `initcontainer` image)](https://hub.docker.com/r/intel/intel-fpga-initcontainer)
+- [The FPGA CDI prestart hook (in the `initcontainer` image)](https://hub.docker.com/r/intel/intel-fpga-initcontainer)
 
 Depending on the FPGA mode, run either
 ```bash
@@ -207,7 +206,7 @@ $ kubectl annotate node <node_name> 'fpga.intel.com/device-plugin-mode=af'
 And restart the pods on the nodes.
 
 > **Note:** The FPGA plugin [DaemonSet YAML](/deployments/fpga_plugin/base/intel-fpga-plugin-daemonset.yaml)
-> also deploys the [FPGA CRI-O hook](../fpga_crihook/README.md) `initcontainer` image, but it will be
+> also deploys the [FPGA CDI prestart hook](../fpga_crihook/README.md) `initcontainer` image, but it will be
 > benign (un-used) when running the FPGA plugin in `af` mode.
 
 #### Verify Plugin Registration
@@ -223,6 +222,6 @@ fpga.intel.com/region-ce48969398f05f33946d560708be108a:  1
 ```
 
 > **Note:** The FPGA plugin [DaemonSet YAML](/deployments/fpga_plugin/fpga_plugin.yaml)
-> also deploys the [FPGA CRI-O hook](../fpga_crihook/README.md) `initcontainer` image as well. You may
+> also deploys the [FPGA CDI prestart hook](../fpga_crihook/README.md) `initcontainer` image as well. You may
 > also wish to build that image locally before deploying the FPGA plugin to avoid deploying
 > the Docker hub default image.