openstack/openstack-manuals
Code Issues Proposed changes

Fixes bug # 1035483 : server_diagnostics is undocumented

Browse Source 
Fixes filename pointer to .json file.

Rebases against master.

Change-Id: Ic6eb6ec7374ac76fb03e2c79ae10f71243bcec0e
This commit is contained in:
razique
2012-09-19 13:16:19 +02:00
committed by annegentle
parent 404920d370
commit 8b1e76ccd3
4 changed files with 115 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
doc/src/docbkx/openstack-api-site/src/docbkx/index.xml
View File

@@ -81,6 +81,13 @@
href="../wadls/compute-api/src/ext/os-console-output.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-server-diagnostics">
<title>Server Diagnostics</title>
<para>Retrieves the usage data for a server.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-diagnostics.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-consoles">
<title>Server VNC Console</title>
<para>Accesses a VNC console for a specific server.</para>

58
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-diagnostics.wadl Normal file
View File

@@ -0,0 +1,58 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012 OpenStack LLC., All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1">
<resources base="https://servers.api.openstack.com">
<resource id="version" type="#VersionDetails" path="v2/">
<resource id="tenantID" path="{tenant_id}">
<param name="tenant_id" style="template" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">
The ID for the tenant or account in a multi-tenancy cloud.
</p></doc>
</param>
<resource id="Servers" path="servers">
<resource path="{server_id}">
<param name="server_id" style="template" type="csapi:UUID">
<doc><p xmlns="http://www.w3.org/1999/xhtml">
The UUID for the server of interest to you.
</p>
</doc>
</param>
<resource path="action">
<method href="#getDiagnostics"/>
</resource>
</resource>
</resource>
</resource>
</resource>
</resources>
<method name="GET" id="getDiagnostics">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="Server Diagnostics">
<p xmlns="http://www.w3.org/1999/xhtml">
Retrieves basic usage data for a given server.
</p>
</wadl:doc>
<request>
<param name="server_id" style="plain">
<doc><p xmlns="http://www.w3.org/1999/xhtml">
The UUID for the server that you want simple usage data for.
</p>
</doc>
</param>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/os-diagnostics.json" />
</doc>
</representation>
</response>
</method>
</application>

19
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/samples/os-diagnostics.json Normal file
View File

@@ -0,0 +1,19 @@
{
"vnet0_tx_errors":0,
"vda_errors":-1,
"vda_read":4447232,
"vda_write":4347904,
"vnet0_tx_packets":1259,
"vda_write_req":3523,
"memory-actual":524288,
"cpu0_time":195230000000,
"vnet0_tx":364840,
"vnet0_rx_drop":0,
"vnet0_rx_packets":1423,
"vnet0_rx_errors":0,
"memory":524288,
"memory-rss":243188,
"vda_read_req":291,
"vnet0_rx":363725,
"vnet0_tx_drop":0
}

36
doc/src/docbkx/openstack-compute-admin/computetutorials.xml
View File

@@ -176,11 +176,37 @@ export NOVA_VERSION=1.1
<para>You can obtain extra informations about the instance you just spawned : its CPU
usage, the memory, the disk io or network io, per instance, by running the
<command>nova diagnostics</command> command:</para>
<screen>
<prompt>$</prompt> <userinput>nova diagnostics</userinput>
</screen>
<command>nova diagnostics</command> command: <screen><prompt>$</prompt> <userinput>nova list</userinput></screen><programlisting>
+--------------------------------------+------+--------+------------------------+
| ID | Name | Status | Networks |
+--------------------------------------+------+--------+------------------------+
| 50191b9c-b26d-4b61-8404-f149c29acd5a | test | ACTIVE | local-net=192.168.4.35 |
+--------------------------------------+------+--------+------------------------+
</programlisting>
<screen><prompt>$</prompt> <userinput>nova diagnostics 50191b9c-b26d-4b61-8404-f149c29acd5a</userinput> </screen><programlisting>
+------------------+------------+
| Property | Value |
+------------------+------------+
| cpu0_time | 9160000000 |
| memory | 524288 |
| memory-actual | 524288 |
| memory-rss | 178040 |
| vda_errors | -1 |
| vda_read | 3146752 |
| vda_read_req | 202 |
| vda_write | 1024 |
| vda_write_req | 1 |
| vnet0_rx | 610 |
| vnet0_rx_drop | 0 |
| vnet0_rx_errors | 0 |
| vnet0_rx_packets | 7 |
| vnet0_tx | 0 |
| vnet0_tx_drop | 0 |
| vnet0_tx_errors | 0 |
| vnet0_tx_packets | 0 |
+------------------+------------+
</programlisting>
</para>
</section>
<section xml:id="installing-needed-software-for-web-scale">
<title>Part III: Installing the Needed Software for the Web-Scale Scenario</title>