6e049b6881
Cinder has always used a wiki page as the source of our
support matrix. Unfortunately the wiki gives us no way
to ensure that the information is accurate and makes it
harder to track changes. Moving to using the
sphinx-feature-classification library solves some of these
problems.
* It provides a programatic way to document driver support.
* It allows us to ensure that documentation is updated with
changes.
* It will provide a snapshot of the state of driver support
for a release at the time of release.
This matrix will serve as the truth for Cinder's driver support.
The existing wiki will be kept for historical purposes but I will
make a pointer to this new documentation and indicate that no
changes should be made to the wiki in the future.
Change-Id: I7c1b7fb539a48ec3b79e86c44ffe2d3005aeba25
58 lines
1.9 KiB
ReStructuredText
58 lines
1.9 KiB
ReStructuredText
..
|
|
Copyright (C) 2018 Lenovo, Inc.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
not use this file except in compliance with the License. You may obtain
|
|
a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
License for the specific language governing permissions and limitations
|
|
under the License.
|
|
|
|
============================
|
|
Cinder Driver Support Matrix
|
|
============================
|
|
|
|
The following support matrix reflects the drivers that are currently
|
|
available or are available in
|
|
`Cinder's driver tree <https://github.com/openstack/cinder/tree/master/cinder/volume/drivers>`_
|
|
at the time of release.
|
|
|
|
.. note::
|
|
|
|
This matrix replaces the old wiki based version of the Cinder Support
|
|
Matrix as there was no way to ensure the wiki version was properly
|
|
maintained. The old matrix will be left for reference but
|
|
this matrix should be treated as the correct state of Cinder.
|
|
|
|
Required Driver Functions
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
There are a number of functions that are required to be accepted as
|
|
a Cinder driver. Rather than list all the required functionality in the
|
|
matrix we include the list of required functions here for reference.
|
|
|
|
* Create Volume
|
|
* Delete Volume
|
|
* Attach Volume
|
|
* Detach Volume
|
|
* Extend Volume
|
|
* Create Snapshot
|
|
* Delete Snapshot
|
|
* Create Volume from Snapshot
|
|
* Create Volume from Volume (clone)
|
|
* Create Image from Volume
|
|
* Volume Migration (host assisted)
|
|
|
|
.. note::
|
|
|
|
Since the above functions are required their support is assumed and the
|
|
matrix only includes support for optional functionality.
|
|
|
|
.. support_matrix:: support-matrix.ini
|
|
|