openstack/cinder
Code Issues Proposed changes

Add CI_WIKI_NAME to driver's devref

Browse Source 
The requirement to have CI_WIKI_NAME attribute in a driver is not
currently documented, which makes it harder for new drivers to know they
need to have this attribute.

This patch adds this requirement to the driver devref.

Change-Id: Ia49527c1ca15e3454e186fd6609794d87e630903
This commit is contained in:
Gorka Eguileor 2016-08-16 13:31:58 +02:00
parent f33fc3b69b
commit 3a7686fc6d
1 changed files with 13 additions and 0 deletions

13
doc/source/devref/drivers.rst

@ -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
----------------