openstack/nova
Code Issues Proposed changes
b32860b773
nova/api-ref/source/diagnostics.inc

73 lines
2.2 KiB
PHP
Raw Normal View History

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
.. -*- rst -*-
============================================
Servers diagnostics (servers, diagnostics)
============================================
Shows the usage data for a server.
Show Server Diagnostics
=======================
remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
2016-06-02 08:50:03 -04:00
.. rest_method:: GET /servers/{server_id}/diagnostics
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Shows basic usage data for a server.
api-ref: complete verification for diagnostics.inc This completes the verification for the diagnostics API. As the response is still dumping out raw hypervisor stats (for compatibility https://github.com/openstack/nova/blob/7529b94f4a0be17fb3988362619f83b404ccad86/nova/api/openstack/compute/server_diagnostics.py#L38-L44) the best we can say about the response is it's hypervisor specific and don't use it. In future we should use the standardized format that was defined during the v3 effort. Part of bp:api-ref-in-rst Change-Id: Id2cca6a2f79542bec17a34aa3d31924e8ed7b9e5
2016-05-09 08:50:06 -04:00
Policy defaults enable only users with the administrative role. Cloud
providers can change these permissions through the ``policy.json``
file.
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Normal response codes: 200
Complet Method Verification of server diag This complete the Method Verification of server diagnostics, as this is the only method supported. http://paste.openstack.org/show/495198/ has the method call and return sample value. also, clean default policy value and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I8e63cdb30e5da34522790f110ecaff79f7577eb1
2016-04-22 07:45:43 +08:00
Error response codes: unauthorized(401), forbidden(403), notfound(404), conflict(409), notimplemented(501)
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Request
move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-14 13:10:59 -04:00
-------
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
.. rest_parameters:: parameters.yaml
API Ref: update server_id params - Update server_id params to be of type path. - Cleaned up os-getConsoleOutput action string. - Made empty response body description more consistent. Review and change as needed. Implements: bp/api-ref-in-rst-ocata Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4
2016-10-10 14:50:17 -04:00
- server_id: server_id_path
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Response
move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-14 13:10:59 -04:00
--------
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Standardization of VM diagnostics info API. Before this patch, VM diagnostics response was just a 'blob' of data returned by each hypervisor. New API version makes diagnostics response standardized. New response has a set of fields which each hypervisor will try to fill. If hypervisor unable to provide a specific field then this field will be reported as 'None'. Tempest tests: I7757c5beeea3d3b0bc15a51cafc5ea2ada65e76c DocImpact: admin guide docs should be updated to mention standardized version of the diagnostics response blueprint: restore-vm-diagnostics Change-Id: If0b1493cc5c1c7f0d9896dd68342ad4dea4f7da2
2016-08-16 15:04:14 +03:00
Starting from **microversion 2.48** diagnostics response is standardized
across all virt drivers. The response should be considered a debug interface
only and not relied upon by programmatic tools. All response fields are listed
below. If the virt driver is unable to provide a specific field then this field
will be reported as ``None`` in the response.
.. rest_parameters:: parameters.yaml
- config_drive: config_drive_diagnostics
- state: vm_state_diagnostics
- driver: driver_diagnostics
- hypervisor: hypervisor_diagnostics
- hypervisor_os: hypervisor_os_diagnostics
- uptime: uptime_diagnostics
- num_cpus: num_cpus_diagnostics
- num_disks: num_disks_diagnostics
- num_nics: num_nics_diagnostics
- memory_details: memory_details_diagnostics
- cpu_details: cpu_details_diagnostics
- disk_details: disk_details_diagnostics
- nic_details: nic_details_diagnostics
api-ref: complete verification for diagnostics.inc This completes the verification for the diagnostics API. As the response is still dumping out raw hypervisor stats (for compatibility https://github.com/openstack/nova/blob/7529b94f4a0be17fb3988362619f83b404ccad86/nova/api/openstack/compute/server_diagnostics.py#L38-L44) the best we can say about the response is it's hypervisor specific and don't use it. In future we should use the standardized format that was defined during the v3 effort. Part of bp:api-ref-in-rst Change-Id: Id2cca6a2f79542bec17a34aa3d31924e8ed7b9e5
2016-05-09 08:50:06 -04:00
Fixed some nits for microversion 2.48 The main piece of code for microversion 2.48 was merged. This patch fixes some nits in docs and error messages. Change-Id: I8bc5010c255494d4e1bf36272215422991264c6d
2017-06-06 17:31:45 +04:00
**Example Server diagnostics (2.48)**
api-ref: complete verification for diagnostics.inc This completes the verification for the diagnostics API. As the response is still dumping out raw hypervisor stats (for compatibility https://github.com/openstack/nova/blob/7529b94f4a0be17fb3988362619f83b404ccad86/nova/api/openstack/compute/server_diagnostics.py#L38-L44) the best we can say about the response is it's hypervisor specific and don't use it. In future we should use the standardized format that was defined during the v3 effort. Part of bp:api-ref-in-rst Change-Id: Id2cca6a2f79542bec17a34aa3d31924e8ed7b9e5
2016-05-09 08:50:06 -04:00
Standardization of VM diagnostics info API. Before this patch, VM diagnostics response was just a 'blob' of data returned by each hypervisor. New API version makes diagnostics response standardized. New response has a set of fields which each hypervisor will try to fill. If hypervisor unable to provide a specific field then this field will be reported as 'None'. Tempest tests: I7757c5beeea3d3b0bc15a51cafc5ea2ada65e76c DocImpact: admin guide docs should be updated to mention standardized version of the diagnostics response blueprint: restore-vm-diagnostics Change-Id: If0b1493cc5c1c7f0d9896dd68342ad4dea4f7da2
2016-08-16 15:04:14 +03:00
.. literalinclude:: ../../doc/api_samples/os-server-diagnostics/v2.48/server-diagnostics-get-resp.json
:language: javascript
.. warning::
Before **microversion 2.48** the response format for diagnostics was not
well defined. Each hypervisor had its own format.
Fixed some nits for microversion 2.48 The main piece of code for microversion 2.48 was merged. This patch fixes some nits in docs and error messages. Change-Id: I8bc5010c255494d4e1bf36272215422991264c6d
2017-06-06 17:31:45 +04:00
**Example Server diagnostics (2.1)**
Standardization of VM diagnostics info API. Before this patch, VM diagnostics response was just a 'blob' of data returned by each hypervisor. New API version makes diagnostics response standardized. New response has a set of fields which each hypervisor will try to fill. If hypervisor unable to provide a specific field then this field will be reported as 'None'. Tempest tests: I7757c5beeea3d3b0bc15a51cafc5ea2ada65e76c DocImpact: admin guide docs should be updated to mention standardized version of the diagnostics response blueprint: restore-vm-diagnostics Change-Id: If0b1493cc5c1c7f0d9896dd68342ad4dea4f7da2
2016-08-16 15:04:14 +03:00
Add more description for rx and tx param Add more description for rx and tx in diagnostics command. Change-Id: Ia4bc5a43a0a90392444dfbe710d6622986bf34b0 Closes-Bug: 1628368
2016-11-04 06:48:51 +08:00
Below is an example of diagnostics for a libvirt based instance. The unit of the return
value is hypervisor specific, but in this case the unit of vnet1_rx* and
vnet1_tx* is octets.
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Fix diagnostics, extensions api ref update those files api-ref Part of bp:api-ref-in-rst Change-Id: Id68dbc77011a7414edda5a4855ccbddb204031ac
2016-03-23 19:17:40 +08:00
.. literalinclude:: ../../doc/api_samples/os-server-diagnostics/server-diagnostics-get-resp.json
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
:language: javascript
Copy Permalink