openstack
/
cyborg-specs
Code Issues Proposed changes
Acceleration Management(cyborg) Specifications
116 Commits 1 Branch 0 Tags 1.6 MiB
Python 100%
Go to file
niuke a428a8500e Use TOX_CONSTRAINTS_FILE 
UPPER_CONSTRAINTS_FILE is old name and deprecated
This allows to use upper-constraints file as more
readable way instead of UPPER_CONSTRAINTS_FILE=<lower-constraints file>.

Change-Id: I1d14ad2649aa65a74876809b7e3e448adb1ce3dc
 		2022-09-15 17:15:27 +08:00
doc Create specs directory for Zed 2022-04-07 11:26:39 +08:00
specs Merge "Create specs directory for Zed" 2022-04-08 01:23:15 +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 [ussuri][goal] Update contributor documentation 2021-05-26 14:08:20 +00: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 the doc format 2021-06-09 01:53:48 +00:00
setup.cfg setup.cfg: Replace dashes with underscores 2021-04-28 11:27:02 +08: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 Use TOX_CONSTRAINTS_FILE 2022-09-15 17:15:27 +08: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 launchpad: https://blueprints.launchpad.net/openstack/openstack-cyborg

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.