From 6e049b6881ad5dcccb50296019dd4447949ee6c3 Mon Sep 17 00:00:00 2001 From: "Jay S. Bryant" Date: Fri, 6 Jul 2018 15:26:32 -0500 Subject: [PATCH] Add sphinx-feature-classification based support matrix 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 --- doc/source/conf.py | 1 + doc/source/index.rst | 1 + doc/source/reference/support-matrix.ini | 833 ++++++++++++++++++++++++ doc/source/reference/support-matrix.rst | 57 ++ lower-constraints.txt | 1 + requirements.txt | 1 + 6 files changed, 894 insertions(+) create mode 100644 doc/source/reference/support-matrix.ini create mode 100644 doc/source/reference/support-matrix.rst diff --git a/doc/source/conf.py b/doc/source/conf.py index 2ec6d7fb31d..5a1b99faf43 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -54,6 +54,7 @@ sys.path.insert(0, os.path.abspath('./')) extensions = ['sphinx.ext.coverage', 'sphinx.ext.graphviz', + 'sphinx_feature_classification.support_matrix', 'openstackdocstheme', 'stevedore.sphinxext', 'oslo_config.sphinxconfiggen', diff --git a/doc/source/index.rst b/doc/source/index.rst index 8eb721a962c..bcaf03a7ab7 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -60,6 +60,7 @@ Configuration Reference :maxdepth: 2 configuration/index + reference/support-matrix drivers CLI Reference diff --git a/doc/source/reference/support-matrix.ini b/doc/source/reference/support-matrix.ini new file mode 100644 index 00000000000..3b6977ccac0 --- /dev/null +++ b/doc/source/reference/support-matrix.ini @@ -0,0 +1,833 @@ +# 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. + +##################################################################### +# Drivers: + +[driver.coprhd] +title=CoprHD Storage Driver (FC, iSCSI, ScaleIO) + +[driver.datacore] +title=DataCore Storage Driver (FC, iSCSI) + +[driver.datera] +title=Datera Storage Driver (iSCSI) + +[driver.dell_emc_xtremeio] +title=Dell EMC XtremeIO Storage Driver (FC, iSCSI) + +[driver.dell_emc_powermax] +title=Dell EMC PowerMax (2000, 8000) Storage Driver (iSCSI, FC) + +[driver.dell_emc_ps] +title=Dell EMC PS Series Storage Driver (iSCSI) + +[driver.dell_emc_sc] +title=Dell EMC SC Series Storage Driver (iSCSI, FC) + +[driver.dell_emc_vxflexos] +title=Dell EMC VxFlex OS (ScaleIO) Storage Driver (ScaleIO) + +[driver.dell_emc_unity] +title=Dell EMC Unity Storage Driver (FC, iSCSI) + +[driver.dell_emc_vmax_af] +title=Dell EMC VMAX Af (250F, 450F, 850F, 950F) Storage Driver (FC, iSCSI) + +[driver.dell_emc_vmax_3] +title=Dell EMC VMAX3 (100K, 200K, 400K) Storage Driver (iSCSI, FC) + +[driver.dell_emc_vmax_v2] +title=Dell EMC VMAX V2 (10K, 20K, 40K) Storage Driver (iSCSI, FC) + +[driver.dell_emc_vnx] +title=Dell EMC VNX Storage Driver (FC, iSCSI) + +[driver.fujitsu_eternus] +title=Fujitsu ETERNUS Driver (FC, iSCSI) + +[driver.hgst] +title=HGST Flash Storage Suite Driver (vgc) + +[driver.hpe_3par] +title=HPE 3PAR Storage Driver (FC, iSCSI) + +[driver.hpe_lefthand] +title=HPE Lefthand Driver (iSCSI) + +[driver.hpe_mmsa] +title=HPE MMSA Driver (iSCSI, FC) + +[driver.huawei_t_v1] +title=Huawei T Series V1 Driver (iSCSI, FC) + +[driver.huawei_t_v2] +title=Huawei T Series V2 Driver (iSCSI, FC) + +[driver.huawei_v3] +title=Huawei V3 Series Driver (iSCSI, FC) + +[driver.huawei_v5] +title=Huawei V5 Series Driver (iSCSI, FC) + +[driver.huawei_18000] +title=Huawei 18000 Series Driver (iSCSI, FC) + +[driver.huawei_dorado] +title=Huawei Dorado V3 Series Driver (iSCSI, FC) + +[driver.huawei_fusionstorage] +title=Huawei FusionStorage Driver (dsware) + +[driver.ibm_ds8k] +title=IBM DS8k Storage Driver (FC) + +[driver.ibm_flashsystem] +title=IBM Flashsystem Driver (iSCSI) + +[driver.ibm_gpfs] +title=IBM GPFS Storage Driver (gpfs) + +[driver.ibm_storwize] +title=IBM Storwize SVC Storage Driver (iSCSI, FC) + +[driver.ibm_xiv] +title=IBM XIV Storage Driver (iSCSI, FC) + +[driver.infinidat] +title=Infinidat Storage Driver (iSCSI, FC) + +[driver.inspur] +title=Inspur G2 Storage Driver (iSCSI, FC) + +[driver.itri_disco] +title=ITRI DISCO Driver (DISCO) + +[driver.kaminario] +title=Kaminario Storage Driver (iSCSI, FC) + +[driver.lenovo] +title=Lenovo Storage Driver (FC, iSCSI) + +[driver.linbit_drbd] +title=LinBit DRDB Driver (DRBD) + +[driver.lvm] +title=Logical Volume Manager (LVM) Reference Driver (iSCSI) + +[driver.nec] +title=NEC Storage M Series Driver (iSCSI, FC) + +[driver.netapp_ontap] +title=NetApp Data ONTAP Driver (iSCSI, NFS, FC) + +[driver.netapp_e_ef] +title=NetApp E/EF Series Driver (iSCSI, FC) + +[driver.netapp_solidfire] +title=NetApp Solidfire Driver (iSCSI) + +[driver.nexenta] +title=Nexenta Driver (iSCSI, NFS) + +[driver.nfs] +title=Generic NFS Reference Driver (NFS) + +[driver.nimble] +title=Nimble Storage Driver (iSCSI) + +[driver.prophetstor] +title=ProphetStor Flexvisor Driver (iSCSI, NFS) + +[driver.oracle_zfssa] +title=Oracle ZFSSA Driver (iSCSI, NFS) + +[driver.pure] +title=Pure Storage Driver (iSCSI, FC) + +[driver.qnap] +title=QNAP Storage Driver (iSCSI) + +[driver.quobyte] +title=Quobyte Storage Driver (quobyte) + +[driver.rbd] +title=RBD (Ceph) Storage Driver (RBD) + +[driver.sheepdog] +title=Sheepdog Storage Driver (sheepdog) + +[driver.storpool] +title=StorPool Storage Driver (storpool) + +[driver.synology] +title=Synology Storage Driver (iSCSI) + +[driver.tintri] +title=Tintri Storage Driver (NFS) + +[driver.vrtshyperscale] +title=Veritas HyperScale Driver (veritas) + +[driver.vrtsaccess] +title=Veritas Access iSCSI Driver (iSCSI) + +[driver.vrtscnfs] +title=Veritas Cluster NFS Driver (NFS) + +[driver.vzstorage] +title=Virtuozzo Storage Driver (remotefs) + +[driver.vmware] +title=VMWare Storage Driver (vmdk) + +[driver.win_iscsi] +title=Windows iSCSI Driver + +[driver.win_smb] +title=Windows SMB Driver + +[driver.zadara] +title=Zadara Storage Driver (iSCSI, NFS) + +##################################################################### +# Functions: +[operation.supported] +title=Supported Vendor Driver +status=optional +notes=A vendor driver is considered supported if the vendor is + running a third party CI that regularly runs and reports + accurate results. If a vendor doesn't meet this requirement + the driver is marked unsupported and is removed if the problem + isn't resolved before the end of the subsequent release. +driver.coprhd=missing +driver.datacore=missing +driver.datera=complete +driver.dell_emc_powermax=complete +driver.dell_emc_ps=complete +driver.dell_emc_sc=complete +driver.dell_emc_unity=complete +driver.dell_emc_vmax_af=complete +driver.dell_emc_vmax_3=complete +driver.dell_emc_vmax_v2=complete +driver.dell_emc_vnx=complete +driver.dell_emc_vxflexos=complete +driver.dell_emc_xtremeio=complete +driver.fujitsu_eternus=complete +driver.hgst=missing +driver.hpe_3par=complete +driver.hpe_lefthand=complete +driver.hpe_mmsa=complete +driver.huawei_t_v1=complete +driver.huawei_t_v2=complete +driver.huawei_v3=complete +driver.huawei_v5=complete +driver.huawei_18000=complete +driver.huawei_dorado=complete +driver.huawei_fusionstorage=complete +driver.infinidat=complete +driver.ibm_ds8k=complete +driver.ibm_flashsystem=complete +driver.ibm_gpfs=complete +driver.ibm_storwize=complete +driver.ibm_xiv=complete +driver.inspur=complete +driver.itri_disco=missing +driver.kaminario=complete +driver.lenovo=complete +driver.linbit_drbd=complete +driver.lvm=complete +driver.nec=complete +driver.netapp_ontap=complete +driver.netapp_e_ef=complete +driver.netapp_solidfire=complete +driver.nexenta=complete +driver.nfs=complete +driver.nimble=complete +driver.oracle_zfssa=complete +driver.prophetstor=complete +driver.pure=complete +driver.qnap=complete +driver.quobyte=complete +driver.rbd=complete +driver.sheepdog=complete +driver.storpool=complete +driver.synology=complete +driver.tintri=complete +driver.vrtshyperscale=complete +driver.vrtsaccess=complete +driver.vrtscnfs=complete +driver.vzstorage=complete +driver.vmware=complete +driver.win_iscsi=complete +driver.win_smb=complete +driver.zadara=complete + +[operation.online_extend_support] +title=Extend an Attached Volume +status=optional +notes=Cinder supports the ability to extend a volume that is attached to + an instance, but not all drivers are able to do this. +driver.coprhd=complete +driver.datacore=complete +driver.datera=complete +driver.dell_emc_powermax=complete +driver.dell_emc_ps=complete +driver.dell_emc_sc=complete +driver.dell_emc_unity=complete +driver.dell_emc_vmax_af=complete +driver.dell_emc_vmax_3=complete +driver.dell_emc_vmax_v2=complete +driver.dell_emc_vnx=complete +driver.dell_emc_vxflexos=complete +driver.dell_emc_xtremeio=complete +driver.fujitsu_eternus=complete +driver.hgst=complete +driver.hpe_3par=complete +driver.hpe_lefthand=complete +driver.hpe_mmsa=complete +driver.huawei_t_v1=complete +driver.huawei_t_v2=complete +driver.huawei_v3=complete +driver.huawei_v5=complete +driver.huawei_18000=complete +driver.huawei_dorado=complete +driver.huawei_fusionstorage=complete +driver.infinidat=complete +driver.ibm_ds8k=complete +driver.ibm_flashsystem=complete +driver.ibm_gpfs=complete +driver.ibm_storwize=complete +driver.ibm_xiv=complete +driver.inspur=complete +driver.itri_disco=complete +driver.kaminario=complete +driver.lenovo=complete +driver.linbit_drbd=complete +driver.lvm=complete +driver.nec=complete +driver.netapp_ontap=missing +driver.netapp_e_ef=complete +driver.netapp_solidfire=complete +driver.nexenta=complete +driver.nfs=complete +driver.nimble=complete +driver.oracle_zfssa=complete +driver.prophetstor=complete +driver.pure=complete +driver.qnap=complete +driver.quobyte=complete +driver.rbd=complete +driver.sheepdog=complete +driver.storpool=complete +driver.synology=complete +driver.tintri=complete +driver.vrtshyperscale=complete +driver.vrtsaccess=complete +driver.vrtscnfs=complete +driver.vzstorage=complete +driver.vmware=complete +driver.win_iscsi=complete +driver.win_smb=complete +driver.zadara=complete + +[operation.attach_snapshot] +title=Snapshot Attachment +status=optional +notes=This is the ability to directly attach a snapshot to an + instance like a volume. +driver.coprhd=missing +driver.datacore=missing +driver.datera=missing +driver.dell_emc_powermax=missing +driver.dell_emc_ps=missing +driver.dell_emc_sc=missing +driver.dell_emc_unity=complete +driver.dell_emc_vmax_af=missing +driver.dell_emc_vmax_3=missing +driver.dell_emc_vmax_v2=missing +driver.dell_emc_vnx=complete +driver.dell_emc_vxflexos=complete +driver.dell_emc_xtremeio=missing +driver.fujitsu_eternus=missing +driver.hgst=missing +driver.hpe_3par=missing +driver.hpe_lefthand=missing +driver.hpe_mmsa=missing +driver.huawei_t_v1=complete +driver.huawei_t_v2=complete +driver.huawei_v3=complete +driver.huawei_v5=complete +driver.huawei_18000=complete +driver.huawei_dorado=complete +driver.huawei_fusionstorage=complete +driver.infinidat=missing +driver.ibm_ds8k=missing +driver.ibm_flashsystem=missing +driver.ibm_gpfs=missing +driver.ibm_storwize=complete +driver.ibm_xiv=missing +driver.inspur=complete +driver.itri_disco=missing +driver.kaminario=missing +driver.lenovo=missing +driver.linbit_drbd=missing +driver.lvm=missing +driver.nec=complete +driver.netapp_ontap=missing +driver.netapp_e_ef=missing +driver.netapp_solidfire=missing +driver.nexenta=missing +driver.nfs=missing +driver.nimble=missing +driver.oracle_zfssa=missing +driver.prophetstor=missing +driver.pure=missing +driver.qnap=missing +driver.quobyte=missing +driver.rbd=missing +driver.sheepdog=missing +driver.storpool=missing +driver.synology=missing +driver.tintri=missing +driver.vrtshyperscale=missing +driver.vrtsaccess=missing +driver.vrtscnfs=missing +driver.vzstorage=missing +driver.vmware=missing +driver.win_iscsi=missing +driver.win_smb=complete +driver.zadara=missing + +[operation.qos] +title=QoS +status=optional +notes=Vendor drivers that support Quality of Service (QoS) are able + to utilize QoS Specs associated with volume extra specs to control + QoS settings on a per volume basis. +driver.coprhd=missing +driver.datacore=missing +driver.datera=complete +driver.dell_emc_powermax=complete +driver.dell_emc_ps=missing +driver.dell_emc_sc=complete +driver.dell_emc_unity=complete +driver.dell_emc_vmax_af=complete +driver.dell_emc_vmax_3=complete +driver.dell_emc_vmax_v2=missing +driver.dell_emc_vnx=complete +driver.dell_emc_vxflexos=complete +driver.dell_emc_xtremeio=missing +driver.fujitsu_eternus=missing +driver.hgst=missing +driver.hpe_3par=complete +driver.hpe_lefthand=missing +driver.hpe_mmsa=missing +driver.huawei_t_v1=missing +driver.huawei_t_v2=complete +driver.huawei_v3=complete +driver.huawei_v5=complete +driver.huawei_18000=complete +driver.huawei_dorado=complete +driver.huawei_fusionstorage=missing +driver.infinidat=complete +driver.ibm_ds8k=missing +driver.ibm_flashsystem=missing +driver.ibm_gpfs=missing +driver.ibm_storwize=complete +driver.ibm_xiv=missing +driver.inspur=complete +driver.itri_disco=missing +driver.kaminario=missing +driver.lenovo=missing +driver.linbit_drbd=missing +driver.lvm=missing +driver.nec=complete +driver.netapp_ontap=complete +driver.netapp_e_ef=missing +driver.netapp_solidfire=complete +driver.nexenta=missing +driver.nfs=missing +driver.nimble=missing +driver.oracle_zfssa=missing +driver.prophetstor=missing +driver.pure=missing +driver.qnap=missing +driver.quobyte=missing +driver.rbd=missing +driver.sheepdog=missing +driver.storpool=missing +driver.synology=missing +driver.tintri=missing +driver.vrtshyperscale=missing +driver.vrtsaccess=missing +driver.vrtscnfs=missing +driver.vzstorage=missing +driver.vmware=missing +driver.win_iscsi=missing +driver.win_smb=missing +driver.zadara=missing + +[operation.volume_replication] +title=Volume Replication +status=optional +notes=Vendor drivers that support volume replication can report this + capability to be utilized by the scheduler allowing users to request + replicated volumes via extra specs. Such drivers are also then able + to take advantage of Cinder's failover and failback commands. +driver.coprhd=missing +driver.datacore=missing +driver.datera=missing +driver.dell_emc_powermax=complete +driver.dell_emc_ps=missing +driver.dell_emc_sc=complete +driver.dell_emc_unity=missing +driver.dell_emc_vmax_af=complete +driver.dell_emc_vmax_3=complete +driver.dell_emc_vmax_v2=missing +driver.dell_emc_vnx=complete +driver.dell_emc_vxflexos=missing +driver.dell_emc_xtremeio=missing +driver.fujitsu_eternus=missing +driver.hgst=missing +driver.hpe_3par=complete +driver.hpe_lefthand=complete +driver.hpe_mmsa=missing +driver.huawei_t_v1=missing +driver.huawei_t_v2=missing +driver.huawei_v3=complete +driver.huawei_v5=complete +driver.huawei_18000=complete +driver.huawei_dorado=complete +driver.huawei_fusionstorage=missing +driver.infinidat=missing +driver.ibm_ds8k=complete +driver.ibm_flashsystem=missing +driver.ibm_gpfs=missing +driver.ibm_storwize=complete +driver.ibm_xiv=complete +driver.inspur=complete +driver.itri_disco=missing +driver.kaminario=complete +driver.lenovo=missing +driver.linbit_drbd=missing +driver.lvm=missing +driver.nec=missing +driver.netapp_ontap=complete +driver.netapp_e_ef=missing +driver.netapp_solidfire=complete +driver.nexenta=missing +driver.nfs=missing +driver.nimble=missing +driver.oracle_zfssa=missing +driver.prophetstor=missing +driver.pure=complete +driver.qnap=missing +driver.quobyte=missing +driver.rbd=missing +driver.sheepdog=missing +driver.storpool=complete +driver.synology=missing +driver.tintri=missing +driver.vrtshyperscale=missing +driver.vrtsaccess=missing +driver.vrtscnfs=missing +driver.vzstorage=missing +driver.vmware=missing +driver.win_iscsi=missing +driver.win_smb=missing +driver.zadara=missing + +[operation.consistency_groups] +title=Consistency Groups +status=optional +notes=Vendor drivers that support consistency groups are able to + logically group volumes together for things like snapshotting and + deletion. Grouping the volumes ensures that operations are only + completed on the group of volumes, not individually, enabling the + creation of consistent snapshots across a group. +driver.coprhd=complete +driver.datacore=missing +driver.datera=missing +driver.dell_emc_powermax=complete +driver.dell_emc_ps=missing +driver.dell_emc_sc=complete +driver.dell_emc_unity=missing +driver.dell_emc_vmax_af=complete +driver.dell_emc_vmax_3=complete +driver.dell_emc_vmax_v2=complete +driver.dell_emc_vnx=complete +driver.dell_emc_vxflexos=complete +driver.dell_emc_xtremeio=complete +driver.fujitsu_eternus=missing +driver.hgst=missing +driver.hpe_3par=complete +driver.hpe_lefthand=complete +driver.hpe_mmsa=missing +driver.huawei_t_v1=missing +driver.huawei_t_v2=missing +driver.huawei_v3=complete +driver.huawei_v5=complete +driver.huawei_18000=complete +driver.huawei_dorado=complete +driver.huawei_fusionstorage=missing +driver.infinidat=missing +driver.ibm_ds8k=complete +driver.ibm_flashsystem=missing +driver.ibm_gpfs=missing +driver.ibm_storwize=complete +driver.ibm_xiv=complete +driver.inspur=complete +driver.itri_disco=missing +driver.kaminario=missing +driver.lenovo=missing +driver.linbit_drbd=missing +driver.lvm=missing +driver.nec=missing +driver.netapp_ontap=complete +driver.netapp_e_ef=complete +driver.netapp_solidfire=complete +driver.nexenta=missing +driver.nfs=missing +driver.nimble=missing +driver.oracle_zfssa=missing +driver.prophetstor=complete +driver.pure=complete +driver.qnap=missing +driver.quobyte=missing +driver.rbd=missing +driver.sheepdog=missing +driver.storpool=missing +driver.synology=missing +driver.tintri=missing +driver.vrtshyperscale=missing +driver.vrtsaccess=missing +driver.vrtscnfs=missing +driver.vzstorage=missing +driver.vmware=missing +driver.win_iscsi=missing +driver.win_smb=missing +driver.zadara=missing + +[operation.thin_provisioning] +title=Thin Provisioning +status=optional +notes=If a volume driver supports thin provisioning it means that it + will allow the scheduler to provision more storage space + than physically exists on the backend. This may also be called + 'oversubscription'. +driver.coprhd=missing +driver.datacore=missing +driver.datera=missing +driver.dell_emc_powermax=complete +driver.dell_emc_ps=complete +driver.dell_emc_sc=complete +driver.dell_emc_unity=complete +driver.dell_emc_vmax_af=complete +driver.dell_emc_vmax_3=complete +driver.dell_emc_vmax_v2=complete +driver.dell_emc_vnx=complete +driver.dell_emc_vxflexos=complete +driver.dell_emc_xtremeio=complete +driver.fujitsu_eternus=missing +driver.hgst=missing +driver.hpe_3par=complete +driver.hpe_lefthand=complete +driver.hpe_mmsa=missing +driver.huawei_t_v1=missing +driver.huawei_t_v2=missing +driver.huawei_v3=complete +driver.huawei_v5=complete +driver.huawei_18000=complete +driver.huawei_dorado=complete +driver.huawei_fusionstorage=missing +driver.infinidat=complete +driver.ibm_ds8k=missing +driver.ibm_flashsystem=missing +driver.ibm_gpfs=missing +driver.ibm_storwize=missing +driver.ibm_xiv=missing +driver.inspur=missing +driver.itri_disco=missing +driver.kaminario=complete +driver.lenovo=missing +driver.linbit_drbd=missing +driver.lvm=complete +driver.nec=missing +driver.netapp_ontap=complete +driver.netapp_e_ef=complete +driver.netapp_solidfire=complete +driver.nexenta=missing +driver.nfs=complete +driver.nimble=missing +driver.oracle_zfssa=complete +driver.prophetstor=missing +driver.pure=complete +driver.qnap=missing +driver.quobyte=missing +driver.rbd=missing +driver.sheepdog=missing +driver.storpool=missing +driver.synology=missing +driver.tintri=missing +driver.vrtshyperscale=missing +driver.vrtsaccess=missing +driver.vrtscnfs=missing +driver.vzstorage=missing +driver.vmware=missing +driver.win_iscsi=missing +driver.win_smb=complete +driver.zadara=missing + +[operation.volume_migration_storage_assisted] +title=Volume Migration (Storage Assisted) +status=optional +notes=Storage assisted volume migration is like host assisted volume + migration except that it the a volume can be migrated without the + assistance of the Cinder host. Vendor drivers that implement this + can migrate volumes completely through the storage backend's + functionality. +driver.coprhd=missing +driver.datacore=missing +driver.datera=missing +driver.dell_emc_powermax=complete +driver.dell_emc_ps=missing +driver.dell_emc_sc=missing +driver.dell_emc_unity=missing +driver.dell_emc_vmax_af=complete +driver.dell_emc_vmax_3=complete +driver.dell_emc_vmax_v2=missing +driver.dell_emc_vnx=complete +driver.dell_emc_vxflexos=missing +driver.dell_emc_xtremeio=missing +driver.fujitsu_eternus=missing +driver.hgst=missing +driver.hpe_3par=missing +driver.hpe_lefthand=missing +driver.hpe_mmsa=missing +driver.huawei_t_v1=missing +driver.huawei_t_v2=missing +driver.huawei_v3=complete +driver.huawei_v5=complete +driver.huawei_18000=complete +driver.huawei_dorado=complete +driver.huawei_fusionstorage=missing +driver.infinidat=missing +driver.ibm_ds8k=missing +driver.ibm_flashsystem=missing +driver.ibm_gpfs=missing +driver.ibm_storwize=missing +driver.ibm_xiv=missing +driver.inspur=missing +driver.itri_disco=missing +driver.kaminario=missing +driver.lenovo=missing +driver.linbit_drbd=missing +driver.lvm=missing +driver.nec=missing +driver.netapp_ontap=missing +driver.netapp_e_ef=missing +driver.netapp_solidfire=missing +driver.nexenta=missing +driver.nfs=missing +driver.nimble=missing +driver.oracle_zfssa=complete +driver.prophetstor=missing +driver.pure=missing +driver.qnap=missing +driver.quobyte=missing +driver.rbd=missing +driver.sheepdog=missing +driver.storpool=complete +driver.synology=missing +driver.tintri=missing +driver.vrtshyperscale=missing +driver.vrtsaccess=missing +driver.vrtscnfs=missing +driver.vzstorage=missing +driver.vmware=missing +driver.win_iscsi=missing +driver.win_smb=missing +driver.zadara=missing + +[operation.multi-attach] +title=Multi-Attach Support +status=optional +notes=Vendor drivers that report multi-attach support are able + to make one volume available to multiple instances as once. + It is important to note that a clustered file system that + supports multi-attach functionality is required to use multi- + attach functionality otherwise data corruption may occur. +driver.coprhd=missing +driver.datacore=missing +driver.datera=missing +driver.dell_emc_powermax=complete +driver.dell_emc_ps=missing +driver.dell_emc_sc=missing +driver.dell_emc_unity=complete +driver.dell_emc_vmax_af=complete +driver.dell_emc_vmax_3=complete +driver.dell_emc_vmax_v2=missing +driver.dell_emc_vnx=missing +driver.dell_emc_vxflexos=complete +driver.dell_emc_xtremeio=complete +driver.fujitsu_eternus=missing +driver.hgst=missing +driver.hpe_3par=missing +driver.hpe_lefthand=complete +driver.hpe_mmsa=missing +driver.huawei_t_v1=missing +driver.huawei_t_v2=missing +driver.huawei_v3=missing +driver.huawei_v5=missing +driver.huawei_18000=missing +driver.huawei_dorado=missing +driver.huawei_fusionstorage=missing +driver.infinidat=complete +driver.ibm_ds8k=complete +driver.ibm_flashsystem=missing +driver.ibm_gpfs=missing +driver.ibm_storwize=complete +driver.ibm_xiv=complete +driver.inspur=missing +driver.itri_disco=missing +driver.kaminario=missing +driver.lenovo=missing +driver.linbit_drbd=missing +driver.lvm=complete +driver.nec=missing +driver.netapp_ontap=complete +driver.netapp_e_ef=missing +driver.netapp_solidfire=complete +driver.nexenta=missing +driver.nfs=missing +driver.nimble=missing +driver.oracle_zfssa=complete +driver.prophetstor=missing +driver.pure=missing +driver.qnap=missing +driver.quobyte=missing +driver.rbd=missing +driver.sheepdog=missing +driver.storpool=missing +driver.synology=missing +driver.tintri=missing +driver.vrtshyperscale=missing +driver.vrtsaccess=missing +driver.vrtscnfs=missing +driver.vzstorage=missing +driver.vmware=missing +driver.win_iscsi=missing +driver.win_smb=missing +driver.zadara=missing diff --git a/doc/source/reference/support-matrix.rst b/doc/source/reference/support-matrix.rst new file mode 100644 index 00000000000..13d629da261 --- /dev/null +++ b/doc/source/reference/support-matrix.rst @@ -0,0 +1,57 @@ +.. + 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 `_ +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 + diff --git a/lower-constraints.txt b/lower-constraints.txt index 66d0b5d24b7..819711c2116 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -137,6 +137,7 @@ six==1.10.0 smmap2==2.0.3 snowballstemmer==1.2.1 Sphinx==1.6.5 +sphinx-feature-classification==0.1.0 sphinxcontrib-websupport==1.0.1 sqlalchemy-migrate==0.11.0 SQLAlchemy==1.0.10 diff --git a/requirements.txt b/requirements.txt index 5a2df87e340..9015dd69d07 100644 --- a/requirements.txt +++ b/requirements.txt @@ -50,6 +50,7 @@ retrying!=1.3.0,>=1.2.3 # Apache-2.0 Routes>=2.3.1 # MIT taskflow>=2.16.0 # Apache-2.0 rtslib-fb>=2.1.65 # Apache-2.0 +sphinx-feature-classification>=0.1.0 # Apache 2.0 simplejson>=3.5.1 # MIT six>=1.10.0 # MIT SQLAlchemy!=1.1.5,!=1.1.6,!=1.1.7,!=1.1.8,>=1.0.10 # MIT