From 6a5ab0d81ae80d86c9f067fb0afd620c1b5a071c Mon Sep 17 00:00:00 2001
From: Don Domingo <ddomingo@redhat.com>
Date: Thu, 27 Feb 2014 13:46:24 +1000
Subject: [PATCH] Add list of service log files used by nova

This patch adds the list of log files used by Compute services.
It also includes the os-specific name of each service/interface that
corresponds to each log file.

Change-Id: I39e6625b5a1cd506dd6f744176bb838756c63c70
Partial-Bug: #1282882
---
 doc/config-reference/ch_computeconfigure.xml  |   1 +
 .../compute/section_nova-log-files.xml        | 131 ++++++++++++++++++
 2 files changed, 132 insertions(+)
 create mode 100644 doc/config-reference/compute/section_nova-log-files.xml

diff --git a/doc/config-reference/ch_computeconfigure.xml b/doc/config-reference/ch_computeconfigure.xml
index 6d4a1c8ad8..14b0294c67 100644
--- a/doc/config-reference/ch_computeconfigure.xml
+++ b/doc/config-reference/ch_computeconfigure.xml
@@ -102,5 +102,6 @@
   <xi:include href="compute/section_compute-conductor.xml"/>
   <xi:include href="compute/section_compute-security.xml"/>
   <xi:include href="compute/section_compute-config-samples.xml"/>
+  <xi:include href="compute/section_nova-log-files.xml"/>
   <xi:include href="compute/section_compute-options-reference.xml"/>
 </chapter>
diff --git a/doc/config-reference/compute/section_nova-log-files.xml b/doc/config-reference/compute/section_nova-log-files.xml
new file mode 100644
index 0000000000..c27fc56f62
--- /dev/null
+++ b/doc/config-reference/compute/section_nova-log-files.xml
@@ -0,0 +1,131 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section 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"
+    xml:id="section_nova-logs">
+        <title>Log files used by Compute</title>
+    <para>The corresponding log file of each Compute service
+    is stored in the <filename>/var/log/nova/</filename>
+    directory of the host on which each service runs.</para>
+    <table rules="all">
+    <caption>Log files used by Compute services</caption>
+    <col width="35%"/>
+    <col width="35%"/>
+    <col width="30%"/>
+        <thead>
+        <tr>
+            <td>
+            Log file
+            </td>
+            <td>
+            Service name (CentOS/Fedora/openSUSE/Red Hat Enterprise
+            Linux/SUSE Linux Enterprise)
+            </td>
+            <td>
+            Service name (Ubuntu/Debian)
+            </td>
+        </tr>
+        </thead>
+        <tbody>
+        <tr>
+            <td>
+            <filename>api.log</filename>
+            </td>
+            <td>
+            openstack-nova-api
+            </td>
+            <td>
+            nova-api
+            </td>
+        </tr>
+        <tr>
+            <td>
+            <filename>cert.log</filename>
+            <footnote xml:id="fn_cert-log-nova">
+                <para>The X509 certificate service
+                (<systemitem>openstack-nova-cert</systemitem>/<systemitem>nova-cert</systemitem>)
+                is only required by the EC2 API to the Compute
+                service.</para></footnote>
+            </td>
+            <td>
+            <systemitem class="service">openstack-nova-cert</systemitem>
+            </td>
+            <td>
+            <systemitem class="service">nova-cert</systemitem>
+            </td>
+        </tr>
+        <tr>
+            <td>
+            <filename>compute.log</filename>
+            </td>
+            <td>
+            <systemitem class="service">openstack-nova-compute</systemitem>
+            </td>
+            <td>
+            <systemitem class="service">nova-compute</systemitem>
+            </td>
+        </tr>
+        <tr>
+            <td>
+            <filename>conductor.log</filename>
+            </td>
+            <td>
+            <systemitem class="service">openstack-nova-conductor</systemitem>
+            </td>
+            <td>
+            <systemitem class="service">nova-conductor</systemitem>
+            </td>
+        </tr>
+        <tr>
+            <td>
+            <filename>consoleauth.log</filename>
+            </td>
+            <td>
+            <systemitem class="service">openstack-nova-consoleauth</systemitem>
+            </td>
+            <td>
+            <systemitem class="service">nova-consoleauth</systemitem>
+            </td>
+        </tr>
+        <tr>
+            <td>
+            <filename>network.log</filename><footnote xml:id="fn_network-log-nova">
+            <para>The <systemitem>nova</systemitem> network service
+            (<systemitem>openstack-nova-network</systemitem>/<systemitem>nova-network</systemitem>)
+            only runs in deployments that are not configured to use
+            the Networking service (<systemitem>neutron</systemitem>).
+            </para></footnote>
+            </td>
+            <td>
+            <systemitem class="service">openstack-nova-network</systemitem>
+            </td>
+            <td>
+            <systemitem class="service">nova-network</systemitem>
+            </td>
+        </tr>
+        <tr>
+            <td>
+            <filename>nova-manage.log</filename>
+            </td>
+            <td>
+            <systemitem class="service">nova-manage</systemitem>
+            </td>
+            <td>
+            <systemitem class="service">nova-manage</systemitem>
+            </td>
+        </tr>
+        <tr>
+            <td>
+            <filename>scheduler.log</filename>
+            </td>
+            <td>
+            <systemitem class="service">openstack-nova-scheduler</systemitem>
+            </td>
+            <td>
+            <systemitem class="service">nova-scheduler</systemitem>
+            </td>
+        </tr>
+        </tbody>
+    </table>
+
+</section>