diff --git a/doc/install-guide-rst/source/ceilometer-cinder.rst b/doc/install-guide-rst/source/ceilometer-cinder.rst new file mode 100644 index 0000000000..89cc3d8c44 --- /dev/null +++ b/doc/install-guide-rst/source/ceilometer-cinder.rst @@ -0,0 +1,3 @@ +=================================== +Configure the Block Storage service +=================================== diff --git a/doc/install-guide-rst/source/ceilometer-controller.rst b/doc/install-guide-rst/source/ceilometer-controller.rst new file mode 100644 index 0000000000..dc98ce79aa --- /dev/null +++ b/doc/install-guide-rst/source/ceilometer-controller.rst @@ -0,0 +1,3 @@ +===================================== +Install and configure controller node +===================================== diff --git a/doc/install-guide-rst/source/ceilometer-glance.rst b/doc/install-guide-rst/source/ceilometer-glance.rst new file mode 100644 index 0000000000..91e5288235 --- /dev/null +++ b/doc/install-guide-rst/source/ceilometer-glance.rst @@ -0,0 +1,3 @@ +=========================== +Configure the Image service +=========================== diff --git a/doc/install-guide-rst/source/ceilometer-next-steps.rst b/doc/install-guide-rst/source/ceilometer-next-steps.rst new file mode 100644 index 0000000000..a33ebbd9b3 --- /dev/null +++ b/doc/install-guide-rst/source/ceilometer-next-steps.rst @@ -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 diff --git a/doc/install-guide-rst/source/ceilometer-nova.rst b/doc/install-guide-rst/source/ceilometer-nova.rst new file mode 100644 index 0000000000..03036dbab8 --- /dev/null +++ b/doc/install-guide-rst/source/ceilometer-nova.rst @@ -0,0 +1,3 @@ +============================= +Configure the Compute service +============================= diff --git a/doc/install-guide-rst/source/ceilometer-swift.rst b/doc/install-guide-rst/source/ceilometer-swift.rst new file mode 100644 index 0000000000..c3c4ef0a37 --- /dev/null +++ b/doc/install-guide-rst/source/ceilometer-swift.rst @@ -0,0 +1,3 @@ +==================================== +Configure the Object Storage service +==================================== diff --git a/doc/install-guide-rst/source/ceilometer-verify.rst b/doc/install-guide-rst/source/ceilometer-verify.rst new file mode 100644 index 0000000000..87061f4058 --- /dev/null +++ b/doc/install-guide-rst/source/ceilometer-verify.rst @@ -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 diff --git a/doc/install-guide-rst/source/ceilometer.rst b/doc/install-guide-rst/source/ceilometer.rst index c981f8aa7c..ee63b9cdaf 100644 --- a/doc/install-guide-rst/source/ceilometer.rst +++ b/doc/install-guide-rst/source/ceilometer.rst @@ -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.