openstack/openstack-manuals
Code Issues Proposed changes

Updates OpenStack Telemetry to the Telemetry module

Browse Source 
Change-Id: Iee29c6a5b7dccdd265c163d8da5d73214e51c95b
Closes-bug: 1277107
backport:havana
This commit is contained in:
Anne Gentle
2014-02-06 12:12:54 -06:00
parent b6029bfed8
commit e61a869351
12 changed files with 22 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/common/app_support.xml
View File

@@ -285,7 +285,7 @@ and so on.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><link xlink:href="https://bugs.launchpad.net/ceilometer" <para><link xlink:href="https://bugs.launchpad.net/ceilometer"
>Bugs: OpenStack Telemetry (ceilometer)</link></para> >Bugs: Telemetry (ceilometer)</link></para>
</listitem> </listitem>
<listitem> <listitem>
<para><link xlink:href="https://bugs.launchpad.net/trove" <para><link xlink:href="https://bugs.launchpad.net/trove"

2
doc/common/ch_cli_ceilometer_commands.xml
View File

@@ -10,7 +10,7 @@
<title>ceilometer commands</title> <title>ceilometer commands</title>
<para>The ceilometer client is the command-line interface (CLI) for the <para>The ceilometer client is the command-line interface (CLI) for the
OpenStack Telemetry API and its extensions.</para> Telemetry API and its extensions.</para>
<para>For help on a specific <command>ceilometer</command> <para>For help on a specific <command>ceilometer</command>
command, enter: command, enter:
</para> </para>

4
doc/common/ch_getstart.xml
View File

@@ -123,7 +123,7 @@
<tr> <tr>
<td><link <td><link
xlink:href="http://www.openstack.org/software/openstack-shared-services/" xlink:href="http://www.openstack.org/software/openstack-shared-services/"
>Telemetry Service</link></td> >Telemetry</link></td>
<td><link <td><link
xlink:href="http://docs.openstack.org/developer/ceilometer/" xlink:href="http://docs.openstack.org/developer/ceilometer/"
>Ceilometer</link></td> >Ceilometer</link></td>
@@ -135,7 +135,7 @@
<tr> <tr>
<td><link <td><link
xlink:href="http://www.openstack.org/software/openstack-shared-services/" xlink:href="http://www.openstack.org/software/openstack-shared-services/"
>Orchestration Service</link></td> >Orchestration</link></td>
<td><link <td><link
xlink:href="http://docs.openstack.org/developer/heat/" xlink:href="http://docs.openstack.org/developer/heat/"
>Heat</link></td> >Heat</link></td>

4
doc/common/section_getstart_telemetry.xml
View File

@@ -2,8 +2,8 @@
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="metering-service"> xml:id="metering-service">
<title>The Telemetry Service</title> <title>Telemetry</title>
<para>The OpenStack Telemetry service:</para> <para>The Telemetry module:</para>
<para> <para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>

4
doc/install-guide/ch_ceilometer.xml
View File

@@ -3,9 +3,9 @@
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="ch_ceilometer"> xml:id="ch_ceilometer">
<title>Add the Telemetry service</title> <title>Add the Telemetry module</title>
<para>The OpenStack Telemetry service provides a framework for <para>Telemetry provides a framework for
monitoring and metering the OpenStack cloud. It is also known monitoring and metering the OpenStack cloud. It is also known
as the Ceilometer project.</para> as the Ceilometer project.</para>
<xi:include href="../common/section_getstart_telemetry.xml"/> <xi:include href="../common/section_getstart_telemetry.xml"/>

3
doc/install-guide/section_ceilometer-cinder.xml
View File

@@ -4,8 +4,7 @@
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"> xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
<?dbhtml-stop-chunking?> <?dbhtml-stop-chunking?>
<title>Add the Block Storage Service agent for the Telemetry <title>Add the Block Storage Service agent for Telemetry</title>
service</title>
<procedure> <procedure>
<step> <step>
<para>To retrieve volume samples, you must configure the Block <para>To retrieve volume samples, you must configure the Block

2
doc/install-guide/section_ceilometer-glance.xml
View File

@@ -3,7 +3,7 @@
xmlns="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"> xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
<title>Add the Image Service agent for the Telemetry service</title> <title>Add the Image Service agent for Telemetry</title>
<procedure> <procedure>
<step> <step>
<para>To retrieve image samples, you must configure the Image <para>To retrieve image samples, you must configure the Image

4
doc/install-guide/section_ceilometer-install.xml
View File

@@ -3,9 +3,9 @@
xmlns="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"> xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
<title>Install the Telemetry service</title> <title>Install the Telemetry module</title>
<procedure> <procedure>
<para>OpenStack Telemetry is an API service that <para>Telemetry provides an API service that
provides a collector and a range of disparate agents. Before provides a collector and a range of disparate agents. Before
you can install these agents on nodes such as the compute you can install these agents on nodes such as the compute
node, you must use this procedure to install the core node, you must use this procedure to install the core

