openstack/openstack-manuals
Code Issues Proposed changes

Install guide: rework the ceilometer section

Browse Source 
* misc editing details (spacing, formatting, capitalization, replaceable
  data)
* give configuration file examples where possible
* reduce the delta between distributions to make things more easily
  maintainable (and possibly clearer)

Change-Id: I2a8b3df1d26cb052c3ed71dc706f1243d1f0391f
backport: havana
This commit is contained in:
Gauvain Pocentek
2013-11-18 17:58:04 +01:00
parent 3ad5da001f
commit 98828402cc
6 changed files with 41 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/common/section_getstart_metering.xml
View File

@@ -60,7 +60,7 @@
</listitem>
<listitem>
<para>An alarm notifier (<systemitem class="service"
>ceilometer-alarm-notifier</systemitem>). runs on one or more
>ceilometer-alarm-notifier</systemitem>). Runs on one or more
central management servers to allow settting alarms based on
threshold evaluation for a collection of samples.
</para>

17
doc/install-guide/section_ceilometer-cinder.xml
View File

@@ -8,8 +8,8 @@
service</title>
<procedure>
<step>
<para>To retrieve volume samples, you must configure Block
Storage to send notifications to the bus.</para>
<para>To retrieve volume samples, you must configure the Block
Storage Service to send notifications to the bus.</para>
<para os="debian;ubuntu">Edit <filename>/etc/cinder/cinder.conf</filename>
and add in the <literal>[DEFAULT]</literal> section:</para>
@@ -19,19 +19,14 @@ notification_driver = cinder.openstack.common.notifier.rpc_notifier</programlist
<para os="opensuse;sles;fedora;rhel;centos">Run the following commands:</para>
<screen os="opensuse;sles;fedora;rhel;centos"><prompt>#</prompt> <userinput>openstack-config --set /etc/cinder/cinder.conf DEFAULT control_exchange cinder</userinput>
<prompt>#</prompt> <userinput>openstack-config --set /etc/cinder/cinder.conf DEFAULT notification_driver cinder.openstack.common.notifier.rpc_notifier</userinput></screen>
</step>
<step os="ubuntu;debian">
<para>Restart the Block Storage Service with its new
<step>
<para>Restart the Block Storage services with their new
settings:</para>
<screen><prompt>#</prompt> <userinput>service cinder-volume restart</userinput>
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>service cinder-volume restart</userinput>
<prompt>#</prompt> <userinput>service cinder-api restart</userinput></screen>
</step>
<step os="rhel;fedora;centos;opensuse;sles">
<para>Restart the Block Storage Service with its new
settings:</para>
<screen os="rhel;fedora;centos;sles;opensuse"><prompt>#</prompt> <userinput>service openstack-cinder-api restart</userinput>
<screen os="rhel;fedora;centos;sles;opensuse"><prompt>#</prompt> <userinput>service openstack-cinder-api restart</userinput>
<prompt>#</prompt> <userinput>service openstack-cinder-agent-central restart</userinput></screen>
</step>
</procedure>

13
doc/install-guide/section_ceilometer-glance.xml
View File

@@ -24,17 +24,12 @@ rabbit_password = <replaceable>RABBIT_PASS</replaceable></programlisting>
<screen os="fedora;rhel;centos"><prompt>#</prompt> <userinput>openstack-config --set /etc/ceilometer/ceilometer.conf DEFAULT notifier_strategy qpid</userinput></screen>
</step>
<step os="ubuntu;debian">
<para>Restart the Image Service with its new
<step>
<para>Restart the Image services with their new
settings:</para>
<screen><prompt>#</prompt> <userinput>service glance-registry restart</userinput>
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>service glance-registry restart</userinput>
<prompt>#</prompt> <userinput>service glance-api restart</userinput></screen>
</step>
<step os="rhel;fedora;centos;opensuse;sles"><para>Restart the <systemitem
class="service">glance-api</systemitem> and <systemitem
class="service">glance-registry</systemitem> services.</para>
<screen os="rhel;fedora;centos;opensuse;sles"><prompt>#</prompt> <userinput>service openstack-glance-api restart</userinput>
<screen os="rhel;fedora;centos;opensuse;sles"><prompt>#</prompt> <userinput>service openstack-glance-api restart</userinput>
<prompt>#</prompt> <userinput>service openstack-glance-registry restart</userinput></screen>
</step>
</procedure>

