openstack/cinder
Code Issues Proposed changes

Docs: Make links more robust

Browse Source 
Some docs used external links which cannot be verified and thus we
easily might get broken links. Use internal links that Sphinx can verify.

Some additional updates:
* Update tox.ini to not publish the dirtrees.
* Update openstack mailing list to openstack-discuss
* Remove reference to not anymore existing 'OpenStack Configuration
  Reference'

Change-Id: I9a613fa682021fab7bbaba90b219adaa7d9384d3
This commit is contained in:
Andreas Jaeger 2019-08-10 09:37:29 +02:00
parent 319760bb0e
commit 99ec31f53f
20 changed files with 45 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/source/admin/blockstorage-manage-volumes.rst
View File

@ -72,5 +72,4 @@ troubleshoot your installation and back up your Compute volumes.
.. note:: .. note::
To enable the use of encrypted volumes, see the setup instructions in To enable the use of encrypted volumes, see the setup instructions in
`Create an encrypted volume type :ref:`Create an encrypted volume type <create__encrypted_volume_type>`.
<https://docs.openstack.org/cinder/latest/configuration/block-storage/volume-encryption.html#create-an-encrypted-volume-type>`_.

6
doc/source/admin/blockstorage-volume-migration.rst
View File

@ -24,9 +24,9 @@ These workflows are possible for a migration:
.. note:: .. note::
While most back ends support this function, not all do. See the `driver While most back ends support this function, not all do. See the
documentation <https://docs.openstack.org/cinder/latest/configuration/block-storage/volume-drivers.html>`__ :doc:`driver documentation </configuration/block-storage/volume-drivers>`
in the OpenStack Configuration Reference for more details. for more details.
#. If the volume is attached to a VM instance, the Block Storage creates a #. If the volume is attached to a VM instance, the Block Storage creates a
volume, and calls Compute to copy the data from the original to the new volume, and calls Compute to copy the data from the original to the new

2
doc/source/cli/cinder-manage.rst
View File

@ -6,7 +6,7 @@ cinder-manage
Control and manage OpenStack block storage Control and manage OpenStack block storage
------------------------------------------ ------------------------------------------
:Author: openstack@lists.openstack.org :Author: openstack-discuss@lists.openstack.org
:Copyright: OpenStack Foundation :Copyright: OpenStack Foundation
:Manual section: 1 :Manual section: 1
:Manual group: cloud computing :Manual group: cloud computing

2
doc/source/cli/cinder-status.rst
View File

@ -6,7 +6,7 @@ cinder-status
CLI interface for cinder status commands CLI interface for cinder status commands
---------------------------------------- ----------------------------------------
:Author: openstack@lists.openstack.org :Author: openstack-discuss@lists.openstack.org
:Copyright: OpenStack Foundation :Copyright: OpenStack Foundation
:Manual section: 1 :Manual section: 1
:Manual group: cloud computing :Manual group: cloud computing

5
doc/source/cli/cli-cinder-quotas.rst
View File

@ -162,9 +162,8 @@ service quotas.
#. To update a default value for a new project, #. To update a default value for a new project,
update the property in the :guilabel:`cinder.quota` update the property in the :guilabel:`cinder.quota`
section of the ``/etc/cinder/cinder.conf`` file. section of the ``/etc/cinder/cinder.conf`` file.
For more information, see the `Block Storage service For more information, see the :doc:`Block Storage service
<https://docs.openstack.org/cinder/latest/configuration/>`_ configuration </configuration/index>`.
in OpenStack Configuration Reference.
#. To update Block Storage service quotas for an existing project #. To update Block Storage service quotas for an existing project

8
doc/source/configuration/block-storage/drivers/dell-emc-powermax-driver.rst
View File