4
doc/install-guide/section_ceilometer-nova.xml
View File

@@ -4,9 +4,9 @@
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"> xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
<?dbhtml-stop-chunking?> <?dbhtml-stop-chunking?>
<title>Install the Compute agent for the Telemetry service</title> <title>Install the Compute agent for Telemetry</title>
<procedure> <procedure>
<para>OpenStack Telemetry is an API service that provides a <para>Telemetry provides an API service that provides a
collector and a range of disparate agents. This procedure collector and a range of disparate agents. This procedure
details how to install the agent that runs on the compute details how to install the agent that runs on the compute
node.</para> node.</para>

11
doc/install-guide/section_ceilometer-verify.xml
View File

@@ -2,14 +2,14 @@
<section xml:id="ceilometer-verify" xmlns="http://docbook.org/ns/docbook" <section xml:id="ceilometer-verify" xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"> xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
<title>Verify the Telemetry Service installation</title> <title>Verify the Telemetry installation</title>
<para>To test the Telemetry Service installation, download an image from the <para>To test the Telemetry installation, download an image from the
Image Service, and use the Telemetry Service to display usage statistics.</para> Image Service, and use the <command>ceilometer</command> command to display usage statistics.</para>
<procedure> <procedure>
<step> <step>
<para>Use the <literal>ceilometer meter-list</literal> command to test <para>Use the <literal>ceilometer meter-list</literal> command to test
the access to the Telemetry Service:</para> the access to Telemetry:</para>
<screen><prompt>$</prompt> <userinput>ceilometer meter-list</userinput></screen> <screen><prompt>$</prompt> <userinput>ceilometer meter-list</userinput></screen>
<screen><computeroutput>+------------+-------+-------+--------------------------------------+---------+----------------------------------+ <screen><computeroutput>+------------+-------+-------+--------------------------------------+---------+----------------------------------+
| Name | Type | Unit | Resource ID | User ID | Project ID | | Name | Type | Unit | Resource ID | User ID | Project ID |
@@ -24,8 +24,7 @@
</step> </step>
<step> <step>
<para>Call the <literal>ceilometer meter-list</literal> command again to <para>Call the <literal>ceilometer meter-list</literal> command again to
validate that the download has been detected and stored by the Telemetry validate that the download has been detected and stored by the Telemetry:</para>
Service:</para>
<screen><prompt>$</prompt> <userinput>ceilometer meter-list</userinput></screen> <screen><prompt>$</prompt> <userinput>ceilometer meter-list</userinput></screen>
<screen><computeroutput>+----------------+-------+-------+--------------------------------------+---------+----------------------------------+ <screen><computeroutput>+----------------+-------+-------+--------------------------------------+---------+----------------------------------+
| Name | Type | Unit | Resource ID | User ID | Project ID | | Name | Type | Unit | Resource ID | User ID | Project ID |

2
doc/user-guide-admin/section_dashboard_admin_view_cloud_resources.xml
View File

@@ -10,7 +10,7 @@
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:svg="http://www.w3.org/2000/svg" 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"> xmlns:html="http://www.w3.org/1999/xhtml" version="5.0" xml:id="section_ceilometer_dashboard">
<title>View cloud usage statistics</title> <title>View cloud usage statistics</title>
<para>The Telemetry service provides user-level usage data for OpenStack-based clouds, <para>The Telemetry module provides user-level usage data for OpenStack-based clouds,
which can be used for customer billing, system monitoring, or alerts. Data can be which can be used for customer billing, system monitoring, or alerts. Data can be
collected by notifications sent by existing OpenStack components (for example, collected by notifications sent by existing OpenStack components (for example,
usage events emitted from Compute) or by polling the infrastructure (for example, usage events emitted from Compute) or by polling the infrastructure (for example,

4
doc/user-guide/section_cli_ceilometer.xml
View File

@@ -6,13 +6,13 @@
xmlns:html="http://www.w3.org/1999/xhtml" version="5.0" xmlns:html="http://www.w3.org/1999/xhtml" version="5.0"
xml:id="ceilometer_cli_commands"> xml:id="ceilometer_cli_commands">
<title>Measure cloud resources</title> <title>Measure cloud resources</title>
<para>The OpenStack Telemetry service measures cloud resources in <para>Telemetry measures cloud resources in
OpenStack.</para> OpenStack.</para>
<para>It collects information about how much, who, what, and when <para>It collects information about how much, who, what, and when
with regards to billing. Currently, metering is available with regards to billing. Currently, metering is available
through only the <command>ceilometer</command> command-line through only the <command>ceilometer</command> command-line
client.</para> client.</para>
<para>To model data, the Telemetry service uses these <para>To model data, Telemetry uses these
abstractions:</para> abstractions:</para>
<variablelist wordsize="10"> <variablelist wordsize="10">
<varlistentry> <varlistentry>