2.4 KiB
OpenStack Accelerator (Cyborg)
Cyborg is a general management framework for accelerators
Overview
user/introduction user/architecture user/usage
Documentation for Operators
The documentation in this section is aimed at Cloud Operators needing to install or configure Cyborg.
Installation
The detailed install guide for Cyborg.
install/index admin/config-wsgi
Configuration Reference
configuration/index reference/support-matrix
Maintenance
Once you are running cyborg, the following information is extremely useful.
Admin Guide </admin/index>: A collection of guides for administrating cyborg.
admin/index
For End Users
As an end user of Cyborg, you'll use Cyborg to create and manage accelerators with either tools or the API directly.
Tools for using Cyborg
Information on the commands available through Cyborg's Command Line Interface (CLI) can be found in this section of documentation.
cli/index
Using the API
Following the Ussuri release, every Cyborg deployment should have the following endpoints:
/ - list of available versions
/v2 - the version 2 of the Acceleration API, it uses microversions
/v2.0 - same API as v2, except uses microversions
The follwoing guide concentrates on documenting the v2 API, please note that the v2.0 is the first microversion of the v2 API and are also covered by this guide.
- Cyborg API Reference: The complete reference for the accelerator API, including all methods and request / response parameters and their meaning.
/contributor/rest_api_version_history: The Cyborg API evolves over time through Microversions. This provides the history of all those changes. Consider it a "what's new" in the Cyborg API.
Documentation for Developers
contributor/index contributor/rest_api_version_history
Indices and tables
search