From e61a869351639f3b2b3301db0d6d4bec2cc2d689 Mon Sep 17 00:00:00 2001 From: Anne Gentle Date: Thu, 6 Feb 2014 12:12:54 -0600 Subject: [PATCH] Updates OpenStack Telemetry to the Telemetry module Change-Id: Iee29c6a5b7dccdd265c163d8da5d73214e51c95b Closes-bug: 1277107 backport:havana --- doc/common/app_support.xml | 2 +- doc/common/ch_cli_ceilometer_commands.xml | 2 +- doc/common/ch_getstart.xml | 4 ++-- doc/common/section_getstart_telemetry.xml | 4 ++-- doc/install-guide/ch_ceilometer.xml | 4 ++-- doc/install-guide/section_ceilometer-cinder.xml | 3 +-- doc/install-guide/section_ceilometer-glance.xml | 2 +- doc/install-guide/section_ceilometer-install.xml | 4 ++-- doc/install-guide/section_ceilometer-nova.xml | 4 ++-- doc/install-guide/section_ceilometer-verify.xml | 11 +++++------ .../section_dashboard_admin_view_cloud_resources.xml | 2 +- doc/user-guide/section_cli_ceilometer.xml | 4 ++-- 12 files changed, 22 insertions(+), 24 deletions(-) diff --git a/doc/common/app_support.xml b/doc/common/app_support.xml index 73ae0e6bf5..68d3bcebf4 100644 --- a/doc/common/app_support.xml +++ b/doc/common/app_support.xml @@ -285,7 +285,7 @@ and so on. Bugs: OpenStack Telemetry (ceilometer) + >Bugs: Telemetry (ceilometer) ceilometer commands The ceilometer client is the command-line interface (CLI) for the - OpenStack Telemetry API and its extensions. + Telemetry API and its extensions. For help on a specific ceilometer command, enter: diff --git a/doc/common/ch_getstart.xml b/doc/common/ch_getstart.xml index a35bfec2f8..074c254712 100644 --- a/doc/common/ch_getstart.xml +++ b/doc/common/ch_getstart.xml @@ -123,7 +123,7 @@ Telemetry Service + >Telemetry Ceilometer @@ -135,7 +135,7 @@ Orchestration Service + >Orchestration Heat diff --git a/doc/common/section_getstart_telemetry.xml b/doc/common/section_getstart_telemetry.xml index 4adbedaaf1..4a2ba2e8ed 100644 --- a/doc/common/section_getstart_telemetry.xml +++ b/doc/common/section_getstart_telemetry.xml @@ -2,8 +2,8 @@ xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="metering-service"> - The Telemetry Service - The OpenStack Telemetry service: + Telemetry + The Telemetry module: diff --git a/doc/install-guide/ch_ceilometer.xml b/doc/install-guide/ch_ceilometer.xml index 680174edba..d64b773d25 100644 --- a/doc/install-guide/ch_ceilometer.xml +++ b/doc/install-guide/ch_ceilometer.xml @@ -3,9 +3,9 @@ xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="ch_ceilometer"> - Add the Telemetry service + Add the Telemetry module - The OpenStack Telemetry service provides a framework for + Telemetry provides a framework for monitoring and metering the OpenStack cloud. It is also known as the Ceilometer project. diff --git a/doc/install-guide/section_ceilometer-cinder.xml b/doc/install-guide/section_ceilometer-cinder.xml index 7ff31de88f..39cc4a8180 100644 --- a/doc/install-guide/section_ceilometer-cinder.xml +++ b/doc/install-guide/section_ceilometer-cinder.xml @@ -4,8 +4,7 @@ xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"> - Add the Block Storage Service agent for the Telemetry - service + Add the Block Storage Service agent for Telemetry To retrieve volume samples, you must configure the Block diff --git a/doc/install-guide/section_ceilometer-glance.xml b/doc/install-guide/section_ceilometer-glance.xml index 16a172c909..e95c4ce7d7 100644 --- a/doc/install-guide/section_ceilometer-glance.xml +++ b/doc/install-guide/section_ceilometer-glance.xml @@ -3,7 +3,7 @@ xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"> - Add the Image Service agent for the Telemetry service + Add the Image Service agent for Telemetry To retrieve image samples, you must configure the Image diff --git a/doc/install-guide/section_ceilometer-install.xml b/doc/install-guide/section_ceilometer-install.xml index fae27441a1..357e55c957 100644 --- a/doc/install-guide/section_ceilometer-install.xml +++ b/doc/install-guide/section_ceilometer-install.xml @@ -3,9 +3,9 @@ xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"> - Install the Telemetry service + Install the Telemetry module - OpenStack Telemetry is an API service that + Telemetry provides an API service that provides a collector and a range of disparate agents. Before you can install these agents on nodes such as the compute node, you must use this procedure to install the core diff --git a/doc/install-guide/section_ceilometer-nova.xml b/doc/install-guide/section_ceilometer-nova.xml index 933353749c..8b505ef5b5 100644 --- a/doc/install-guide/section_ceilometer-nova.xml +++ b/doc/install-guide/section_ceilometer-nova.xml @@ -4,9 +4,9 @@ xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"> - Install the Compute agent for the Telemetry service + Install the Compute agent for Telemetry - OpenStack Telemetry is an API service that provides a + Telemetry provides an API service that provides a collector and a range of disparate agents. This procedure details how to install the agent that runs on the compute node. diff --git a/doc/install-guide/section_ceilometer-verify.xml b/doc/install-guide/section_ceilometer-verify.xml index f41d74d519..ab577e11a9 100644 --- a/doc/install-guide/section_ceilometer-verify.xml +++ b/doc/install-guide/section_ceilometer-verify.xml @@ -2,14 +2,14 @@
- Verify the Telemetry Service installation - To test the Telemetry Service installation, download an image from the - Image Service, and use the Telemetry Service to display usage statistics. + Verify the Telemetry installation + To test the Telemetry installation, download an image from the + Image Service, and use the ceilometer command to display usage statistics. Use the ceilometer meter-list command to test - the access to the Telemetry Service: + the access to Telemetry: $ ceilometer meter-list +------------+-------+-------+--------------------------------------+---------+----------------------------------+ | Name | Type | Unit | Resource ID | User ID | Project ID | @@ -24,8 +24,7 @@ Call the ceilometer meter-list command again to - validate that the download has been detected and stored by the Telemetry - Service: + validate that the download has been detected and stored by the Telemetry: $ ceilometer meter-list +----------------+-------+-------+--------------------------------------+---------+----------------------------------+ | Name | Type | Unit | Resource ID | User ID | Project ID | 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 index ff9a05bb5f..1c4036decd 100644 --- a/doc/user-guide-admin/section_dashboard_admin_view_cloud_resources.xml +++ b/doc/user-guide-admin/section_dashboard_admin_view_cloud_resources.xml @@ -10,7 +10,7 @@ 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"> View cloud usage statistics - The Telemetry service provides user-level usage data for OpenStack-based clouds, + 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 collected by notifications sent by existing OpenStack components (for example, usage events emitted from Compute) or by polling the infrastructure (for example, diff --git a/doc/user-guide/section_cli_ceilometer.xml b/doc/user-guide/section_cli_ceilometer.xml index 2c92769974..c7bd55bfe9 100644 --- a/doc/user-guide/section_cli_ceilometer.xml +++ b/doc/user-guide/section_cli_ceilometer.xml @@ -6,13 +6,13 @@ xmlns:html="http://www.w3.org/1999/xhtml" version="5.0" xml:id="ceilometer_cli_commands"> Measure cloud resources - The OpenStack Telemetry service measures cloud resources in + Telemetry measures cloud resources in OpenStack. It collects information about how much, who, what, and when with regards to billing. Currently, metering is available through only the ceilometer command-line client. - To model data, the Telemetry service uses these + To model data, Telemetry uses these abstractions: