openstack/openstack-manuals
Code Issues Proposed changes

[install-guide] convert ceilometer chapter to RST

Browse Source 
Change-Id: Icabce33a7b95a5b76a42a3e56fd72ebbeff06e54
Implements: blueprint installguide-liberty
This commit is contained in:
KATO Tomoyuki 2015-07-09 09:19:26 +09:00
parent 8e0f1ea378
commit fd9d0eb327
8 changed files with 110 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/install-guide-rst/source/ceilometer-cinder.rst Normal file
View File

@ -0,0 +1,3 @@
===================================
Configure the Block Storage service
===================================

3
doc/install-guide-rst/source/ceilometer-controller.rst Normal file
View File

@ -0,0 +1,3 @@
=====================================
Install and configure controller node
=====================================

3
doc/install-guide-rst/source/ceilometer-glance.rst Normal file
View File

@ -0,0 +1,3 @@
===========================
Configure the Image service
===========================

9
doc/install-guide-rst/source/ceilometer-next-steps.rst Normal file
View File

@ -0,0 +1,9 @@
==========
Next steps
==========
Your OpenStack environment now includes Telemetry.
You can launch an instance or add more
services to your environment in the previous chapters.
.. TODO(katomo): add link to "launch an instance" after creation

3
doc/install-guide-rst/source/ceilometer-nova.rst Normal file
View File

@ -0,0 +1,3 @@
=============================
Configure the Compute service
=============================

3
doc/install-guide-rst/source/ceilometer-swift.rst Normal file
View File

@ -0,0 +1,3 @@
====================================
Configure the Object Storage service
====================================

71
doc/install-guide-rst/source/ceilometer-verify.rst Normal file
View File

@ -0,0 +1,71 @@
=================================
Verify the Telemetry installation
=================================
This section describes how to verify operation of the Telemetry module.
.. note::
Perform these steps on the controller node.
#. Source the ``admin`` credentials to gain access to
admin-only CLI commands:
.. code-block:: console
$ source admin-openrc.sh
#. List available meters:
.. code-block:: console
$ ceilometer meter-list
+--------------+-------+-------+--------------------------------------+---------+------------+
| Name | Type | Unit | Resource ID | User ID | Project ID |
+--------------+-------+-------+--------------------------------------+---------+------------+
| image | gauge | image | acafc7c0-40aa-4026-9673-b879898e1fc2 | None | cf12a15... |
| image.size | gauge | B | acafc7c0-40aa-4026-9673-b879898e1fc2 | None | cf12a15... |
| image.update | delta | image | acafc7c0-40aa-4026-9673-b879898e1fc2 | None | cf12a15... |
| image.upload | delta | image | acafc7c0-40aa-4026-9673-b879898e1fc2 | None | cf12a15... |
+--------------+-------+-------+--------------------------------------+---------+------------+
#. Download an image from the Image service:
.. code-block:: console
$ IMAGE_ID=$(glance image-list | grep 'cirros-0.3.4-x86_64' | awk '{ print $2 }')
$ glance image-download $IMAGE_ID > /tmp/cirros.img
#. List available meters again to validate detection of the image
download:
.. code-block:: console
$ ceilometer meter-list
+----------------+-------+-------+--------------------------------------+---------+------------+
| Name | Type | Unit | Resource ID | User ID | Project ID |
+----------------+-------+-------+--------------------------------------+---------+------------+
| image | gauge | image | acafc7c0-40aa-4026-9673-b879898e1fc2 | None | cf12a15... |
| image.download | delta | B | acafc7c0-40aa-4026-9673-b879898e1fc2 | None | cf12a15... |
| image.serve | delta | B | acafc7c0-40aa-4026-9673-b879898e1fc2 | None | cf12a15... |
| image.size | gauge | B | acafc7c0-40aa-4026-9673-b879898e1fc2 | None | cf12a15... |
| image.update | delta | image | acafc7c0-40aa-4026-9673-b879898e1fc2 | None | cf12a15... |
| image.upload | delta | image | acafc7c0-40aa-4026-9673-b879898e1fc2 | None | cf12a15... |
+----------------+-------+-------+--------------------------------------+---------+------------+
#. Retrieve usage statistics from the ``image.download`` meter:
.. code-block:: console
$ ceilometer statistics -m image.download -p 60
+--------+---------------------+---------------------+------------+------------+------------+------------+-------+----------+----------------------------+----------------------------+
| Period | Period Start | Period End | Max | Min | Avg | Sum | Count | Duration | Duration Start | Duration End |
+--------+---------------------+---------------------+------------+------------+------------+------------+-------+----------+----------------------------+----------------------------+
| 60 | 2015-04-21T12:21:45 | 2015-04-21T12:22:45 | 13200896.0 | 13200896.0 | 13200896.0 | 13200896.0 | 1 | 0.0 | 2015-04-21T12:22:12.983000 | 2015-04-21T12:22:12.983000 |
+--------+---------------------+---------------------+------------+------------+------------+------------+-------+----------+----------------------------+----------------------------+
#. Remove the previously downloaded image file :file:`/tmp/cirros.img`:
.. code-block:: console
$ rm /tmp/cirros.img

15
doc/install-guide-rst/source/ceilometer.rst
View File

@ -1,3 +1,18 @@
========================
Add the Telemetry module
========================
.. toctree::
ceilometer-controller.rst
ceilometer-nova.rst
ceilometer-glance.rst
ceilometer-cinder.rst
ceilometer-swift.rst
ceilometer-verify.rst
ceilometer-next-steps.rst
.. TODO(katomo): add toctree getstart_telemetry after creation.
Telemetry provides a framework for monitoring and metering the
OpenStack cloud. It is also known as the ceilometer project.