add configuration instructions from admin guide and dev docs
- move cinder and keystone configuration instructions from admin guide to install guide so we have all meter enabling steps in same place. - move heat and neutron config to install guide. Change-Id: Ibc8096e3fb6c95886c3bddafb927600fe506415d
This commit is contained in:
gord chung
parent
3eb256abff
commit
9105e194c7
@ -243,84 +243,7 @@ Installing the API Server
|
||||
Enabling Service Notifications
|
||||
==============================
|
||||
|
||||
Cinder
|
||||
------
|
||||
See the `install guide`_ for instructions on how to enable meters for specific
|
||||
OpenStack services.
|
||||
|
||||
Edit ``cinder.conf`` to include::
|
||||
|
||||
[oslo_messaging_notifications]
|
||||
driver = messagingv2
|
||||
|
||||
Glance
|
||||
------
|
||||
|
||||
Edit ``glance.conf`` to include::
|
||||
|
||||
[oslo_messaging_notifications]
|
||||
driver = messagingv2
|
||||
|
||||
Heat
|
||||
----
|
||||
|
||||
Configure the driver in ``heat.conf``::
|
||||
|
||||
[oslo_messaging_notifications]
|
||||
driver=messagingv2
|
||||
|
||||
Neutron
|
||||
------
|
||||
|
||||
Edit ``neutron.conf`` to include::
|
||||
|
||||
[oslo_messaging_notifications]
|
||||
driver = messagingv2
|
||||
|
||||
Nova
|
||||
----
|
||||
|
||||
Edit ``nova.conf`` to include::
|
||||
|
||||
[DEFAULT]
|
||||
instance_usage_audit=True
|
||||
instance_usage_audit_period=hour
|
||||
notify_on_state_change=vm_and_task_state
|
||||
|
||||
[oslo_messaging_notifications]
|
||||
driver=messagingv2
|
||||
|
||||
|
||||
Sahara
|
||||
------
|
||||
|
||||
Configure the driver in ``sahara.conf``::
|
||||
|
||||
[DEFAULT]
|
||||
enable_notifications=true
|
||||
|
||||
[oslo_messaging_notifications]
|
||||
driver=messagingv2
|
||||
|
||||
|
||||
Swift
|
||||
-----
|
||||
|
||||
Edit ``proxy-server.conf`` to include::
|
||||
|
||||
[filter:ceilometer]
|
||||
topic = notifications
|
||||
driver = messaging
|
||||
url = rabbit://stackrabbit:openstack1@10.0.2.15:5672/
|
||||
control_exchange = swift
|
||||
paste.filter_factory = ceilometermiddleware.swift:filter_factory
|
||||
set log_level = WARN
|
||||
|
||||
and edit [pipeline:main] to include the ceilometer middleware before the application::
|
||||
|
||||
[pipeline:main]
|
||||
pipeline = catch_errors ... ... ceilometer proxy-server
|
||||
|
||||
|
||||
Also, you need to configure messaging related options correctly as written above
|
||||
for other parts of installation guide. Refer to :doc:`/configuration` for
|
||||
details about any other options you might want to modify before starting the
|
||||
service.
|
||||
.. _`install guide`: https://docs.openstack.org/project-install-guide/telemetry/draft/install-controller.html
|
||||
|
||||
16
install-guide/source/cinder/install-cinder-config-common.inc
Normal file
16
install-guide/source/cinder/install-cinder-config-common.inc
Normal file
@ -0,0 +1,16 @@
|
||||
* Enable periodic usage statistics relating to block storage. To use it, you
|
||||
must run this command in the following format:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ cinder-volume-usage-audit --start_time='YYYY-MM-DD HH:MM:SS' \
|
||||
--end_time='YYYY-MM-DD HH:MM:SS' --send_actions
|
||||
|
||||
This script outputs what volumes or snapshots were created, deleted, or
|
||||
exists in a given period of time and some information about these
|
||||
volumes or snapshots.
|
||||
|
||||
Using this script via cron you can get notifications periodically, for
|
||||
example, every 5 minutes::
|
||||
|
||||
*/5 * * * * /path/to/cinder-volume-usage-audit --send_actions
|
||||
@ -22,6 +22,8 @@ following actions:
|
||||
...
|
||||
driver = messagingv2
|
||||
|
||||
.. include:: install-cinder-config-common.inc
|
||||
|
||||
Finalize installation
|
||||
---------------------
|
||||
|
||||
@ -36,9 +38,3 @@ Finalize installation
|
||||
.. code-block:: console
|
||||
|
||||
# systemctl restart openstack-cinder-volume.service
|
||||
|
||||
#. Use the ``cinder-volume-usage-audit`` command on Block Storage nodes
|
||||
to retrieve meters on demand. For more information, see the
|
||||
`OpenStack Administrator Guide <http://docs.openstack.org/admin-guide/
|
||||
telemetry-data-collection.html#block-storage-audit-script-setup-to-get-
|
||||
notifications>`__.
|
||||
|
||||
@ -22,6 +22,8 @@ following actions:
|
||||
...
|
||||
driver = messagingv2
|
||||
|
||||
.. include:: install-cinder-config-common.inc
|
||||
|
||||
Finalize installation
|
||||
---------------------
|
||||
|
||||
@ -36,9 +38,3 @@ Finalize installation
|
||||
.. code-block:: console
|
||||
|
||||
# systemctl restart openstack-cinder-volume.service
|
||||
|
||||
#. Use the ``cinder-volume-usage-audit`` command on Block Storage nodes
|
||||
to retrieve meters on demand. For more information, see the
|
||||
`OpenStack Administrator Guide <http://docs.openstack.org/admin-guide/
|
||||
telemetry-data-collection.html#block-storage-audit-script-setup-to-get-
|
||||
notifications>`__.
|
||||
|
||||
@ -22,6 +22,8 @@ following actions:
|
||||
...
|
||||
driver = messagingv2
|
||||
|
||||
.. include:: install-cinder-config-common.inc
|
||||
|
||||
Finalize installation
|
||||
---------------------
|
||||
|
||||
@ -37,9 +39,3 @@ Finalize installation
|
||||
.. code-block:: console
|
||||
|
||||
# service cinder-volume restart
|
||||
|
||||
#. Use the ``cinder-volume-usage-audit`` command on Block Storage nodes
|
||||
to retrieve meters on demand. For more information, see the
|
||||
`OpenStack Administrator Guide <http://docs.openstack.org/admin-guide/
|
||||
telemetry-data-collection.html#block-storage-audit-script-setup-to-get-
|
||||
notifications>`__.
|
||||
|
||||
28
install-guide/source/heat/install-heat-obs.rst
Normal file
28
install-guide/source/heat/install-heat-obs.rst
Normal file
@ -0,0 +1,28 @@
|
||||
Enable Orchestration service meters for openSUSE and SUSE Linux Enterprise
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Telemetry uses notifications to collect Orchestration service meters. Perform
|
||||
these steps on the controller node.
|
||||
|
||||
Configure the Orchestration service to use Telemetry
|
||||
----------------------------------------------------
|
||||
|
||||
* Edit the ``/etc/heat/heat.conf`` and complete the following actions:
|
||||
|
||||
* In the ``[oslo_messaging_notifications]`` sections, enable notifications:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
[oslo_messaging_notifications]
|
||||
...
|
||||
driver = messagingv2
|
||||
|
||||
Finalize installation
|
||||
---------------------
|
||||
|
||||
* Restart the Orchestration service:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# systemctl restart openstack-heat-api.service \
|
||||
openstack-heat-api-cfn.service openstack-heat-engine.service
|
||||
28
install-guide/source/heat/install-heat-rdo.rst
Normal file
28
install-guide/source/heat/install-heat-rdo.rst
Normal file
@ -0,0 +1,28 @@
|
||||
Enable Orchestration service meters for Red Hat Enterprise Linux and CentOS
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Telemetry uses notifications to collect Orchestration service meters. Perform
|
||||
these steps on the controller node.
|
||||
|
||||
Configure the Orchestration service to use Telemetry
|
||||
----------------------------------------------------
|
||||
|
||||
* Edit the ``/etc/heat/heat.conf`` and complete the following actions:
|
||||
|
||||
* In the ``[oslo_messaging_notifications]`` sections, enable notifications:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
[oslo_messaging_notifications]
|
||||
...
|
||||
driver = messagingv2
|
||||
|
||||
Finalize installation
|
||||
---------------------
|
||||
|
||||
* Restart the Orchestration service:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# systemctl restart openstack-heat-api.service \
|
||||
openstack-heat-api-cfn.service openstack-heat-engine.service
|
||||
29
install-guide/source/heat/install-heat-ubuntu.rst
Normal file
29
install-guide/source/heat/install-heat-ubuntu.rst
Normal file
@ -0,0 +1,29 @@
|
||||
Enable Orchestration service meters for Ubuntu
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Telemetry uses notifications to collect Orchestration service meters. Perform
|
||||
these steps on the controller node.
|
||||
|
||||
Configure the Orchestration service to use Telemetry
|
||||
----------------------------------------------------
|
||||
|
||||
* Edit the ``/etc/heat/heat.conf`` and complete the following actions:
|
||||
|
||||
* In the ``[oslo_messaging_notifications]`` sections, enable notifications:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
[oslo_messaging_notifications]
|
||||
...
|
||||
driver = messagingv2
|
||||
|
||||
Finalize installation
|
||||
---------------------
|
||||
|
||||
* Restart the Orchestration service:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# service heat-api restart
|
||||
# service heat-api-cfn restart
|
||||
# service heat-engine restart
|
||||
@ -42,6 +42,35 @@ Glance
|
||||
glance/install-glance-rdo.rst
|
||||
glance/install-glance-ubuntu.rst
|
||||
|
||||
Heat
|
||||
----
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
heat/install-heat-obs.rst
|
||||
heat/install-heat-rdo.rst
|
||||
heat/install-heat-ubuntu.rst
|
||||
|
||||
Keystone
|
||||
--------
|
||||
|
||||
To enable auditing of API requests, Keystone provides middleware which captures
|
||||
API requests to a service and emits data to Ceilometer. Instructions to enable
|
||||
this functionality is available in `Keystone's developer documenation
|
||||
<https://docs.openstack.org/developer/keystonemiddleware/audit.html>`_.
|
||||
Ceilometer will captures this information as ``audit.http.*`` events.
|
||||
|
||||
Neutron
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
neutron/install-neutron-obs.rst
|
||||
neutron/install-neutron-rdo.rst
|
||||
neutron/install-neutron-ubuntu.rst
|
||||
|
||||
Swift
|
||||
-----
|
||||
|
||||
|
||||
27
install-guide/source/neutron/install-neutron-obs.rst
Normal file
27
install-guide/source/neutron/install-neutron-obs.rst
Normal file
@ -0,0 +1,27 @@
|
||||
Enable Networking service meters for openSUSE and SUSE Linux Enterprise
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Telemetry uses notifications to collect Networking service meters. Perform
|
||||
these steps on the controller node.
|
||||
|
||||
Configure the Networking service to use Telemetry
|
||||
----------------------------------------------------
|
||||
|
||||
* Edit the ``/etc/neutron/neutron.conf`` and complete the following actions:
|
||||
|
||||
* In the ``[oslo_messaging_notifications]`` sections, enable notifications:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
[oslo_messaging_notifications]
|
||||
...
|
||||
driver = messagingv2
|
||||
|
||||
Finalize installation
|
||||
---------------------
|
||||
|
||||
* Restart the Networking service:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# systemctl restart neutron-server.service
|
||||
27
install-guide/source/neutron/install-neutron-rdo.rst
Normal file
27
install-guide/source/neutron/install-neutron-rdo.rst
Normal file
@ -0,0 +1,27 @@
|
||||
Enable Networking service meters for Red Hat Enterprise Linux and CentOS
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Telemetry uses notifications to collect Networking service meters. Perform
|
||||
these steps on the controller node.
|
||||
|
||||
Configure the Networking service to use Telemetry
|
||||
----------------------------------------------------
|
||||
|
||||
* Edit the ``/etc/neutron/neutron.conf`` and complete the following actions:
|
||||
|
||||
* In the ``[oslo_messaging_notifications]`` sections, enable notifications:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
[oslo_messaging_notifications]
|
||||
...
|
||||
driver = messagingv2
|
||||
|
||||
Finalize installation
|
||||
---------------------
|
||||
|
||||
* Restart the Networking service:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# systemctl restart neutron-server.service
|
||||
27
install-guide/source/neutron/install-neutron-ubuntu.rst
Normal file
27
install-guide/source/neutron/install-neutron-ubuntu.rst
Normal file
@ -0,0 +1,27 @@
|
||||
Enable Networking service meters for Ubuntu
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Telemetry uses notifications to collect Networking service meters. Perform
|
||||
these steps on the controller node.
|
||||
|
||||
Configure the Networking service to use Telemetry
|
||||
----------------------------------------------------
|
||||
|
||||
* Edit the ``/etc/neutron/neutron.conf`` and complete the following actions:
|
||||
|
||||
* In the ``[oslo_messaging_notifications]`` sections, enable notifications:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
[oslo_messaging_notifications]
|
||||
...
|
||||
driver = messagingv2
|
||||
|
||||
Finalize installation
|
||||
---------------------
|
||||
|
||||
* Restart the Networking service:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# service neutron-server restart
|
||||
@ -21,7 +21,7 @@ run the Object Storage proxy service.
|
||||
.. code-block:: ini
|
||||
|
||||
[pipeline:main]
|
||||
pipeline = ceilometer catch_errors gatekeeper healthcheck proxy-logging cache container_sync bulk ratelimit authtoken keystoneauth container-quotas account-quotas slo dlo versioned_writes proxy-logging proxy-server
|
||||
pipeline = catch_errors gatekeeper healthcheck proxy-logging cache container_sync bulk ratelimit authtoken keystoneauth container-quotas account-quotas slo dlo versioned_writes proxy-logging ceilometer proxy-server
|
||||
|
||||
* In the ``[filter:ceilometer]`` section, configure notifications:
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user