summaryrefslogtreecommitdiff
path: root/api-guide
diff options
context:
space:
mode:
authorSean Dague <sean@dague.net>2017-08-10 09:34:13 -0400
committermelanie witt <melwittt@gmail.com>2018-08-17 01:41:31 +0000
commit8835198b8d09e9a69ea83741fdb1579a98019b51 (patch)
treee63549f370d370802c16fc47e35b127759c60a99 /api-guide
parentdf3dd2b5c7f63ca69c9fb5d95ab3c496f729b0d0 (diff)
downloadnova-8835198b8d09e9a69ea83741fdb1579a98019b51.tar.gz
Update api-guide and api-ref to be clear about forced-down
Closes-Bug: #1691871 Related-Bug: #1784826 Change-Id: Ifc6f1549d88a1b7d9f6e25c962c8a15dd8e180fb
Diffstat (limited to 'api-guide')
-rw-r--r--api-guide/source/general_info.rst29
1 files changed, 22 insertions, 7 deletions
diff --git a/api-guide/source/general_info.rst b/api-guide/source/general_info.rst
index 3dca099d6d..a32f62849b 100644
--- a/api-guide/source/general_info.rst
+++ b/api-guide/source/general_info.rst
@@ -182,6 +182,10 @@ on compute hosts rather than servers.
- **Services Actions**
+ .. note::
+ The services actions described in this section apply only to
+ **nova-compute** services.
+
- **enable, disable, disable-log-reason**
The service can be disabled to indicate the service is not available anymore.
@@ -196,13 +200,24 @@ on compute hosts rather than servers.
.. note::
This action is enabled in microversion 2.11.
- This action allows you set the state of service down immediately. Actually
- Nova only provides the health monitor of service status, there isn't any
- guarantee about health status of other parts of infrastructure, like the
- health status of data network, storage network and other components. The
- more complete health monitor of infrastructure is provided by external
- system normally. An external health monitor system can mark the service
- down for notifying the fault.
+ This action allows you set the state of service down immediately. Nova
+ only provides a very basic health monitor of service status, there isn't
+ any guarantee about health status of other parts of infrastructure, like
+ the health status of data network, storage network and other
+ components.
+
+ If you have a more extensive health monitoring system external to Nova,
+ and know that the service in question is dead (and disconnected from the
+ network), this can be used to tell the rest of Nova it can trust that this
+ service is never coming back, and allow actions such as evacuate.
+
+ .. warning::
+
+ This must *only* be used if you have fully fenced the service in
+ question, and that it can never send updates to the rest of the
+ system. This can be done by powering off the node or completely
+ isolating its networking. If you force-down a service that is not
+ fenced you can corrupt the VMs that were running on that host.
- **Hosts**