From 009a6ebfb608b9227903abdadf73b23b4e0da7e4 Mon Sep 17 00:00:00 2001 From: Dmitry Rozhkov Date: Fri, 17 Aug 2018 13:58:01 +0300 Subject: [PATCH] clarify fpga plugin modes in README.md --- cmd/fpga_plugin/README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/cmd/fpga_plugin/README.md b/cmd/fpga_plugin/README.md index 7d5a0f5b..2e7becf9 100644 --- a/cmd/fpga_plugin/README.md +++ b/cmd/fpga_plugin/README.md @@ -30,7 +30,15 @@ $ ls /var/lib/kubelet/device-plugins/kubelet.sock ### Choose mode for FPGA device plugin -You can run the FPGA device plugin in either af or region mode. +You can run the FPGA device plugin in either `af` or `region` mode. + +In `af` mode, the device plugin exposes accelerator functions +programmed onto the device as resources. Accelerator functions identified +by the same AFU ID are translated to resources of the same type. + +In `region` mode, the device plugin exposes partial reconfiguration regions +as consumable resources. Regions with the same interface ID are +translated to resources of the same type. #### Run FPGA device plugin in af mode