@ -1181,7 +1181,7 @@ Use case 2 - Retype from compression disabled to compression enabled
---------------------------- ----------------------------
Please refer to the following: Please refer to the following:
https://docs.openstack.org/cinder/latest/admin/blockstorage-over-subscription.html :doc:`/admin/blockstorage-over-subscription`.
13. Live Migration support 13. Live Migration support
@ -1376,7 +1376,7 @@ nodes. The following were also used in live migration.
PowerMax cinder driver supports the ability to attach a volume to multiple PowerMax cinder driver supports the ability to attach a volume to multiple
hosts/servers simultaneously. Please see hosts/servers simultaneously. Please see
https://docs.openstack.org/cinder/latest/admin/blockstorage-volume-multiattach.html :doc:`/admin/blockstorage-volume-multiattach`
for configuration information. for configuration information.
Multi-attach Architecture Multi-attach Architecture
@ -1434,7 +1434,7 @@ We then decide to detach the volume from ‘Multi-attach-Instance-B’ on HostB:
----------------------------- -----------------------------
Please refer to the following: Please refer to the following:
https://docs.openstack.org/cinder/latest/configuration/block-storage/volume-encryption.html :doc:`/configuration/block-storage/volume-encryption`.
16. Volume metadata in logs 16. Volume metadata in logs
@ -2381,7 +2381,7 @@ Cinder backup support
--------------------- ---------------------
PowerMax cinder driver supports cinder backup functionality. See PowerMax cinder driver supports cinder backup functionality. See
https://docs.openstack.org/cinder/latest/configuration/block-storage/backup-drivers.html :doc:`/configuration/block-storage/backup-drivers`
and https://docs.openstack.org/python-openstackclient/latest/cli/command-objects/backup.html and https://docs.openstack.org/python-openstackclient/latest/cli/command-objects/backup.html
for more details. for more details.

2
doc/source/configuration/block-storage/drivers/dell-emc-unity-driver.rst
View File

@ -408,7 +408,7 @@ snapshots, the volume type extra specs would also have the following entry:
{'consistent_group_snapshot_enabled': <is> True} {'consistent_group_snapshot_enabled': <is> True}
Refer to https://docs.openstack.org/cinder/latest/admin/blockstorage-groups.html Refer to :doc:`/admin/blockstorage-groups`
for command lines detail. for command lines detail.
Troubleshooting Troubleshooting

4
doc/source/configuration/block-storage/drivers/dell-emc-vnx-driver.rst
View File

@ -180,8 +180,8 @@ Set ``storage_protocol = iscsi`` if iSCSI protocol is used.
The value of the option ``storage_protocol`` can be either ``fc`` or ``iscsi``, The value of the option ``storage_protocol`` can be either ``fc`` or ``iscsi``,
which is case insensitive. which is case insensitive.
For more details on multiple back ends, see `Configure multiple-storage For more details on multiple back ends, see :doc:`Configure multiple-storage
back ends <https://docs.openstack.org/cinder/latest/admin/blockstorage-multi-backend.html>`_ back ends </admin/blockstorage-multi-backend>`.
Required configurations Required configurations
----------------------- -----------------------

5
doc/source/configuration/block-storage/drivers/dell-equallogic-driver.rst
View File

@ -162,6 +162,5 @@ In this example:
reach the Dell EqualLogic Group of ``backend1`` and ``backend2`` reach the Dell EqualLogic Group of ``backend1`` and ``backend2``
through SSH, respectively. through SSH, respectively.
For information on configuring multiple back ends, see `Configure a For information on configuring multiple back ends, see :doc:`Configure a
multiple-storage back multiple-storage back end </admin/blockstorage-multi-backend>`.
end <https://docs.openstack.org/cinder/latest/admin/blockstorage-multi-backend.html>`__.

10
doc/source/configuration/block-storage/drivers/kaminario-driver.rst
View File

@ -100,9 +100,8 @@ Cinder Driver for single FC or iSCSI backend.
[DEFAULT] [DEFAULT]
scheduler_default_filters = DriverFilter,CapabilitiesFilter scheduler_default_filters = DriverFilter,CapabilitiesFilter
See following links for more information: See following documents for more information:
`<https://docs.openstack.org/cinder/latest/configuration/block-storage/scheduler-filters.html>`_ :ref:`cinder_scheduler_filters` and :ref:`filter_weigh_scheduler`.
`<https://docs.openstack.org/cinder/latest/admin/blockstorage-driver-filter-weighing.html>`_
#. Under the ``[DEFAULT]`` section, set the enabled_backends parameter #. Under the ``[DEFAULT]`` section, set the enabled_backends parameter
with the iSCSI or FC back-end group with the iSCSI or FC back-end group
@ -189,9 +188,8 @@ The following steps are required to configure multiple K2 iSCSI/FC backends:
described in the above section described in the above section
``Configure single Kaminario iSCSI/FC back end`` ``Configure single Kaminario iSCSI/FC back end``
See `Configure multiple-storage back ends See :doc:`Configure multiple-storage back ends
<https://docs.openstack.org/cinder/latest/admin/blockstorage-multi-backend.html>`__ </admin/blockstorage-multi-backend>` for additional information.
for additional information.
#. Restart the cinder volume service for the changes to take effect. #. Restart the cinder volume service for the changes to take effect.

