openstack/cinder
Code Issues Proposed changes

Move doc of report backend state to cli

Browse Source 
It's not very appropriate in admin section when merging the feature
in Queen as Sean said. So there is little change to move the doc
to cli section.

Change-Id: I2823b05dded6066573edfce25a79e8b26d68815e
This commit is contained in:
wanghao 2018-02-05 14:21:45 +08:00
parent 6ed5c4be79
commit 98907fd98e
3 changed files with 20 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/source/admin/blockstorage-report-backend-state.rst
View File

@ -1,20 +0,0 @@
====================================
Report backend state in service list
====================================
Currently, Cinder couldn't report backend state to service, operators only
know that cinder-volume process is up, but isn't aware of whether the backend
storage device is ok. Users still can create volume and go to fail over and
over again. To make maintenance easier, operator could query storage device
state via service list and fix the problem more quickly. If device state is
*down*, that means volume creation will fail.
To do so, use the Block Storage API: service list to get the backend state.
Run this command:
.. code-block:: console
$ openstack volume service list
Add backend_state: up/down into response body of service list. This feature
is supported after microversion 3.49.

1
doc/source/admin/index.rst
View File

@ -46,7 +46,6 @@ Amazon EC2 Elastic Block Storage (EBS) offering.
blockstorage-volume-migration.rst
blockstorage-volume-multiattach.rst
blockstorage-volume-number-weigher.rst
blockstorage-report-backend-state.rst
.. _`Storage Decisions`: https://docs.openstack.org/arch-design/design-storage/design-storage-arch.html
.. _`OpenStack Operations Guide`: https://wiki.openstack.org/wiki/OpsGuide

20
doc/source/cli/cli-manage-volumes.rst
View File

@ -675,3 +675,23 @@ The following example unmanages the ``my-snapshot-id`` image:
.. code-block:: console
$ openstack volume snapshot unset my-snapshot-id
Report backend state in service list
------------------------------------
Currently, Cinder couldn't report backend state to service, operators only
know that cinder-volume process is up, but isn't aware of whether the backend
storage device is ok. Users still can create volume and go to fail over and
over again. To make maintenance easier, operator could query storage device
state via service list and fix the problem more quickly. If device state is
*down*, that means volume creation will fail.
To do so, use the Block Storage API: service list to get the backend state.
Run this command:
.. code-block:: console
$ openstack volume service list
Add backend_state: up/down into response body of service list. This feature
is supported after microversion 3.49.