Pike doc clean up
Several clean up performed in this patch: * remove readme in the doc/source * move installation.rst and usage.rst to the new userdoc/ * add api.rst to userdoc/ * add introduction.rst in doc/source * add index.rst in every folder * add release info in every spec Change-Id: I9ea96993f916b753cc1aa16c2ea2983b93922f23 Signed-off-by: zhipengh <huangzhipeng@huawei.com>
This commit is contained in:
zhipengh
parent
10392352f2
commit
5ee1144e75
12
README.rst
12
README.rst
@ -1,12 +1,11 @@
|
||||
===============================
|
||||
cyborg
|
||||
Cyborg
|
||||
===============================
|
||||
|
||||
Distributed Acceleration Management as a Service
|
||||
OpenStack Acceleration as a Service
|
||||
|
||||
Please feel here a long description which must be at least 3 lines wrapped on
|
||||
80 cols, so that distribution package maintainers can use it in their packages.
|
||||
Note that this is a hard requirement.
|
||||
Cyborg provides a general management framework for accelerators such as
|
||||
FPGA, GPU, SoCs, NVMe SSDs, CCIX caches, DPDK/SPDK, pmem and so forth.
|
||||
|
||||
* Free software: Apache license
|
||||
* Source: https://git.openstack.org/cgit/openstack/cyborg
|
||||
@ -16,4 +15,5 @@ Note that this is a hard requirement.
|
||||
Features
|
||||
--------
|
||||
|
||||
* TODO
|
||||
* REST API for basic accelerator life cycle management
|
||||
* Generic driver for common accelerator support
|
||||
|
||||
14
doc/source/devdoc/specs/index.rst
Normal file
14
doc/source/devdoc/specs/index.rst
Normal file
@ -0,0 +1,14 @@
|
||||
Cyborg Specs
|
||||
============
|
||||
|
||||
Pike
|
||||
----
|
||||
|
||||
This section has a list of specs for Pike release.
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
specs/pike/approved/*
|
||||
@ -154,8 +154,11 @@ Other Cyborg Specs
|
||||
History
|
||||
=======
|
||||
|
||||
|
||||
.. list-table:: Revisions
|
||||
:header-rows: 1
|
||||
|
||||
* - Release
|
||||
- Description
|
||||
* - Pike
|
||||
- Introduced
|
||||
@ -132,8 +132,11 @@ Cyborg Agent Spec
|
||||
History
|
||||
=======
|
||||
|
||||
|
||||
.. list-table:: Revisions
|
||||
:header-rows: 1
|
||||
|
||||
* - Release
|
||||
- Description
|
||||
* - Pike
|
||||
- Introduced
|
||||
@ -146,4 +146,16 @@ None
|
||||
References
|
||||
==========
|
||||
|
||||
None
|
||||
None
|
||||
|
||||
History
|
||||
=======
|
||||
|
||||
|
||||
.. list-table:: Revisions
|
||||
:header-rows: 1
|
||||
|
||||
* - Release
|
||||
- Description
|
||||
* - Pike
|
||||
- Introduced
|
||||
@ -3,18 +3,50 @@
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to cyborg's documentation!
|
||||
Welcome to Cyborg's documentation!
|
||||
========================================================
|
||||
Cyborg is a general management framework for accelerators
|
||||
|
||||
Contents:
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
introduction
|
||||
architecture
|
||||
|
||||
User Documentation
|
||||
----------
|
||||
|
||||
**Installation**
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
userdoc/installation.rst
|
||||
userdic/usage.rst
|
||||
|
||||
**API**
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
userdoc/api.rst
|
||||
|
||||
Developer Documentation
|
||||
-----------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
devdoc/contributing.rst
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
readme
|
||||
installation
|
||||
usage
|
||||
contributing
|
||||
devdoc/index
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
40
doc/source/introduction.rst
Normal file
40
doc/source/introduction.rst
Normal file
@ -0,0 +1,40 @@
|
||||
Introduction
|
||||
============
|
||||
|
||||
Background Story
|
||||
----------------
|
||||
|
||||
OpenStack Acceleration Discussion Started from Telco Requirements:
|
||||
|
||||
* High level requirements first drafted in the standard organization ETSI NFV ISG
|
||||
* High level requirements transformed into detailed requirements in OPNFV DPACC project.
|
||||
* New project called Nomad established to address the requirements.
|
||||
* BoF discussions back in OpenStack Austin Summit.
|
||||
|
||||
Transition to Cyborg Project:
|
||||
|
||||
* From a long period of conversation and discussion within the OpenStack community,
|
||||
we found that the initial goal of Nomad project to address acceleration management
|
||||
in Telco is too limited. From design summit session in Barcelona Summit, we have
|
||||
developers from Scientific WG help us understanding the need for acceleration management
|
||||
in HPC cloud, and we also had a lot of discussion on the Public Cloud support of
|
||||
accelerated instances.
|
||||
|
||||
* We decide to formally establish a project that will work on the management framework
|
||||
for dedicated devices in OpenStack, and there comes the Cyborg Project.
|
||||
|
||||
Definition Breakdown
|
||||
--------------------
|
||||
|
||||
**General Management Framework:**
|
||||
* Resource Discovery
|
||||
* Life Cycle Management
|
||||
|
||||
|
||||
**Accelerators:**
|
||||
* Software: dpdk/spdk, pmem, ...
|
||||
* Hardware: FPGA, GPU, ARM SoC, NVMe SSD, CCIX based Caches, ...
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1 +0,0 @@
|
||||
.. include:: ../../README.rst
|
||||
23
doc/source/userdoc/api.rst
Normal file
23
doc/source/userdoc/api.rst
Normal file
@ -0,0 +1,23 @@
|
||||
Cyborg REST API v1.0
|
||||
********************
|
||||
|
||||
General Information
|
||||
===================
|
||||
|
||||
This document describes the basic REST API operation that Cyborg supports
|
||||
for Pike release.
|
||||
|
||||
+--------+-----------------------+-------------------------------------------------------------------------------+
|
||||
| Verb | URI | Description |
|
||||
+========+=======================+===============================================================================+
|
||||
| GET | /accelerators | Return a list of accelerators |
|
||||
+--------+-----------------------+-------------------------------------------------------------------------------+
|
||||
| GET | /accelerators/{uuid} | Retrieve a certain accelerator info identified by `{uuid}` |
|
||||
+--------+-----------------------+-------------------------------------------------------------------------------+
|
||||
| POST | /accelerators | Create a new accelerator. |
|
||||
+--------+-----------------------+-------------------------------------------------------------------------------+
|
||||
| PUT | /accelerators/{uuid} | Update the spec for the accelerator identified by `{uuid}` |
|
||||
+--------+-----------------------+-------------------------------------------------------------------------------+
|
||||
| DELETE | /accelerators/{uuid} | Delete the accelerator identified by `{uuid}` |
|
||||
+--------+-----------------------+-------------------------------------------------------------------------------+
|
||||
|
||||
Loading…
Reference in New Issue
Block a user