diff --git a/releasenotes/notes/bp-open-src-ibm-storage-driver-d17808e52aa4eacb.yaml b/releasenotes/notes/bp-open-src-ibm-storage-driver-d17808e52aa4eacb.yaml index 39622a84b45..30e8cd55444 100644 --- a/releasenotes/notes/bp-open-src-ibm-storage-driver-d17808e52aa4eacb.yaml +++ b/releasenotes/notes/bp-open-src-ibm-storage-driver-d17808e52aa4eacb.yaml @@ -3,12 +3,14 @@ features: - | The IBM_Storage driver has been open sourced. This means that there is no more need to download the package from the IBM site. The only requirement - remaining is to install pyxcli, which is available through pypi: - 'sudo pip install pyxcli' + remaining is to install pyxcli, which is available through pypi:: + + ``sudo pip install pyxcli`` + upgrade: - | Previous installations of IBM Storage must be un-installed first and the new driver should be installed on top. In addition the cinder.conf values should be updated to reflect the new paths. For example the proxy setting - of 'storage.proxy.IBMStorageProxy' should be updated to - 'cinder.volume.drivers.ibm.ibm_storage.proxy.IBMStorageProxy'. + of ``storage.proxy.IBMStorageProxy`` should be updated to + ``cinder.volume.drivers.ibm.ibm_storage.proxy.IBMStorageProxy``. diff --git a/releasenotes/notes/cinder-api-middleware-remove-deprecated-option-98912ab7e8b472e8.yaml b/releasenotes/notes/cinder-api-middleware-remove-deprecated-option-98912ab7e8b472e8.yaml index 1816cfa0a06..91ad094994c 100644 --- a/releasenotes/notes/cinder-api-middleware-remove-deprecated-option-98912ab7e8b472e8.yaml +++ b/releasenotes/notes/cinder-api-middleware-remove-deprecated-option-98912ab7e8b472e8.yaml @@ -1,4 +1,3 @@ --- upgrade: - - Removed deprecated option 'max_request_body_size_opt' - in api.middleware. + - Removed deprecated option ``osapi_max_request_body_size``. diff --git a/releasenotes/notes/cinder-manage-db-online-schema-migrations-d1c0d40f26d0f033.yaml b/releasenotes/notes/cinder-manage-db-online-schema-migrations-d1c0d40f26d0f033.yaml index 69da2f6a19e..71de559c51b 100644 --- a/releasenotes/notes/cinder-manage-db-online-schema-migrations-d1c0d40f26d0f033.yaml +++ b/releasenotes/notes/cinder-manage-db-online-schema-migrations-d1c0d40f26d0f033.yaml @@ -3,11 +3,11 @@ upgrade: - To get rid of long running DB data migrations that must be run offline, Cinder will now be able to execute them online, on a live cloud. Before upgrading from Ocata to Pike, operator needs to perform all the Newton - data migrations. To achieve that he needs to perform `cinder-manage db - online_data_migrations` until there are no records to be updated. To limit + data migrations. To achieve that he needs to perform ``cinder-manage db + online_data_migrations`` until there are no records to be updated. To limit DB performance impact migrations can be performed in chunks limited by - `--max_number` option. If your intent is to upgrade Cinder in a non-live - manner, you can use `--ignore_state` option safely. Please note that + ``--max_number`` option. If your intent is to upgrade Cinder in a non-live + manner, you can use ``--ignore_state`` option safely. Please note that finishing all the Newton data migrations will be enforced by the first schema migration in Pike, so you won't be able to upgrade to Pike without that. diff --git a/releasenotes/notes/datera-driver-v2-update-930468e8259c8e86.yaml b/releasenotes/notes/datera-driver-v2-update-930468e8259c8e86.yaml index 3ecf5221f53..fda5fce1c08 100644 --- a/releasenotes/notes/datera-driver-v2-update-930468e8259c8e86.yaml +++ b/releasenotes/notes/datera-driver-v2-update-930468e8259c8e86.yaml @@ -1,12 +1,12 @@ --- features: - All Datera DataFabric backed volume-types will now use - API version 2 with Datera DataFabric + API version 2 with Datera DataFabric. upgrade: - Users of the Datera Cinder driver are now required to use Datera DataFabric version 1.0+. Versions before 1.0 will not be able to utilize this new driver since they still - function on v1 of the Datera DataFabric API + function on v1 of the Datera DataFabric API. deprecations: - Config option ``datera_api_token`` has been replaced by - options ``san_login`` and ``san_password`` + options ``san_login`` and ``san_password``. diff --git a/releasenotes/notes/hnas-deprecate-iscsi-driver-cd521b3a2ba948f3.yaml b/releasenotes/notes/hnas-deprecate-iscsi-driver-cd521b3a2ba948f3.yaml index 7cd9667c362..d870efb6dc0 100644 --- a/releasenotes/notes/hnas-deprecate-iscsi-driver-cd521b3a2ba948f3.yaml +++ b/releasenotes/notes/hnas-deprecate-iscsi-driver-cd521b3a2ba948f3.yaml @@ -1,10 +1,10 @@ --- upgrade: - The Hitachi NAS iSCSI driver has been marked as unsupported and is - now deprecated. enable_unsupported_drivers will need to be set to True - in cinder.conf to continue to use it. + now deprecated. ``enable_unsupported_drivers`` will need to be set to + ``True`` in cinder.conf to continue to use it. deprecations: - The Hitachi NAS iSCSI driver has been marked as unsupported and is now - deprecated. enable_unsupported_drivers will need to be set to True + deprecated. ``enable_unsupported_drivers`` will need to be set to ``True`` in cinder.conf to continue to use it. The driver will be removed in the next release. diff --git a/releasenotes/notes/kaminario-cinder-driver-bug-1646692-7aad3b7496689aa7.yaml b/releasenotes/notes/kaminario-cinder-driver-bug-1646692-7aad3b7496689aa7.yaml index 66e7dbff962..85afe753122 100644 --- a/releasenotes/notes/kaminario-cinder-driver-bug-1646692-7aad3b7496689aa7.yaml +++ b/releasenotes/notes/kaminario-cinder-driver-bug-1646692-7aad3b7496689aa7.yaml @@ -1,4 +1,4 @@ --- fixes: - - Fixed Non-WAN port filter issue in Kaminario iSCSI driver + - Fixed Non-WAN port filter issue in Kaminario iSCSI driver. diff --git a/releasenotes/notes/kaminario-cinder-driver-remove-deprecate-option-831920f4d25e2979.yaml b/releasenotes/notes/kaminario-cinder-driver-remove-deprecate-option-831920f4d25e2979.yaml index 586070f623f..1316fe72486 100644 --- a/releasenotes/notes/kaminario-cinder-driver-remove-deprecate-option-831920f4d25e2979.yaml +++ b/releasenotes/notes/kaminario-cinder-driver-remove-deprecate-option-831920f4d25e2979.yaml @@ -1,5 +1,5 @@ --- upgrade: - - Removed deprecated option "kaminario_nodedup_substring" + - Removed deprecated option ``kaminario_nodedup_substring`` in Kaminario FC and iSCSI Cinder drivers. diff --git a/releasenotes/notes/mark-cloudbyte-unsupported-8615a127439ed262.yaml b/releasenotes/notes/mark-cloudbyte-unsupported-8615a127439ed262.yaml index dddc5107008..3c8d8d1438f 100644 --- a/releasenotes/notes/mark-cloudbyte-unsupported-8615a127439ed262.yaml +++ b/releasenotes/notes/mark-cloudbyte-unsupported-8615a127439ed262.yaml @@ -1,11 +1,11 @@ --- upgrade: - The CloudByte driver has been marked as unsupported and is - now deprecated. enable_unsupported_drivers will need to - be set to True in cinder.conf to continue to use it. + now deprecated. ``enable_unsupported_drivers`` will need to + be set to ``True`` in cinder.conf to continue to use it. deprecations: - The CloudByte driver has been marked as unsupported and is - now deprecated. enable_unsupported_drivers will need to - be set to True in cinder.conf to continue to use it. If + now deprecated. ``enable_unsupported_drivers`` will need to + be set to ``True`` in cinder.conf to continue to use it. If its support status does not change it will be removed in the next release. diff --git a/releasenotes/notes/mark-dothill-unsupported-7f95115b7b24e53c.yaml b/releasenotes/notes/mark-dothill-unsupported-7f95115b7b24e53c.yaml index f6159bc6102..ece1ea31346 100644 --- a/releasenotes/notes/mark-dothill-unsupported-7f95115b7b24e53c.yaml +++ b/releasenotes/notes/mark-dothill-unsupported-7f95115b7b24e53c.yaml @@ -1,11 +1,11 @@ --- upgrade: - The DotHill drivers have been marked as unsupported and are - now deprecated. enable_unsupported_drivers will need to - be set to True in cinder.conf to continue to use it. + now deprecated. ``enable_unsupported_drivers`` will need to + be set to ``True`` in cinder.conf to continue to use it. deprecations: - The DotHill drivers has been marked as unsupported and are - now deprecated. enable_unsupported_drivers will need to - be set to True in cinder.conf to continue to use it. If + now deprecated. ``enable_unsupported_drivers`` will need to + be set to ``True`` in cinder.conf to continue to use it. If its support status does not change it will be removed in the next release. diff --git a/releasenotes/notes/mark-hpe-xp-unsupported-c9ce6cfbab622e46.yaml b/releasenotes/notes/mark-hpe-xp-unsupported-c9ce6cfbab622e46.yaml index 028720447e7..e04209a4bab 100644 --- a/releasenotes/notes/mark-hpe-xp-unsupported-c9ce6cfbab622e46.yaml +++ b/releasenotes/notes/mark-hpe-xp-unsupported-c9ce6cfbab622e46.yaml @@ -1,11 +1,11 @@ --- upgrade: - The HPE XP driver has been marked as unsupported and is - now deprecated. enable_unsupported_drivers will need to - be set to True in cinder.conf to continue to use it. + now deprecated. ``enable_unsupported_drivers`` will need to + be set to ``True`` in cinder.conf to continue to use it. deprecations: - The HPE XP driver has been marked as unsupported and is - now deprecated. enable_unsupported_drivers will need to - be set to True in cinder.conf to continue to use it. If + now deprecated. ``enable_unsupported_drivers`` will need to + be set to ``True`` in cinder.conf to continue to use it. If its support status does not change it will be removed in the next release. diff --git a/releasenotes/notes/mark-nexentaedge-unsupported-56d184fdccc6eaac.yaml b/releasenotes/notes/mark-nexentaedge-unsupported-56d184fdccc6eaac.yaml index f1efa2650a8..c66c358f718 100644 --- a/releasenotes/notes/mark-nexentaedge-unsupported-56d184fdccc6eaac.yaml +++ b/releasenotes/notes/mark-nexentaedge-unsupported-56d184fdccc6eaac.yaml @@ -1,11 +1,11 @@ --- upgrade: - The Nexenta Edge drivers have been marked as unsupported and are - now deprecated. enable_unsupported_drivers will need to - be set to True in cinder.conf to continue to use it. + now deprecated. ``enable_unsupported_drivers`` will need to + be set to ``True`` in cinder.conf to continue to use it. deprecations: - The Nexenta Edge drivers has been marked as unsupported and are - now deprecated. enable_unsupported_drivers will need to - be set to True in cinder.conf to continue to use it. If + now deprecated. ``enable_unsupported_drivers`` will need to + be set to ``True`` in cinder.conf to continue to use it. If its support status does not change it will be removed in the next release. diff --git a/releasenotes/notes/migrate-cg-to-generic-volume-groups-f82ad3658f3e567c.yaml b/releasenotes/notes/migrate-cg-to-generic-volume-groups-f82ad3658f3e567c.yaml index 67e0b0c40a5..e9c5c96ea33 100644 --- a/releasenotes/notes/migrate-cg-to-generic-volume-groups-f82ad3658f3e567c.yaml +++ b/releasenotes/notes/migrate-cg-to-generic-volume-groups-f82ad3658f3e567c.yaml @@ -1,5 +1,5 @@ --- upgrade: - - Operator needs to perform `cinder-manage db - online_data_migrations` to migrate existing consistency + - Operator needs to perform ``cinder-manage db + online_data_migrations`` to migrate existing consistency groups to generic volume groups. diff --git a/releasenotes/notes/move-eqlx-driver-to-dell-emc-fe5d2b484c47b7a6.yaml b/releasenotes/notes/move-eqlx-driver-to-dell-emc-fe5d2b484c47b7a6.yaml index 6d09839d997..838551a7164 100644 --- a/releasenotes/notes/move-eqlx-driver-to-dell-emc-fe5d2b484c47b7a6.yaml +++ b/releasenotes/notes/move-eqlx-driver-to-dell-emc-fe5d2b484c47b7a6.yaml @@ -3,4 +3,4 @@ upgrade: - The EqualLogic driver is moved to the dell_emc directory and has been rebranded to its current Dell EMC PS Series name. The volume_driver entry in cinder.conf needs to be changed to - cinder.volume.drivers.dell_emc.ps.PSSeriesISCSIDriver. + ``cinder.volume.drivers.dell_emc.ps.PSSeriesISCSIDriver``. diff --git a/releasenotes/notes/move-scaleio-driver-to-dell-emc-dir-c195374ca6b7e98d.yaml b/releasenotes/notes/move-scaleio-driver-to-dell-emc-dir-c195374ca6b7e98d.yaml index 4311d23be49..ac24aef92a9 100644 --- a/releasenotes/notes/move-scaleio-driver-to-dell-emc-dir-c195374ca6b7e98d.yaml +++ b/releasenotes/notes/move-scaleio-driver-to-dell-emc-dir-c195374ca6b7e98d.yaml @@ -2,4 +2,4 @@ upgrade: - The ScaleIO driver is moved to the dell_emc directory. volume_driver entry in cinder.conf needs to be changed to - cinder.volume.drivers.dell_emc.scaleio.driver.ScaleIODriver. + ``cinder.volume.drivers.dell_emc.scaleio.driver.ScaleIODriver``. diff --git a/releasenotes/notes/move-xtremio-driver-to-dell-emc-dir-f7e07a502cafd78f.yaml b/releasenotes/notes/move-xtremio-driver-to-dell-emc-dir-f7e07a502cafd78f.yaml index 7fc058179e5..ee29c39325e 100644 --- a/releasenotes/notes/move-xtremio-driver-to-dell-emc-dir-f7e07a502cafd78f.yaml +++ b/releasenotes/notes/move-xtremio-driver-to-dell-emc-dir-f7e07a502cafd78f.yaml @@ -2,5 +2,5 @@ upgrade: - The XtremIO driver is moved to the dell_emc directory. volume_driver entry in cinder.conf needs to be changed to - cinder.volume.drivers.dell_emc.xtremio.XtremIOISCSIDriver or - cinder.volume.drivers.dell_emc.xtremio.XtremIOFCDriver. + ``cinder.volume.drivers.dell_emc.xtremio.XtremIOISCSIDriver`` or + ``cinder.volume.drivers.dell_emc.xtremio.XtremIOFCDriver``. diff --git a/releasenotes/notes/nec_storage_volume_driver-57663f9ecce1ae19.yaml b/releasenotes/notes/nec_storage_volume_driver-57663f9ecce1ae19.yaml index d1e75dbf0c4..6876ba5c809 100644 --- a/releasenotes/notes/nec_storage_volume_driver-57663f9ecce1ae19.yaml +++ b/releasenotes/notes/nec_storage_volume_driver-57663f9ecce1ae19.yaml @@ -1,3 +1,3 @@ --- features: - - Added backend drivers for NEC Storage.(FC/iSCSI) + - Added backend FC and iSCSI drivers for NEC Storage. diff --git a/releasenotes/notes/nexentastor5-https-6d58004838cfab30.yaml b/releasenotes/notes/nexentastor5-https-6d58004838cfab30.yaml index 142e00f0f64..0212830a7f6 100644 --- a/releasenotes/notes/nexentastor5-https-6d58004838cfab30.yaml +++ b/releasenotes/notes/nexentastor5-https-6d58004838cfab30.yaml @@ -1,4 +1,4 @@ --- features: - Added secure HTTP support for REST API calls in the NexentaStor5 driver. - Use of HTTPS is set True by default with option nexenta_use_https. + Use of HTTPS is set True by default with option ``nexenta_use_https``. diff --git a/releasenotes/notes/nfs-snapshots-21b641300341cba1.yaml b/releasenotes/notes/nfs-snapshots-21b641300341cba1.yaml index 222df03e589..647d512dd95 100644 --- a/releasenotes/notes/nfs-snapshots-21b641300341cba1.yaml +++ b/releasenotes/notes/nfs-snapshots-21b641300341cba1.yaml @@ -1,5 +1,5 @@ --- features: - - Added support to snapshots in NFS driver. This functionality is only - enabled if "nfs_snapshot_support" is set to True in cinder.conf. Cloning - volumes is only supported if the source volume is not attached. + - Added support for snapshots in the NFS driver. This functionality is only + enabled if ``nfs_snapshot_support`` is set to ``True`` in cinder.conf. + Cloning volumes is only supported if the source volume is not attached. diff --git a/releasenotes/notes/refactor-disco-volume-driver-3ff0145707ec0f3e.yaml b/releasenotes/notes/refactor-disco-volume-driver-3ff0145707ec0f3e.yaml index d5857b88751..bb1063e6819 100644 --- a/releasenotes/notes/refactor-disco-volume-driver-3ff0145707ec0f3e.yaml +++ b/releasenotes/notes/refactor-disco-volume-driver-3ff0145707ec0f3e.yaml @@ -1,5 +1,5 @@ --- -Deprecations: - - Marked the ITRI DISCO driver option ``disco_wsdl_path`` as deprecated. - The new preferred protocol for array communication is REST and SOAP - support will be removed. +deprecations: + - Marked the ITRI DISCO driver option ``disco_wsdl_path`` as deprecated. + The new preferred protocol for array communication is REST and SOAP + support will be removed. diff --git a/releasenotes/notes/remove-eqlx-deprecated-options-89ba02c41d4da62a.yaml b/releasenotes/notes/remove-eqlx-deprecated-options-89ba02c41d4da62a.yaml index a4a5792c9f9..416db1ab14e 100644 --- a/releasenotes/notes/remove-eqlx-deprecated-options-89ba02c41d4da62a.yaml +++ b/releasenotes/notes/remove-eqlx-deprecated-options-89ba02c41d4da62a.yaml @@ -5,11 +5,11 @@ upgrade: Removing the Dell EqualLogic driver's deprecated configuration options. Please replace old options in your cinder.conf with the new one. - * Removed - eqlx_cli_timeout - * Replaced with - ssh_conn_timeout - * Removed - eqlx_use_chap - * Replaced with - use_chap_auth - * Removed - eqlx_chap_login - * Replaced with - chap_username - * Removed - eqlx_chap_password - * Replaced with - chap_password + * Removed - ``eqlx_cli_timeout`` + * Replaced with - ``ssh_conn_timeout`` + * Removed - ``eqlx_use_chap`` + * Replaced with - ``use_chap_auth`` + * Removed - ``eqlx_chap_login`` + * Replaced with - ``chap_username`` + * Removed - ``eqlx_chap_password`` + * Replaced with - ``chap_password`` diff --git a/releasenotes/notes/use-oslo_middleware_sizelimit-5f171cf1c44444f8.yaml b/releasenotes/notes/use-oslo_middleware_sizelimit-5f171cf1c44444f8.yaml index 7ecba7cd2e1..3217d909cb3 100644 --- a/releasenotes/notes/use-oslo_middleware_sizelimit-5f171cf1c44444f8.yaml +++ b/releasenotes/notes/use-oslo_middleware_sizelimit-5f171cf1c44444f8.yaml @@ -1,9 +1,7 @@ --- -upgrade: - - use oslo_middleware.sizelimit rather than cinder.api.middleware.sizelimit - compatibility shim deprecations: - - cinder.api.middleware.sizelimit was deprecated in kilo and compatability - shim added to call into oslo_middleware. Using oslo_middleware.sizelimit - directly will allow us to remove the compatibility shim in a future - release. + - The api-paste.ini ``paste.filter_factory`` setting has been updated to use + ``oslo_middleware.sizelimit`` rather than ``cinder.api.middleware.sizelimit`` + compatibility shim. ``cinder.api.middleware.sizelimit`` was deprecated in + kilo and should now be updated to use ``oslo_middleware.sizelimit`` in + api-paste.ini in preparation for removal in the pike release. diff --git a/releasenotes/notes/vmax-rename-dell-emc-f9ebfb9eb567f427.yaml b/releasenotes/notes/vmax-rename-dell-emc-f9ebfb9eb567f427.yaml index 3b633b5bb03..f8f26f196bb 100644 --- a/releasenotes/notes/vmax-rename-dell-emc-f9ebfb9eb567f427.yaml +++ b/releasenotes/notes/vmax-rename-dell-emc-f9ebfb9eb567f427.yaml @@ -2,5 +2,5 @@ upgrade: - The VMAX driver is moved to the dell_emc directory. volume_driver entry in cinder.conf needs to be changed to - cinder.volume.drivers.dell_emc.vmax.iscsi.VMAXISCSIDriver or - cinder.volume.drivers.dell_emc.vmax.fc.VMAXFCDriver. + ``cinder.volume.drivers.dell_emc.vmax.iscsi.VMAXISCSIDriver`` or + ``cinder.volume.drivers.dell_emc.vmax.fc.VMAXFCDriver``.