From 98907fd98ef20c6c1e0c1a4d18ee4eae5406adf6 Mon Sep 17 00:00:00 2001 From: wanghao Date: Mon, 5 Feb 2018 14:21:45 +0800 Subject: [PATCH] Move doc of report backend state to cli 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 --- .../blockstorage-report-backend-state.rst | 20 ------------------- doc/source/admin/index.rst | 1 - doc/source/cli/cli-manage-volumes.rst | 20 +++++++++++++++++++ 3 files changed, 20 insertions(+), 21 deletions(-) delete mode 100644 doc/source/admin/blockstorage-report-backend-state.rst diff --git a/doc/source/admin/blockstorage-report-backend-state.rst b/doc/source/admin/blockstorage-report-backend-state.rst deleted file mode 100644 index 81dce95c943..00000000000 --- a/doc/source/admin/blockstorage-report-backend-state.rst +++ /dev/null @@ -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. diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst index 51ec0be5282..12ff72adf21 100644 --- a/doc/source/admin/index.rst +++ b/doc/source/admin/index.rst @@ -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 diff --git a/doc/source/cli/cli-manage-volumes.rst b/doc/source/cli/cli-manage-volumes.rst index 14793d82ed0..03003282627 100644 --- a/doc/source/cli/cli-manage-volumes.rst +++ b/doc/source/cli/cli-manage-volumes.rst @@ -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.