34
doc/install-guide/section_ceilometer-install.xml
View File

@@ -3,15 +3,15 @@
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">
<title>Install the Metering service</title>
<title>Install the Metering Service</title>
<procedure>
<para>The Metering service is an API service that provides a
<para>The Metering Service is 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 components on the
controller node.</para>
<step>
<para>Install the Metering service on the controller
<para>Install the Metering Service on the controller
node:</para>
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>apt-get install ceilometer-api ceilometer-collector ceilometer-agent-central python-ceilometerclient</userinput></screen>
<screen os="rhel;centos;fedora"><prompt>#</prompt> <userinput>yum install openstack-ceilometer-api openstack-ceilometer-collector openstack-ceilometer-central python-ceilometerclient</userinput></screen>
@@ -26,10 +26,10 @@
registration.</para>
</step>
<step>
<para>The Metering service uses a database to store information.
<para>The Metering Service uses a database to store information.
Specify the location of the database in the configuration
file. The examples use a MongoDB database on the controller
node.</para>
node:</para>
<screen os="rhel;centos;fedora"><prompt>#</prompt> <userinput>yum install mongodb-server mongodb</userinput></screen>
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>zypper install mongodb</userinput></screen>
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>apt-get install mongodb</userinput></screen>
@@ -65,7 +65,7 @@
} )</userinput></screen>
</step>
<step>
<para>Configure the Metering service to use the database:</para>
<para>Configure the Metering Service to use the database:</para>
<screen os="rhel;centos;fedora;opensuse;sles"><prompt>#</prompt> <userinput>openstack-config --set /etc/ceilometer/ceilometer.conf \
database connection mongodb://ceilometer:<replaceable>CEILOMETER_DBPASS</replaceable>@<replaceable>controller</replaceable>:27017/ceilometer</userinput></screen>
<para os="ubuntu;debian">Edit the
@@ -82,7 +82,7 @@ connection = mongodb://ceilometer:<replaceable>CEILOMETER_DBPASS</replaceable>@<
</step>
<step>
<para>You must define an secret key that is used as a shared
secret among Metering service nodes. Use
secret among Metering Service nodes. Use
<command>openssl</command> to generate a random token and
store it in the configuration file:</para>
<screen os="rhel;centos;fedora;opensuse;sles"><prompt>#</prompt> <userinput>ADMIN_TOKEN=$(openssl rand -hex 10)</userinput>
@@ -96,7 +96,7 @@ connection = mongodb://ceilometer:<replaceable>CEILOMETER_DBPASS</replaceable>@<
<filename>/etc/ceilometer/ceilometer.conf</filename> file
and change the <literal>[publisher_rpc]</literal> section. Replace
<replaceable>ADMIN_TOKEN</replaceable> with the results of
the command:</para>
the <literal>openssl</literal> command:</para>
<programlisting os="ubuntu;debian" language="ini">...
[publisher_rpc]
...
@@ -106,17 +106,17 @@ metering_secret = <replaceable>ADMIN_TOKEN</replaceable>
</step>
<step os="opensuse;sles;ubuntu">
<para>Configure the RabbitMQ access.</para>
<para>Configure the RabbitMQ access:</para>
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>openstack-config --set /etc/ceilometer/ceilometer.conf DEFAULT rabbit_host controller</userinput>
<prompt>#</prompt> <userinput>openstack-config --set /etc/ceilometer/ceilometer.conf DEFAULT rabbit_password <replaceable>RABBIT_PASS</replaceable></userinput></screen>
<para os="ubuntu">Edit the <filename>/etc/ceilometer/ceilometer.conf</filename> file and update the <literal>[DEFAULT]</literal>section.</para>
<para os="ubuntu">Edit the <filename>/etc/ceilometer/ceilometer.conf</filename> file and update the <literal>[DEFAULT]</literal> section.</para>
<programlisting os="ubuntu" language="ini">rabbit_host = <replaceable>controller</replaceable>
rabbit_password = <replaceable>RABBIT_PASS</replaceable></programlisting>
</step>
<step os="rhel;centos;fedora;opensuse;sles;ubuntu">
<para>Create a <literal>ceilometer</literal> user that the
Metering service uses to authenticate with the Identity
Metering Service uses to authenticate with the Identity
Service. Use the <literal>service</literal> tenant and give
the user the <literal>admin</literal> role:</para>
<screen><prompt>#</prompt> <userinput>keystone user-create --name=ceilometer --pass=<replaceable>CEILOMETER_PASS</replaceable> --email=<replaceable>ceilometer@example.com</replaceable></userinput>
@@ -124,7 +124,7 @@ rabbit_password = <replaceable>RABBIT_PASS</replaceable></programlisting>
</step>
<step>
<para>Add the credentials to the configuration files for the
Metering service:</para>
Metering Service:</para>
<screen os="centos;rhel;fedora;opensuse;sles"><prompt>#</prompt> <userinput>openstack-config --set /etc/ceilometer/ceilometer.conf keystone_authtoken auth_host <replaceable>controller</replaceable></userinput>
<prompt>#</prompt> <userinput>openstack-config --set /etc/ceilometer/ceilometer.conf keystone_authtoken admin_user ceilometer</userinput>
<prompt>#</prompt> <userinput>openstack-config --set /etc/ceilometer/ceilometer.conf keystone_authtoken admin_tenant_name service</userinput>
@@ -134,18 +134,16 @@ rabbit_password = <replaceable>RABBIT_PASS</replaceable></programlisting>
<filename>/etc/ceilometer/ceilometer.conf</filename> file
and change the <literal>[keystone_authtoken]</literal>
section:</para>
<programlisting os="ubuntu;debian" language="ini">...
[keystone_authtoken]
<programlisting os="ubuntu;debian" language="ini">[keystone_authtoken]
auth_host = controller
auth_port = 35357
auth_protocol = http
admin_tenant_name = service
admin_user = ceilometer
admin_password = CEILOMETER_PASS
...</programlisting>
admin_password = <replaceable>CEILOMETER_PASS</replaceable></programlisting>
</step>
<step os="rhel;centos;fedora;opensuse;sles;ubuntu">
<para>Register the Metering service with the Identity Service so
<para>Register the Metering Service with the Identity Service so
that other OpenStack services can locate it. Use the
<command>keystone</command> command to register the service
and specify the endpoint:</para>
@@ -162,7 +160,7 @@ admin_password = CEILOMETER_PASS
--adminurl=http://<replaceable>controller</replaceable>:8777/</userinput></screen>
</step>
<step os="ubuntu;debian">
<para>Restart the service with its new settings:</para>
<para>Restart the services with their new settings:</para>
<screen><prompt>#</prompt> <userinput>service ceilometer-agent-central restart</userinput>
<prompt>#</prompt> <userinput>service ceilometer-api restart</userinput>
<prompt>#</prompt> <userinput>service ceilometer-collector restart</userinput></screen>

