Sundar Nadathur 95e01e6d38 Update driver section.
Apart from FPGA and GPU, we support other device types
today and will add more in the future.

Most of the operations are common to the drivers we support.
For example, all drivers support device discovery, VM
creation/deletion, etc. None of them support firmware/shell
update today.

Also, we need to include the supported product families and
any special notes for the driver.

So this update removes the per-device-type files for FPGA
and GPU, and instead adds per-driver notes.

Change-Id: Ic0836e5a8d470a0f185d8d73e4f9ae21dfa63e45
2019-10-04 08:31:46 -04:00

49 lines
1.6 KiB
ReStructuredText

=====================
Cyborg Support Matrix
=====================
Cyborg supports specific operations on VMs with attached accelerator
resources, which are generally a subset of the full set of VM operations
supported by Nova (`nova-vm-ops
<https://docs.openstack.org/api-guide/compute/server_concepts.html>`_).
In this release, these operations have a dependency on specific Nova
patches (`nova-patches
<https://review.opendev.org/#/q/status:open+project:openstack/nova+bp/nova-cyborg-interaction>`_).
They can be expected to work in Cyborg only
if and when these Nova patches get merged without significant changes.
These operations are not supported in this release since the dependencies
are not met.
.. list-table:: VM Operations Expected to Work With Nova Dependencies
:header-rows: 1
* - VM Operation
- Command
* - VM creation
- ``openstack server create``
* - VM deletion
- ``openstack server delete``
* - Reboot within VM
- ``ssh to VM and reboot in OS``
* - Soft reboot
- ``openstack server reboot --soft``
* - Pause/Unpause
- ``openstack server pause``, ``openstack server unpause``
* - Lock/Unlock
- ``openstack server lock``, ``openstack server unlock``
Operations not listed here may or may not work.
Driver Support
~~~~~~~~~~~~~~
The list of drivers available as part of the Cyborg distribution
at the time of release can be found in:
``cyborg.accelerator.driver`` section of `Cyborg's setup.cfg
<https://opendev.org/openstack/cyborg/src/branch/master/setup.cfg>`_
The following table provides additional information for individual drivers.
.. include:: driver-table.rst