README
¶
k8s-fpga-device-plugin
About
The Xilinx FPGA device plugin for Kubernetes is a Daemonset deployed on the Kubernetes(k8s) cluster which allows you to:
- Discover the FPGAs inserted in each node of the cluster and expose information about FPGA such as number of FPGA, Shell (Target Platform) type and etc.
- Run FPGA accessible containers in the k8s cluster
If you already have an docker and kubernetes environment, you can follow the Quick Start to test k8s-fpga-device-plugin on your own cluster. You can also check the Full Tutorial if you need to build docker, kuberetes cluster environment and test k8s-device-plugin from the beginning.
For detailed information about k8s-device-plugin, Docker and Kubernetes, you can renferece following links:
| Detailed Info | Description |
|---|---|
| Kubernetes device plugin | Kubernetes community documentation about Kubernetes plugin |
| Quick Start | Quick start on how to install and test k8s-device-plugin |
| K8s Cluster Full tutorial | Step by step tutorial starts from install container runtime and Kubernetes cluster |
| Virtual Device mode | Deploy the deivce plugin in Virtual Device mode to allow nyltiple pods to share one single device |
| Device Name Customization | Customize the device registered name in K8s cluster |
| FAQ | Frequently asked questions |
Prerequisites
- All FPGAs have the Shell(Target Platform) flashed already
- XRT(version is no older than 2018.3) installed on all worker nodes where there are FPGA(s) inserted
- Container runtime in k8s is docker or containerD
- k8s version >= 1.17 (all tests have been running with version 1.17. Old version may or may not work)
- Go 1.18.3 is required if you want to build the device plugin source code
Contact
Email: [email protected]
Documentation
¶
Overview ¶
Copyright 2018-2022, Xilinx, Inc. Copyright 2023, Advanced Micro Device, Inc. Author: Brian Xu([email protected]) For technical support, please contact [email protected]
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright 2018-2022, Xilinx, Inc. Copyright 2023, Advanced Micro Device, Inc. Author: Brian Xu([email protected]) For technical support, please contact [email protected]
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Source Files