17
doc/install-guide/section_ceilometer-nova.xml
View File

@@ -16,7 +16,7 @@
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>zypper install openstack-ceilometer-agent-compute</userinput></screen>
</step>
<step>
<para>Set the following options in the
<para os="fedora;rhel;centos;opensuse;sles">Set the following options in the
<filename>/etc/nova/nova.conf</filename> file:</para>
<screen os="fedora;rhel;centos;opensuse;sles">
<prompt>#</prompt> <userinput>openstack-config --set /etc/nova/nova.conf DEFAULT instance_usage_audit True</userinput>
@@ -58,18 +58,11 @@ metering_secret = ADMIN_TOKEN
<para>Restart the service with its new settings:</para>
<screen><prompt>#</prompt> <userinput>service ceilometer-agent-compute restart</userinput></screen>
</step>
<step os="opensuse;sles">
<para>Start the <systemitem class="service"
>ceilometer-agent-compute</systemitem> service and configure
it to start when the system boots:</para>
<screen><prompt>#</prompt> <userinput>service openstack-ceilometer-agent-compute start</userinput>
<step os="rhel;fedora;centos;opensuse;sles">
<para>Start the service and configure it to start when the system boots:</para>
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>service openstack-ceilometer-agent-compute start</userinput>
<prompt>#</prompt> <userinput>chkconfig openstack-ceilometer-agent-compute on</userinput></screen>
</step>
<step os="rhel;fedora;centos">
<para>Start the <systemitem class="service"
>openstack-ceilometer-compute</systemitem> service and
configure to start when the system boots:</para>
<screen><prompt>#</prompt> <userinput>service openstack-ceilometer-compute start</userinput>
<screen os="rhel;fedora;centos"><prompt>#</prompt> <userinput>service openstack-ceilometer-compute start</userinput>
<prompt>#</prompt> <userinput>chkconfig openstack-ceilometer-compute on</userinput></screen>
</step>
</procedure>

