Improve the Installation Guide: Compute agent for Telemetry section
1. Restructured content 2. Removed openstack-config commands 3. Replaced auth_host, auth_port and auth_protocol keys with identity_uri and auth_uri keys Partial-bug: 1301034 Change-Id: Ifdc6068b5042811df3cb008b7e0a8f9c7ba4c51e Implements: blueprint installation-guide-improvements
This commit is contained in:
darrenchan
Anne Gentle
parent
58e21a3eea
commit
0d0a597555
@ -6,131 +6,106 @@
|
||||
xml:id="ceilometer-agent-nova">
|
||||
<?dbhtml stop-chunking?>
|
||||
<title>Install the Compute agent for Telemetry</title>
|
||||
<para>Telemetry is composed of an API service, a collector and a range
|
||||
of disparate agents. This section explains how to install and configure
|
||||
the agent that runs on the compute node.</para>
|
||||
<procedure>
|
||||
<para>Telemetry is composed of an API service, a collector and a range
|
||||
of disparate agents. This procedure details how to install the
|
||||
agent that runs on the compute node.</para>
|
||||
<title>To configure prerequisites</title>
|
||||
<step>
|
||||
<para>Install the Telemetry service on the compute node:</para>
|
||||
<para>Install the package:</para>
|
||||
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>apt-get install ceilometer-agent-compute</userinput></screen>
|
||||
<screen os="rhel;centos;fedora"><prompt>#</prompt> <userinput>yum install openstack-ceilometer-compute python-ceilometerclient python-pecan</userinput></screen>
|
||||
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>zypper install openstack-ceilometer-agent-compute</userinput></screen>
|
||||
</step>
|
||||
<step>
|
||||
<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>
|
||||
<prompt>#</prompt> <userinput>openstack-config --set /etc/nova/nova.conf DEFAULT \
|
||||
instance_usage_audit_period hour</userinput>
|
||||
<prompt>#</prompt> <userinput>openstack-config --set /etc/nova/nova.conf DEFAULT \
|
||||
notify_on_state_change vm_and_task_state</userinput></screen>
|
||||
<note os="fedora;rhel;centos;opensuse;sles">
|
||||
<para>The <option>notification_driver</option> option is a multi
|
||||
valued option, which
|
||||
<application>openstack-config</application> cannot set
|
||||
properly. See <xref linkend="basics-packages"/>.
|
||||
</para>
|
||||
</note>
|
||||
<para>Edit the
|
||||
<filename>/etc/nova/nova.conf</filename> file and add the
|
||||
following lines to the <literal>[DEFAULT]</literal>
|
||||
<para>Edit the <filename>/etc/nova/nova.conf</filename> file and
|
||||
add the following lines to the <literal>[DEFAULT]</literal>
|
||||
section:</para>
|
||||
<programlisting os="ubuntu;debian" language="ini">[DEFAULT]
|
||||
<programlisting language="ini">[DEFAULT]
|
||||
...
|
||||
instance_usage_audit = True
|
||||
instance_usage_audit_period = hour
|
||||
notify_on_state_change = vm_and_task_state
|
||||
notification_driver = nova.openstack.common.notifier.rpc_notifier
|
||||
notification_driver = ceilometer.compute.nova_notifier</programlisting>
|
||||
<programlisting os = "fedora;rhel;centos;opensuse;sles" language="ini">[DEFAULT]
|
||||
<programlisting os ="fedora;rhel;centos;opensuse;sles" language="ini">[DEFAULT]
|
||||
...
|
||||
notification_driver = nova.openstack.common.notifier.rpc_notifier
|
||||
notification_driver = ceilometer.compute.nova_notifier</programlisting>
|
||||
<note os="fedora;rhel;centos;opensuse;sles">
|
||||
<para>The <option>notification_driver</option> option is a multi
|
||||
valued option, which <application>openstack-config</application>
|
||||
cannot set properly. See <xref linkend="basics-packages"/>.
|
||||
</para>
|
||||
</note>
|
||||
</step>
|
||||
<step>
|
||||
<para>Restart the Compute service:</para>
|
||||
<screen os="fedora;rhel;centos;opensuse;sles"><prompt>#</prompt> <userinput>service openstack-nova-compute restart</userinput></screen>
|
||||
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>service nova-compute restart</userinput></screen>
|
||||
</step>
|
||||
</procedure>
|
||||
<procedure>
|
||||
<title>To configure the Compute agent for Telemetry</title>
|
||||
<para>Edit the <filename>/etc/ceilometer/ceilometer.conf</filename>
|
||||
file and complete the following actions:</para>
|
||||
<step>
|
||||
<para>You must set the secret key that you defined previously.
|
||||
The Telemetry service nodes share this key as a shared
|
||||
secret:</para>
|
||||
<screen os="fedora;rhel;centos;opensuse;sles"><prompt>#</prompt> <userinput>openstack-config --set /etc/ceilometer/ceilometer.conf publisher \
|
||||
metering_secret <replaceable>CEILOMETER_TOKEN</replaceable></userinput></screen>
|
||||
<para os="ubuntu;debian">Edit the
|
||||
<filename>/etc/ceilometer/ceilometer.conf</filename> file
|
||||
and change these lines in the <literal>[publisher]</literal>
|
||||
section. Replace <replaceable>CEILOMETER_TOKEN</replaceable> with
|
||||
the ceilometer token that you created previously:</para>
|
||||
<programlisting os="ubuntu;debian" language="ini">[publisher]
|
||||
<para>In the <literal>[publisher]</literal> section, set the
|
||||
secret key for Telemetry service nodes:</para>
|
||||
<programlisting language="ini">[publisher]
|
||||
# Secret value for signing metering messages (string value)
|
||||
metering_secret = <replaceable>CEILOMETER_TOKEN</replaceable></programlisting>
|
||||
<para>Replace <replaceable>CEILOMETER_TOKEN</replaceable> with
|
||||
the ceilometer token that you created previously.</para>
|
||||
</step>
|
||||
|
||||
<step os="opensuse;sles;ubuntu;rhel;centos;fedora">
|
||||
<para>Configure the RabbitMQ access:</para>
|
||||
<screen os="opensuse;sles;rhel;centos;fedora"><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>
|
||||
<programlisting os="ubuntu" language="ini">[DEFAULT]
|
||||
<step os="centos;fedora;opensuse;rhel;sles;ubuntu">
|
||||
<para>In the <literal>[DEFAULT]</literal> section, configure
|
||||
RabbitMQ broker access:</para>
|
||||
<programlisting language="ini">[DEFAULT]
|
||||
rabbit_host = <replaceable>controller</replaceable>
|
||||
rabbit_password = <replaceable>RABBIT_PASS</replaceable></programlisting>
|
||||
<para>Replace <replaceable>RABBIT_PASS</replaceable> with the password
|
||||
you chose for the guest account in RabbitMQ.</para>
|
||||
</step>
|
||||
|
||||
<step>
|
||||
<para>Add the Identity service credentials:</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>
|
||||
<prompt>#</prompt> <userinput>openstack-config --set /etc/ceilometer/ceilometer.conf \
|
||||
keystone_authtoken auth_protocol http</userinput>
|
||||
<prompt>#</prompt> <userinput>openstack-config --set /etc/ceilometer/ceilometer.conf \
|
||||
keystone_authtoken admin_password <replaceable>CEILOMETER_PASS</replaceable></userinput>
|
||||
<prompt>#</prompt> <userinput>openstack-config --set /etc/ceilometer/ceilometer.conf \
|
||||
service_credentials os_username ceilometer</userinput>
|
||||
<prompt>#</prompt> <userinput>openstack-config --set /etc/ceilometer/ceilometer.conf \
|
||||
service_credentials os_tenant_name service</userinput>
|
||||
<prompt>#</prompt> <userinput>openstack-config --set /etc/ceilometer/ceilometer.conf \
|
||||
service_credentials os_password <replaceable>CEILOMETER_PASS</replaceable></userinput>
|
||||
<prompt>#</prompt> <userinput>openstack-config --set /etc/ceilometer/ceilometer.conf \
|
||||
service_credentials os_endpoint_type <replaceable>internalURL</replaceable></userinput>
|
||||
<prompt>#</prompt> <userinput>openstack-config --set /etc/ceilometer/ceilometer.conf \
|
||||
service_credentials os_auth_url http://<replaceable>controller</replaceable>:5000/v2.0</userinput></screen>
|
||||
<para os="ubuntu;debian">Edit the
|
||||
<filename>/etc/ceilometer/ceilometer.conf</filename> file
|
||||
and change the <literal>[keystone_authtoken]</literal>
|
||||
section:</para>
|
||||
<programlisting os="ubuntu;debian" language="ini">[keystone_authtoken]
|
||||
auth_host = controller
|
||||
auth_port = 35357
|
||||
auth_protocol = http
|
||||
<step>
|
||||
<para>In the <literal>[keystone_authtoken]</literal> section,
|
||||
configure Identity service access:</para>
|
||||
<programlisting language="ini">[keystone_authtoken]
|
||||
auth_uri = http://<replaceable>controller</replaceable>:5000/v2.0
|
||||
identity_uri = http://<replaceable>controller</replaceable>:35357
|
||||
admin_tenant_name = service
|
||||
admin_user = ceilometer
|
||||
admin_password = <replaceable>CEILOMETER_PASS</replaceable></programlisting>
|
||||
<para os="ubuntu;debian">Also set the
|
||||
<literal>[service_credentials]</literal> section:</para>
|
||||
<programlisting os="ubuntu;debian" language="ini">[service_credentials]
|
||||
<para>Replace <replaceable>CEILOMETER_PASS</replaceable> with the
|
||||
password you chose for the Telemetry module database.</para>
|
||||
<note>
|
||||
<para>Comment out the <literal>auth_host</literal>,
|
||||
<literal>auth_port</literal>, and <literal>auth_protocol</literal>
|
||||
keys, since they are replaced by the <literal>identity_uri</literal>
|
||||
and <literal>auth_uri</literal> keys.</para>
|
||||
</note>
|
||||
</step>
|
||||
<step>
|
||||
<para>In the <literal>[service_credentials]</literal> section,
|
||||
configure service credentials:</para>
|
||||
<programlisting language="ini">[service_credentials]
|
||||
os_auth_url = http://<replaceable>controller</replaceable>:5000/v2.0
|
||||
os_username = ceilometer
|
||||
os_tenant_name = service
|
||||
os_password = <replaceable>CEILOMETER_PASS</replaceable>
|
||||
os_endpoint_type = internalURL</programlisting>
|
||||
<para>Replace CEILOMETER_PASS with the password you chose for the
|
||||
ceilometer user in the Identity service.</para>
|
||||
</step>
|
||||
|
||||
<step os="ubuntu">
|
||||
<para>Configure the log directory.</para>
|
||||
<para>Edit the <filename>/etc/ceilometer/ceilometer.conf</filename> file
|
||||
and update the <literal>[DEFAULT]</literal> section:</para>
|
||||
<programlisting os="ubuntu" language="ini">[DEFAULT]
|
||||
<para>In the <literal>[DEFAULT]</literal> section, configure the
|
||||
log directory:</para>
|
||||
<programlisting language="ini">[DEFAULT]
|
||||
log_dir = /var/log/ceilometer</programlisting>
|
||||
</step>
|
||||
|
||||
</procedure>
|
||||
<procedure>
|
||||
<title>To finish installation</title>
|
||||
<step os="ubuntu;debian">
|
||||
<para>Restart the service with its new settings:</para>
|
||||
<screen><prompt>#</prompt> <userinput>service ceilometer-agent-compute restart</userinput></screen>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user