"Fossies" - the Fresh Open Source Software Archive 
As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) reStructured Text source code syntax highlighting (style:
standard) with prefixed line numbers.
Alternatively you can here
view or
download the uninterpreted source code file.
1 OpenStack Accelerator (Cyborg)
2 ==============================
3
4 Cyborg is a general management framework for accelerators
5
6
7 Overview
8 --------
9
10 .. toctree::
11 :maxdepth: 1
12
13 user/introduction
14 user/architecture
15 user/usage
16
17 Documentation for Operators
18 ----------------------------
19
20 The documentation in this section is aimed at Cloud
21 Operators needing to install or configure Cyborg.
22
23 Installation
24 ~~~~~~~~~~~~
25
26 .. toctree::
27 :maxdepth: 1
28
29 install/install-from-pip
30 install/install-from-source
31 admin/config-wsgi
32
33 Configuration Reference
34 ~~~~~~~~~~~~~~~~~~~~~~~
35
36 .. toctree::
37 :maxdepth: 2
38
39 configuration/index
40 reference/support-matrix
41
42 For End Users
43 -------------
44
45 As an end user of Cyborg, you'll use Cyborg to create and
46 manage accelerators with either tools or the API directly.
47
48 Tools for using Cyborg
49 ~~~~~~~~~~~~~~~~~~~~~~
50
51 Information on the commands available through Cyborg's Command Line
52 Interface (CLI) can be found in this section of documentation.
53
54 .. toctree::
55 :maxdepth: 1
56
57 cli/index
58
59 Using the API
60 ~~~~~~~~~~~~~
61
62 Following the Ussuri release, every Cyborg deployment should have the
63 following endpoints:
64
65 / - list of available versions
66
67 /v2 - the version 2 of the Acceleration API, it uses microversions
68
69 /v2.0 - same API as v2, except uses microversions
70
71 The follwoing guide concentrates on documenting the v2 API, please note that
72 the v2.0 is the first microversion of the v2 API and are also covered by this
73 guide.
74
75 * `Cyborg API Reference <https://docs.openstack.org/api-ref/accelerator/>`_:
76 The complete reference for the accelerator API, including all methods and
77 request / response parameters and their meaning.
78
79 * :doc:`/contributor/rest_api_version_history`: The Cyborg API evolves over
80 time through Microversions. This provides the history of all those changes.
81 Consider it a "what's new" in the Cyborg API.
82
83 Documentation for Developers
84 ----------------------------
85
86 .. toctree::
87 :maxdepth: 1
88
89 contributor/index
90 contributor/rest_api_version_history
91
92 Indices and tables
93 ==================
94
95 * :ref:`search`