diff options
author | Sundar Nadathur <sundar.nadathur@intel.com> | 2020-03-30 18:50:46 -0700 |
---|---|---|
committer | zhangbailin <zhangbailin@inspur.com> | 2020-04-03 17:13:04 +0800 |
commit | 0a795a3b64a25bd03ea520309ff555935112d9ee (patch) | |
tree | 5aff4890cc8a240709ea12fd86cdf72b9d9dd999 /api-guide | |
parent | acc0dc31c3793b6783345c9abea644bbe8ec56e3 (diff) | |
download | nova-0a795a3b64a25bd03ea520309ff555935112d9ee.tar.gz |
Add release notes for Cyborg-Nova integration.
Change-Id: I4b630d755f99863faf6a432b086608d494ef3cc3
Blueprint: nova-cyborg-interaction
Diffstat (limited to 'api-guide')
-rw-r--r-- | api-guide/source/accelerator-support.rst | 56 | ||||
-rw-r--r-- | api-guide/source/index.rst | 1 |
2 files changed, 57 insertions, 0 deletions
diff --git a/api-guide/source/accelerator-support.rst b/api-guide/source/accelerator-support.rst new file mode 100644 index 0000000000..6d66a22e12 --- /dev/null +++ b/api-guide/source/accelerator-support.rst @@ -0,0 +1,56 @@ +============================== +Using accelerators with Cyborg +============================== + +Starting from microversion 2.82, nova supports creating servers with +accelerators provisioned with the Cyborg service, which provides lifecycle +management for accelerators. + +To launch servers with accelerators, the administrator (or an user with +appropriate privileges) must do the following: + + * Create a device profile in Cyborg, which specifies what accelerator + resources need to be provisioned. (See `Cyborg device profiles API + <https://docs.openstack.org/api-ref/accelerator/v2/index.html#device-profiles>`_. + + * Set the device profile name as an extra spec in a chosen flavor, + with this syntax: + + .. code:: + + accel:device_profile=$device_profile_name + + The chosen flavor may be a newly created one or an existing one. + + * Use that flavor to create a server: + + .. code:: + + openstack server create --flavor $myflavor --image $myimage $servername + +As of 21.0.0 (Ussuri), nova supports only specific operations for instances +with accelerators. The lists of supported and unsupported operations are as +below: + + * Supported operations. + + * Creation and deletion. + * Reboots (soft and hard). + * Pause and unpause. + * Stop and start. + * Take a snapshot. + * Backup. + * Rescue and unrescue. + + * Unsupported operations + + * Rebuild. + * Resize. + * Evacuate. + * Suspend and resume. + * Shelve and unshelve. + * Cold migration. + * Live migration. + +Some operations, such as lock and unlock, work as they are effectively +no-ops for accelerators. diff --git a/api-guide/source/index.rst b/api-guide/source/index.rst index 6763b73c08..2e6ac8042b 100644 --- a/api-guide/source/index.rst +++ b/api-guide/source/index.rst @@ -88,3 +88,4 @@ Contents request_and_response_formats down_cells port_with_resource_request + accelerator-support |