openstack/nova
Code Issues Proposed changes

api-ref: complete verification of servers-action-crash-dump.inc

Browse Source 
This processes all 4 phases of the crash-dump action

* method verified, error codes cleaned up (extra explanation added where appropriate)
* action parameter added
* example verified
* body adds warning and versionadded stanzas

Part of bp:api-ref-in-rst

Change-Id: I6571a3981d25ab4b5459715c9d2061ad19f07f26
This commit is contained in:
Sean Dague 2016-05-10 09:24:27 -04:00
parent 9a05d38f48
commit d790fe0087
2 changed files with 30 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
api-ref/source/parameters.yaml
View File

@ -2271,6 +2271,12 @@ to_port:
in: body
required: true
type: integer
trigger_crash_dump:
in: body
required: true
type: none
description: |
Specifies the trigger crash dump action should be run
type:
description: |
The snapshot type. A valid value is ``qcow2``.

36
api-ref/source/servers-action-crash-dump.inc
View File

@ -1,26 +1,35 @@
.. -*- rst -*-
.. needs:method_verification
.. needs:parameter_verification
.. needs:example_verification
.. needs:body_verification
Trigger Crash Dump In Server (Trigger_Crash_Dump Action)
========================================================
Trigger Crash Dump In Server
============================
.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action
.. versionadded:: 2.17
Trigger a crash dump in a server.
Specify the ``trigger_crash_dump`` action in the request body.
When a server starts behaving oddly at a fundamental level, it maybe
be useful to get a kernel level crash dump to debug further. The crash
dump action forces a crash dump followed by a system reboot of the
server. Once the server comes back online, you can find a Kernel Crash
Dump file in a certain location of the filesystem. For example, for
Ubuntu you can find it in the ``/var/crash`` directory.
When a crash dump is triggered for a virtual server, it causes a system reboot. This action can cause data loss. Also, network connectivity can be lost. Once the server comes back online, you can find a Kernel Crash Dump file in a certain location of the filesystem. For example, for Ubuntu you can find it in the ``/var/crash`` directory.
.. warning::
Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file.
This action can cause data loss. Also, network connectivity can be
lost both during and after this operation.
Normal response codes: 202
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Error response codes: badRequest(400), unauthorized(401),
forbidden(403), itemNotFound(404), conflict(409)
* 400 is returned if the server does not support a crash dump (either
by configuration or because the backend does not support it)
* 409 is returned if the server is not in a state where a crash dump
action is allowed.
Request
-------
@ -28,7 +37,8 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- server_id: server_id
- server_id: server_id_path
- trigger_crash_dump: trigger_crash_dump
**Example Trigger crash dump: JSON request**
@ -37,3 +47,5 @@ Request
Response
--------
No body is returned on a successful submission.