openstack/aodh
Code Issues Proposed changes

Fix documentation formatting issues

Browse Source 
bug #1105247

Fix a few formatting issues with literal text and tables
so the documentation will render properly.

Change-Id: If2f833931e4e6b400c91048afe7c5ead42415366
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
This commit is contained in:
Doug Hellmann 2013-01-25 16:43:30 -05:00
parent c6b09bb0b3
commit a0220bde5f
2 changed files with 35 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
doc/source/install.rst
View File

@ -15,9 +15,9 @@
.. _install: .. _install:
================================================ =======
Install Install
================================================ =======
Installing and Running the Development Version Installing and Running the Development Version
++++++++++++++++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++++++++++++++++
@ -85,18 +85,21 @@ Installing the Collector
3. In order to retrieve object store statistics, ceilometer needs 3. In order to retrieve object store statistics, ceilometer needs
access to swift with ``ResellerAdmin`` role. You should give this access to swift with ``ResellerAdmin`` role. You should give this
role to your ``os_username`` user for tenant ``os_tenant_name``:: role to your ``os_username`` user for tenant ``os_tenant_name``:
$ keystone role-create --name=ResellerAdmin ::
+----------+----------------------------------+
| Property | Value | $ keystone role-create --name=ResellerAdmin
+----------+----------------------------------+ +----------+----------------------------------+
| id | 462fa46c13fd4798a95a3bfbe27b5e54 | | Property | Value |
| name | ResellerAdmin | +----------+----------------------------------+
+----------+----------------------------------+ | id | 462fa46c13fd4798a95a3bfbe27b5e54 |
$ keystone user-role-add --tenant_id $SERVICE_TENANT \ | name | ResellerAdmin |
--user_id $CEILOMETER_USER \ +----------+----------------------------------+
--role_id 462fa46c13fd4798a95a3bfbe27b5e54
$ keystone user-role-add --tenant_id $SERVICE_TENANT \
--user_id $CEILOMETER_USER \
--role_id 462fa46c13fd4798a95a3bfbe27b5e54
You'll also need to add the Ceilometer middleware to Swift to account for You'll also need to add the Ceilometer middleware to Swift to account for
incoming and outgoing traffic, adding this lines to incoming and outgoing traffic, adding this lines to

34
doc/source/measurements.rst
View File

@ -37,11 +37,12 @@ Delta Changing over time (bandwidth)
Units should use common abbreviatons: Units should use common abbreviatons:
============ ======== ============== ===== ============ ======== ============== =====
Dimension Unit Abbreviations Note Dimension Unit Abbreviations Note
============ ======== ============== ===== ============ ======== ============== =====
None N/A Dimension-less variable None N/A Dimension-less variable
Volume byte B Volume byte B
Time seconds s Time seconds s
============ ======== ============== =====
Information units should be expressed in bits ('b') or bytes ('B'). Information units should be expressed in bits ('b') or bytes ('B').
@ -51,7 +52,7 @@ Compute (Nova)
============== ==============
======================== ========== ======== ======== ======================================================= ======================== ========== ======== ======== =======================================================
Name Type Unit Resource Note Name Type Unit Resource Note
======================== ========== ======== ======== ======================================================= ======================== ========== ======== ======== =======================================================
instance Gauge inst ID Duration of instance instance Gauge inst ID Duration of instance
instance:<type> Gauge inst ID Duration of instance <type> (openstack types) instance:<type> Gauge inst ID Duration of instance <type> (openstack types)
@ -119,9 +120,9 @@ volume.size Gauge GiB vol ID Size of volume
Object Storage (Swift) Object Storage (Swift)
====================== ======================
========================== ========== ========== ======== ============================================== ============================== ========== ========== ======== ==============================================
Name Type Volume Resource Note Name Type Volume Resource Note
========================== ========== ========== ======== ============================================== ============================== ========== ========== ======== ==============================================
storage.objects Gauge objects store ID Number of objects storage.objects Gauge objects store ID Number of objects
storage.objects.size Gauge B store ID Total size of stored objects storage.objects.size Gauge B store ID Total size of stored objects
storage.objects.containers Gauge containers store ID Number of containers storage.objects.containers Gauge containers store ID Number of containers
@ -130,26 +131,29 @@ storage.objects.outgoing.bytes Delta B store ID Number of outg
============================== ========== ========== ======== ============================================== ============================== ========== ========== ======== ==============================================
Energy (Kwapi) Energy (Kwapi)
====================== ==============
========================== ========== ========== ======== ============================================== ========================== ========== ========== ======== ==============================================
Name Type Volume Resource Note Name Type Volume Resource Note
========================== ========== ========== ======== ============================================== ========================== ========== ========== ======== ==============================================
energy Cumulative kWh probe ID Amount of energy energy Cumulative kWh probe ID Amount of energy
power Gauge W probe ID Power consumption power Gauge W probe ID Power consumption
============================== ========== ========== ======== ============================================== ========================== ========== ========== ======== ==============================================
Dynamically retrieving the Meters via ceilometer client Dynamically retrieving the Meters via ceilometer client
======================================================= =======================================================
ceilometer meter-list -s openstack
To retrieve the available meters that can be queried given the actual
resource instances available, use the ``meter-list`` command:
::
$ ceilometer meter-list -s openstack
+------------+-------+--------------------------------------+---------+----------------------------------+ +------------+-------+--------------------------------------+---------+----------------------------------+
| Name | Type | Resource ID | User ID | Project ID | | Name | Type | Resource ID | User ID | Project ID |
+------------+-------+--------------------------------------+---------+----------------------------------+ +------------+-------+--------------------------------------+---------+----------------------------------+
| image | gauge | 09e84d97-8712-4dd2-bcce-45970b2430f7 | | 57cf6d93688e4d39bf2fe3d3c03eb326 | | image | gauge | 09e84d97-8712-4dd2-bcce-45970b2430f7 | | 57cf6d93688e4d39bf2fe3d3c03eb326 |
The above command will retrieve the available meters that can be queried on
given the actual resource instances available.
Naming convention Naming convention
================= =================