From ce988794cb16b4bef892ab2bc9c4cd70125ffacf Mon Sep 17 00:00:00 2001
From: Eric Harney <eharney@redhat.com>
Date: Fri, 9 Aug 2019 11:54:24 -0400
Subject: [PATCH] Add contributor notes on cinder-status checks

Change-Id: I8daa424e78b233a098d8c8ed29f93b9a3bb794bd
---
 doc/source/contributor/rolling.upgrades.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/doc/source/contributor/rolling.upgrades.rst b/doc/source/contributor/rolling.upgrades.rst
index 1d086b8c068..4eaab1b441a 100644
--- a/doc/source/contributor/rolling.upgrades.rst
+++ b/doc/source/contributor/rolling.upgrades.rst
@@ -458,3 +458,13 @@ Documentation
 <https://docs.openstack.org/nova/latest/reference/upgrade-checks.html>`_ .
 
 
+What can be checked?
+....................
+
+The cinder-status CLI tool is assumed to be run from a place where it can
+read cinder.conf for the services, and that it can access the Cinder
+database to query information.
+
+It cannot be assumed to have network access to a storage backend -- a backend
+may only be accessible from the Cinder Volume service and not reachable
+directly from where this tool is run.