openstack/deb-cinder
Code Issues Proposed changes

Merge "Add CI_WIKI_NAME to driver's devref"

Browse Source
This commit is contained in:
Jenkins 2016-08-17 02:37:47 +00:00 committed by Gerrit Code Review
commit e89b0179e4
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/source/devref/drivers.rst
View File

@ -21,6 +21,19 @@ Cinder exposes an API to users to interact with different storage backend
solutions. The following are standards across all drivers for Cinder services
to properly interact with a driver.
Basic attributes
----------------
There are some basic attributes that all drivers classes should have:
* VERSION: Driver version in string format. No naming convention is imposed,
although semantic versioning is recommended.
* CI_WIKI_NAME: Must be the exact name of the ThirdPartySystems wiki page.
This is used by our tooling system to associated jobs to drivers and
track their CI reporting status correctly.
The tooling system will also use the name and docstring of the driver class.
Minimum Features
----------------