diff options
| author | Sean Dague <sean@dague.net> | 2017-08-10 09:34:13 -0400 |
|---|---|---|
| committer | melanie witt <melwittt@gmail.com> | 2018-08-17 01:41:31 +0000 |
| commit | 8835198b8d09e9a69ea83741fdb1579a98019b51 (patch) | |
| tree | e63549f370d370802c16fc47e35b127759c60a99 /api-ref | |
| parent | df3dd2b5c7f63ca69c9fb5d95ab3c496f729b0d0 (diff) | |
| download | nova-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-ref')
| -rw-r--r-- | api-ref/source/os-services.inc | 11 | ||||
| -rw-r--r-- | api-ref/source/parameters.yaml | 24 |
2 files changed, 27 insertions, 8 deletions
diff --git a/api-ref/source/os-services.inc b/api-ref/source/os-services.inc index 0f2c5cbc27..43659864b7 100644 --- a/api-ref/source/os-services.inc +++ b/api-ref/source/os-services.inc @@ -195,7 +195,16 @@ Update Forced Down .. rest_method:: PUT /os-services/force-down -Set or unset ``forced_down`` flag for the service. +Set or unset ``forced_down`` flag for the service. ``forced_down`` is a manual +override to tell nova that the service in question has been fenced manually by +the operations team (either hard powered off, or network unplugged). That +signals that it is safe to proceed with ``evacuate`` or other operations that +nova has safety checks to prevent for hosts that are up. + +.. warning:: + + Setting a service forced down without completely fencing it will likely + result in the corruption of VMs on that host. Action ``force-down`` available as of microversion 2.11. diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 0e37503ed9..546adf3ab1 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -3085,8 +3085,9 @@ force_snapshot: forced_down_2_11: description: | Whether or not this service was forced down manually by an - administrator. This value is useful to know that some 3rd party has - verified the service should be marked down. + administrator after the service was fenced. This value is useful + to know that some 3rd party has verified the service should be + marked down. in: body required: true type: boolean @@ -3095,9 +3096,17 @@ forced_down_2_11: # PUT /os-services/{service_id} added in 2.53. forced_down_2_53_in: description: | - Whether or not this service was forced down manually by an - administrator. This value is useful to know that some 3rd party has - verified the service should be marked down. + ``forced_down`` is a manual override to tell nova that the service in + question has been fenced manually by the operations team (either hard + powered off, or network unplugged). That signals that it is safe to proceed + with ``evacuate`` or other operations that nova has safety checks to + prevent for hosts that are up. + + .. warning:: + + Setting a service forced down without completely fencing it will likely + result in the corruption of VMs on that host. + in: body required: false type: boolean @@ -3106,8 +3115,9 @@ forced_down_2_53_in: forced_down_2_53_out: description: | Whether or not this service was forced down manually by an - administrator. This value is useful to know that some 3rd party has - verified the service should be marked down. + administrator after the service was fenced. This value is useful + to know that some 3rd party has verified the service should be + marked down. in: body required: true type: boolean |