From 97d1dd212462387c5dced0ad79cc2d2d589d64a0 Mon Sep 17 00:00:00 2001
From: Summer Long <slong@redhat.com>
Date: Fri, 10 Jan 2014 10:02:19 +1000
Subject: [PATCH] Added admin info/procedure for viewing cloud statistics.

Also moved 'View Services' section under 'View cloud resources' umbrella.
Tech reviewed by Ladislav Smola.

Change-Id: Ie89b99794e7e3e8b0aa1a6d1663fe68aed2747fa
Closes-Bug: #1267638
---
 doc/user-guide-admin/ch_dashboard.xml         |  2 +-
 ...ction_dashboard_admin_manage_resources.xml | 16 ++++++
 ...n_dashboard_admin_view_cloud_resources.xml | 52 +++++++++++++++++++
 3 files changed, 69 insertions(+), 1 deletion(-)
 create mode 100644 doc/user-guide-admin/section_dashboard_admin_manage_resources.xml
 create mode 100644 doc/user-guide-admin/section_dashboard_admin_view_cloud_resources.xml

diff --git a/doc/user-guide-admin/ch_dashboard.xml b/doc/user-guide-admin/ch_dashboard.xml
index 914875e132..0f018f2cdd 100644
--- a/doc/user-guide-admin/ch_dashboard.xml
+++ b/doc/user-guide-admin/ch_dashboard.xml
@@ -32,5 +32,5 @@
     <?hard-pagebreak?>
     <xi:include href="section_dashboard_admin_set_quotas.xml"/>
     <?hard-pagebreak?>
-    <xi:include href="section_dashboard_admin_manage_services.xml"/>
+    <xi:include href="section_dashboard_admin_manage_resources.xml"/>
 </chapter>
diff --git a/doc/user-guide-admin/section_dashboard_admin_manage_resources.xml b/doc/user-guide-admin/section_dashboard_admin_manage_resources.xml
new file mode 100644
index 0000000000..55904c2a69
--- /dev/null
+++ b/doc/user-guide-admin/section_dashboard_admin_manage_resources.xml
@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE section [
+<!-- Some useful entities bortred from HTML -->
+<!ENTITY ndash  "&#x2013;">
+<!ENTITY mdash  "&#x2014;">
+<!ENTITY hellip "&#x2026;">
+<!ENTITY plusmn "&#xB1;">
+]>
+<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
+    xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:svg="http://www.w3.org/2000/svg"
+    xmlns:html="http://www.w3.org/1999/xhtml" version="5.0"
+    xml:id="section_dashboard_admin_manage_resources">
+    <title>View cloud resources</title>
+    <xi:include href="section_dashboard_admin_manage_services.xml"/>
+    <xi:include href="section_dashboard_admin_view_cloud_resources.xml"/>
+</section>
diff --git a/doc/user-guide-admin/section_dashboard_admin_view_cloud_resources.xml b/doc/user-guide-admin/section_dashboard_admin_view_cloud_resources.xml
new file mode 100644
index 0000000000..ff9a05bb5f
--- /dev/null
+++ b/doc/user-guide-admin/section_dashboard_admin_view_cloud_resources.xml
@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE section [
+<!-- Some useful entities bortred from HTML -->
+<!ENTITY ndash  "&#x2013;">
+<!ENTITY mdash  "&#x2014;">
+<!ENTITY hellip "&#x2026;">
+<!ENTITY plusmn "&#xB1;">
+]>
+<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
+    xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:svg="http://www.w3.org/2000/svg"
+    xmlns:html="http://www.w3.org/1999/xhtml" version="5.0" xml:id="section_ceilometer_dashboard">
+    <title>View cloud usage statistics</title>
+    <para>The Telemetry service provides user-level usage data for OpenStack-based clouds,
+        which can be used for customer billing, system monitoring, or alerts. Data can be
+        collected by notifications sent by existing OpenStack components (for example,
+        usage events emitted from Compute) or by polling the infrastructure (for example,
+        libvirt).
+  </para>
+    <note><para>You can only view metering statistics on the dashboard (available only to adminstrators). The Telemetry service
+        must be set up and administered through the <command>ceilometer</command> command-line
+        interface (CLI).
+  </para>
+        <para>For basic administration information, refer to the "Measure Cloud Resources" chapter in the
+            <citetitle>OpenStack End User Guide</citetitle>.</para></note>
+  <section xml:id="dashboard_view_resource_stats">
+        <title>View resource statistics</title>
+        <procedure>
+            <step>
+                <para>Log in to the OpenStack dashboard as a user with Admin privileges.</para>
+            </step>
+            <step><para>On the <guilabel>Admin</guilabel> tab, click the
+                <guilabel>Resource Usage</guilabel> category.</para>
+            </step>
+            <step>
+                <para>Click the:
+                    <itemizedlist>
+                        <listitem><para><guilabel>Global Disk Usage</guilabel> tab to view disk usage per tenant (project).</para></listitem>
+                        <listitem><para><guilabel>Global Network Traffic Usage</guilabel> tab to view ingress or egress usage per tenant
+                                (project).</para></listitem>
+                        <listitem><para><guilabel>Global Network Usage</guilabel> tab to view duration and creation requests for
+                                networks, subnets, routers, ports, and floating IPs, per  tenant
+                                (project).</para></listitem>
+                        <listitem><para><guilabel>Stats</guilabel> tab to view a multi-series line chart with user-defined metrics.
+                                You group by project, define the value type (min, max, avg, or sum),
+                                and specify the time period (or even use a calendar to define a date
+                                range).</para></listitem>
+                    </itemizedlist>
+                </para>
+            </step>
+        </procedure>
+    </section>
+</section>