Yumeng Bao bf94ef8bdd update API documentation

The existed API documentation is not clear enough, which
caused misleading and confusion to end users and developers from other
community when talking about cyborg support in CNTT[1]. This patch updated the documentation to improve and avoid this kind of misleading.

[1] http://eavesdrop.openstack.org/meetings/openstack_cyborg/2020/openstack_cyborg.2020-07-09-03.01.log.html
Story: 2007809
Task: 40301

Change-Id: I3f882aa7c32b7439ab86e6658772f3d7630ab0c9

2020-07-15 12:42:47 +00:00

2.2 KiB

Raw Blame History

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

install/install-from-pip install/install-from-source admin/config-wsgi

Configuration Reference

configuration/index reference/support-matrix

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.

Documentation for Developers

contributor/contributing contributor/devstack_setup contributor/driver-development-guide

Indices and tables

search

2.2 KiB Raw Blame History