Acceleration Management(cyborg) Specifications
Go to file
wangzihao 3b8a78c2e2 Bump hacking min version to 3.0.1
hacking 3.0.1 fix the pinning of flake8 to avoid bringing in a new
version with new checks.

bumping the min version for hacking so that any older hacking versions
which auto adopt the new checks are not used.

Change-Id: Ida74041552060714de9a085ae99a6ef55a052778
2020-10-14 17:24:06 +08:00
doc Add yasfb to generate RSS feeds. 2020-09-14 12:03:26 +00:00
specs Merge "Add sriov reference for Intel QAT driver." 2020-09-30 02:32:14 +00:00
.coveragerc Initialize cyborg-specs repository 2018-03-22 16:07:07 +08:00
.gitignore Specification of Cyborg API microversion 2020-02-03 14:02:39 +08:00
.gitreview OpenDev Migration Patch 2019-04-19 19:48:29 +00:00
.mailmap Initialize cyborg-specs repository 2018-03-22 16:07:07 +08:00
.stestr.conf Initialize cyborg-specs repository 2018-03-22 16:07:07 +08:00
.zuul.yaml import zuul job settings from project-config 2018-08-17 14:47:10 +09:00
CONTRIBUTING.rst Initialize cyborg-specs repository 2018-03-22 16:07:07 +08:00
HACKING.rst Initialize cyborg-specs repository 2018-03-22 16:07:07 +08:00
LICENSE Initialize cyborg-specs repository 2018-03-22 16:07:07 +08:00
README.rst fix bug link in readme 2018-10-18 08:08:03 +00:00
setup.cfg Cleanup py27 support and docs 2020-04-09 21:47:26 +02:00
setup.py Cleanup py27 support and docs 2020-04-09 21:47:26 +02:00
test-requirements.txt Bump hacking min version to 3.0.1 2020-10-14 17:24:06 +08:00
tox.ini Change the doc8 check mode 2020-09-16 09:52:18 +00:00

README.rst

Team and repository tags

image

OpenStack Cyborg Specifications

This git repository is used to hold approved design specifications for additions to the Cyborg project. Reviews of the specs are done in gerrit, using a similar workflow to how we review and merge changes to the code itself.

The layout of this repository is:

specs/<release>/

Where there are two sub-directories:

specs/<release>/approved: specifications approved but not yet implemented specs/<release>/implemented: implemented specifications

This directory structure allows you to see what we thought about doing, decided to do, and actually got done. Users interested in functionality in a given release should only refer to the implemented directory.

You can find an example spec in doc/source/specs/template.rst.

To track all the blueprints of cyborg, please refer to the trello board: https://trello.com/b/4nFtHNSg/queens-dev

To validate that the specification is syntactically correct (i.e. get more confidence in the Jenkins result), please execute the following command:

$ tox

After running tox, the documentation will be available for viewing in HTML format in the doc/build/ directory.