Xilinx XRT Ansible Role

This Ansible role installs the Xilinx XRT, which is needed to run applications that use Xilinx FPGA devices.

Requirements

You need a compatible Xilinx FPGA device on the target host.
The role must be run as root on the target host.

Role Variables

• xilinx_xrt_install: If true, install XRT. Default is true.
• xilinx_xrt_version: The version of Xilinx XRT to install. Default is the latest version.
• xilinx_xrt_from_src: If true, install XRT from the source instead of using Xilinx packages. Default is false.
• xilinx_xrt_env: Environment specific to XRT. Supported values: aws, azure. Defaults to the standard Xilinx XRT environment if not specified.
• xilinx_xrt_platforms: List of FPGA platforms to install related packages. Supported options: u50, u55c, u200, u250, u280.
• xilinx_xrt_ensure_compatible_kernel: If true, check that the installed Linux kernel is compatible. Default is false.
• xilinx_xrt_bashrc: If true, add the XRT setup script source to the user’s ~/.bashrc. Default is false.
• xilinx_xrt_check_fpga: If true, check if XRT is installed correctly by detecting the FPGA. Default is false.
• xilinx_xrt_container: Set to true if running the role inside a container to avoid kernel version issues. Default is false.
• xilinx_xrt_rhel7_devtoolset: Red Hat Developer Toolset version to use on RHEL/CentOS 7 if not installed by XRT dependencies. Default is 9, effective only if xilinx_xrt_from_src is false.

AWS FPGA

If xilinx_xrt_env is set to aws, the following additional variables are available:

• aws_fpga_install: If true, install AWS FPGA runtime libraries. Default is true.
• aws_fpga_src_install: If specified, install AWS FPGA sources in the given directory. Default is not to install sources.
• aws_fpga_version: AWS FPGA version to install. Default is the latest version.
• aws_fpga_allow_non_root: If true, allow FPGA access to all users or a specific group. Default is false.
• aws_fpga_sdk_others: If true, allow FPGA access to all users else restrict to the group specified by aws_fpga_sdk_group. Default is false and has no effect if aws_fpga_allow_non_root is false.
• aws_fpga_sdk_group: Name of the user group that can access FPGA devices. Default is fpgauser. No effect if aws_fpga_allow_non_root is false or aws_fpga_sdk_others is true.
• aws_fpga_sdk_override_group: If true, do not raise an error if the aws_fpga_sdk_group already exists. Default is false and has no effect if aws_fpga_allow_non_root is false or aws_fpga_sdk_others is true.
• aws_fpga_driver: If specified, install the given alternate driver; otherwise, use the default XOCL driver. This may require xilinx_xrt_install to be set to false. Supported value: xdma.

Xilinx Video SDK

Extra variable for Xilinx Video SDK used with Alveo U30/AWS VT1:

• xilinx_video_sdk_install: If true, install Xilinx video SDK. Default is false.
• xilinx_video_sdk_version: The version of Xilinx video SDK to install. Default is the latest version.
  (Note: xilinx_xrt_install is set to false when installing the Xilinx video SDK since it includes XRT.)

Example Playbook

Here is an example of how to use this role:

- hosts: servers
  become: true  
  roles:
     - role: accelize.xilinx_xrt

Dependencies

If xilinx_xrt_ensure_compatible_kernel is set to true, the role accelize.linux_kernel is required.

License

Copyright Accelize 2019, Apache 2.0

Installed components licenses:

• Xilinx XRT license
• Xilinx Video SDK license
• AWS FPGA license

This Ansible role is not endorsed or affiliated with Xilinx or AWS.

Author Information

This role is provided by Accelize.