8
doc/source/configuration/block-storage/scheduler-filters.rst
View File

@ -1,6 +1,8 @@
============================== .. _cinder_scheduler_filters:
Cinder Scheduler Filters
============================== ========================
Cinder Scheduler Filters
========================
.. list-plugins:: cinder.scheduler.filters .. list-plugins:: cinder.scheduler.filters
:detailed: :detailed:

1
doc/source/configuration/block-storage/volume-encryption.rst
View File

@ -66,6 +66,7 @@ IDs using the ``openstack role list`` command. If the creator
role does not exist, the admin can `create the role role does not exist, the admin can `create the role
<https://docs.openstack.org/keystone/latest/admin/cli-manage-projects-users-and-roles.html#create-a-role>`_. <https://docs.openstack.org/keystone/latest/admin/cli-manage-projects-users-and-roles.html#create-a-role>`_.
.. _create__encrypted_volume_type:
Create an encrypted volume type Create an encrypted volume type
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

4
doc/source/contributor/drivers.rst
View File

@ -52,6 +52,8 @@ relevant options:
* For operators and installers: Through the ``get_driver_options`` static * For operators and installers: Through the ``get_driver_options`` static
method returning that returns a list of all the Oslo Config parameters. method returning that returns a list of all the Oslo Config parameters.
.. _drivers_minimum_features:
Minimum Features Minimum Features
---------------- ----------------
@ -84,6 +86,8 @@ Security Requirements
* Drivers should use standard Python libraries to handle encryption-related * Drivers should use standard Python libraries to handle encryption-related
functionality, and not contain custom implementations of encryption code. functionality, and not contain custom implementations of encryption code.
.. _drivers_volume_stats:
Volume Stats Volume Stats
------------ ------------

3
doc/source/contributor/groups.rst
View File

@ -8,8 +8,7 @@ Generic volume group support was added in cinder in the Newton release.
There is support for creating group types and group specs, creating There is support for creating group types and group specs, creating
groups of volumes, and creating snapshots of groups. Detailed information groups of volumes, and creating snapshots of groups. Detailed information
on how to create a group type, a group, and a group snapshot can be found on how to create a group type, a group, and a group snapshot can be found
in `block storage admin guide <https://docs.openstack.org/cinder/latest in :doc:`block storage admin guide </admin/blockstorage-groups>`.
/admin/blockstorage-groups.html>`_.
How is generic volume groups different from consistency groups in cinder? How is generic volume groups different from consistency groups in cinder?
The consistency group feature was introduced in cinder in Juno and are The consistency group feature was introduced in cinder in Juno and are

4
doc/source/contributor/high_availability.rst
View File

@ -1058,7 +1058,8 @@ maximum over provisioning, etc. All the backends' information is stored in
memory at the Schedulers, and used to decide where to create new volumes, memory at the Schedulers, and used to decide where to create new volumes,
migrate them on a retype, and so on. migrate them on a retype, and so on.
For additional information on the stats, please refer to the `volume stats`_ For additional information on the stats, please refer to the
:ref:`volume stats <drivers_volume_stats>`
section of the Contributor/Developer docs. section of the Contributor/Developer docs.
Trying to keep updated stats, schedulers reduce available free space on Trying to keep updated stats, schedulers reduce available free space on
@ -1160,5 +1161,4 @@ another node's.
.. _manager local locks: https://specs.openstack.org/openstack/cinder-specs/specs/newton/ha-aa-manager_locks.html .. _manager local locks: https://specs.openstack.org/openstack/cinder-specs/specs/newton/ha-aa-manager_locks.html
.. _Active-Active replication spec: https://specs.openstack.org/openstack/cinder-specs/specs/ocata/ha-aa-replication.html .. _Active-Active replication spec: https://specs.openstack.org/openstack/cinder-specs/specs/ocata/ha-aa-replication.html
.. _testing Active-Active: https://review.openstack.org/#/c/443504 .. _testing Active-Active: https://review.openstack.org/#/c/443504
.. _volume stats: https://docs.openstack.org/cinder/latest/contributor/drivers.html#volume-stats
.. _Scalable Backup Service spec: https://specs.openstack.org/openstack/cinder-specs/specs/mitaka/scalable-backup-service.html .. _Scalable Backup Service spec: https://specs.openstack.org/openstack/cinder-specs/specs/mitaka/scalable-backup-service.html

