You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: cmd/fpga_crihook/README.md
+13-17Lines changed: 13 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,20 +8,19 @@ Table of Contents
8
8
9
9
## Introduction
10
10
11
-
The FPGA CRI-O webhook is one of the components used to add support for Intel FPGA
11
+
The FPGA CDI hook is one of the components used to add support for Intel FPGA
12
12
devices to Kubernetes.
13
13
14
-
The FPGA prestart CRI-O hook is triggered by container annotations, such as set by the
15
-
[FPGA device plugin](../fpga_plugin/README.md). It performs discovery of the requested FPGA
16
-
function bitstream and then programs FPGA devices based on the environment variables
17
-
in the workload description.
14
+
The FPGA prestart hook is passed by the [FPGA device plugin](../fpga_plugin/README.md) as
15
+
a CDI device attribute to the Kubelet and then to the CRI runtime.
16
+
It performs discovery of the requested FPGA function bitstream and then programs FPGA devices
17
+
based on the environment variables in the workload description.
18
18
19
-
The CRI-O prestart hook is only *required* when the
20
-
[FPGA admission webhook](../fpga_admissionwebhook/README.md) is configured for orchestration
21
-
programmed mode, and is benign (un-used) otherwise.
19
+
The hook is only *required* when the [FPGA admission webhook](../fpga_admissionwebhook/README.md)
20
+
is configured for orchestration programmed mode, and is benign (un-used) otherwise.
22
21
23
-
> **Note:** The fpga CRI-O webhook is usually installed by the same DaemonSet as the
24
-
> FPGA device plugin. If building and installing the CRI-O webhook by hand, it is
22
+
> **Note:** The fpga CDI hook is usually installed by the same DaemonSet as the
23
+
> FPGA device plugin. If building and installing the hook by hand, it is
25
24
> recommended you reference the
26
25
> [fpga plugin DaemonSet YAML](/deployments/fpga_plugin/base/intel-fpga-plugin-daemonset.yaml) for
27
26
> more details.
@@ -39,11 +38,8 @@ All components have the same basic dependencies as the
39
38
40
39
See [the development guide](../../DEVEL.md) for details if you want to deploy a customized version of the CRI hook.
41
40
42
-
## Configuring CRI-O
41
+
## Configuring CRI runtimes
43
42
44
-
Recent versions of [CRI-O](https://github.com/cri-o/cri-o) are shipped with default configuration
45
-
file that prevents CRI-O to discover and configure hooks automatically.
46
-
For FPGA orchestration programmed mode, the OCI hooks are the key component.
47
-
Please ensure that your `/etc/crio/crio.conf` parameter `hooks_dir` is either unset
48
-
(to enable default search paths for OCI hooks configuration) or contains the directory
49
-
`/etc/containers/oci/hooks.d`.
43
+
CDI should be enabled for the CRI runtime to call the hook. CRI-O has it enabled by
44
+
default and for Containerd it should be enabled explicitly in its configuration file as
45
+
explained in the [CDI documentation](https://github.com/cncf-tags/container-device-interface?tab=readme-ov-file#how-to-configure-cdi)
0 commit comments