21
doc/install-guide/section_ceilometer-swift.xml
View File

@@ -10,7 +10,7 @@
needs access to Object Storage with the
<literal>ResellerAdmin</literal> role. Give this role to
your <literal>os_username</literal> user for the
<literal>os_tenant_name</literal>tenant:</para>
<literal>os_tenant_name</literal> tenant:</para>
<screen><prompt>$</prompt> <userinput>keystone role-create --name=ResellerAdmin</userinput>
<computeroutput>+----------+----------------------------------+
| Property | Value |
@@ -19,9 +19,8 @@
| name | ResellerAdmin |
+----------+----------------------------------+
</computeroutput></screen>
<screen><prompt>$</prompt> <userinput>keystone user-role-add --tenant_id $SERVICE_TENANT \
--user_id $CEILOMETER_USER \
--role_id 462fa46c13fd4798a95a3bfbe27b5e54</userinput></screen>
<screen><prompt>$</prompt> <userinput>keystone user-role-add --tenant service --user ceilometer \
--role <replaceable>462fa46c13fd4798a95a3bfbe27b5e54</replaceable></userinput></screen>
</step>
<step>
<para>You must also add the Metering middleware to Object
@@ -34,15 +33,13 @@ use = egg:ceilometer#swift</programlisting>
</step>
<step>
<para>Add <literal>ceilometer</literal> to the
<literal>pipeline</literal> parameter of that same file,
right before the entry <literal>proxy-server</literal>.</para>
<literal>pipeline</literal> parameter of that same file:</para>
<programlisting language="ini">[pipeline:main]
pipeline = healthcheck cache authtoken keystoneauth ceilometer proxy-server</programlisting>
</step>
<step os="ubuntu;debian">
<para>Restart the service with its new settings.</para>
<screen><prompt>#</prompt> <userinput>service swift-proxy-server restart</userinput></screen>
</step>
<step os="rhel;fedora;centos;opensuse;sles">
<para>Restart the service with its new settings.</para>
<step>
<para>Restart the service with its new settings:</para>
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>service swift-proxy-server restart</userinput></screen>
<screen os="rhel;fedora;centos;sles;opensuse"><prompt>#</prompt> <userinput>service openstack-swift-proxy-server restart</userinput></screen>
</step>
</procedure>