9
doc/source/contributor/launchpad.rst
View File

@ -18,14 +18,15 @@ OpenStack-related sites. These sites include:
Mailing list Mailing list
------------ ------------
The mailing list email is ``openstack@lists.openstack.org``. This is a common The mailing list email is ``openstack-discuss@lists.openstack.org``.
mailing list across the OpenStack projects. To participate in the mailing list: This is a common mailing list across the OpenStack projects. To
participate in the mailing list:
#. Subscribe to the list at #. Subscribe to the list at
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack https://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
The mailing list archives are at The mailing list archives are at
http://lists.openstack.org/pipermail/openstack/. https://lists.openstack.org/pipermail/openstack-discuss/.
Bug tracking Bug tracking

3
doc/source/contributor/new_driver_checklist.rst
View File

@ -49,8 +49,7 @@ Review Checklist
* ``CI_WIKI_NAME`` constant defined in driver class * ``CI_WIKI_NAME`` constant defined in driver class
* well documented version history in the comment block for the main driver * well documented version history in the comment block for the main driver
class. class.
* Support minimum driver features * Support :ref:`minimum driver features <drivers_minimum_features>`.
(https://docs.openstack.org/cinder/latest/contributor/drivers.html#minimum-features )
* Meet release deadline(s) * Meet release deadline(s)
(https://releases.openstack.org/train/schedule.html#t-cinder-driver-deadline ) (https://releases.openstack.org/train/schedule.html#t-cinder-driver-deadline )

4
doc/source/contributor/rolling.upgrades.rst
View File

@ -412,8 +412,8 @@ Upgrade Checks
Starting with the Stein release of OpenStack, Cinder has added support for Starting with the Stein release of OpenStack, Cinder has added support for
Upgrade Checks. Upgrade checks provide a release-specific readiness check Upgrade Checks. Upgrade checks provide a release-specific readiness check
before restarting services with new code. Details on how to run an Upgrade before restarting services with new code. Details on how to run an Upgrade
Check can be seen in the `CLI interface for cinder status commands Check can be seen in the `CLI interface for :doc:`cinder status commands
<https://docs.openstack.org/cinder/latest/cli/cinder-status.html>`_ page. </cli/cinder-status>` page.
Upgrade checks are intended to help identify changes between releases that Upgrade checks are intended to help identify changes between releases that
may impact the deployment environment. As a result, developers should take time may impact the deployment environment. As a result, developers should take time

4
doc/source/install/index.rst
View File

@ -14,8 +14,8 @@ The Block Storage API and scheduler services typically run on the controller
nodes. Depending upon the drivers used, the volume service can run nodes. Depending upon the drivers used, the volume service can run
on controller nodes, compute nodes, or standalone storage nodes. on controller nodes, compute nodes, or standalone storage nodes.
For more information, see the `Configuration For more information, see the :doc:`Configuration
Reference <https://docs.openstack.org/cinder/latest/configuration/block-storage/volume-drivers.html>`_. Reference </configuration/block-storage/volume-drivers>`.
Prerequisites Prerequisites

2
tox.ini
View File

@ -143,7 +143,7 @@ deps =
commands = commands =
doc8 doc8
rm -fr doc/build doc/source/contributor/api/ .autogenerated rm -fr doc/build doc/source/contributor/api/ .autogenerated
sphinx-build -W -b html doc/source doc/build/html sphinx-build -W -b html -d doc/build/doctrees doc/source doc/build/html
rm -rf api-ref/build rm -rf api-ref/build
sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html/ sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html/
whitelist_externals = rm whitelist_externals = rm