Updates documentation for Fraser release

[apex.git] / docs / release / installation / troubleshooting.rst

diff --git a/docs/release/installation/troubleshooting.rst b/docs/release/installation/troubleshooting.rst
index efff979..f5b4208 100644 (file)
--- a/docs/release/installation/troubleshooting.rst
+++ b/docs/release/installation/troubleshooting.rst
@@ -5,7 +5,7 @@ This section aims to explain in more detail the steps that Apex follows
 to make a deployment. It also tries to explain possible issues you might find
 in the process of building or deploying an environment.
 
-After installing the Apex RPMs in the jumphost, some files will be located
+After installing the Apex RPMs in the Jump Host, some files will be located
 around the system.
 
 1.  /etc/opnfv-apex: this directory contains a bunch of scenarios to be
@@ -17,13 +17,10 @@ around the system.
 2.  /usr/bin/: it contains the binaries for the commands opnfv-deploy,
     opnfv-clean and opnfv-util.
 
-3.  /var/opt/opnfv/: it contains several files and directories.
+3.  /usr/share/opnfv/: contains Ansible playbooks and other non-python based
+    configuration and libraries.
 
-   3.1.   images/: this folder contains the images that will be deployed
-   according to the chosen scenario.
-
-   3.2.   lib/: bunch of scripts that will be executed in the different phases
-   of deployment.
+4.  /var/opt/opnfv/: contains disk images for Undercloud and Overcloud
 
 
 Utilization of Images
@@ -135,3 +132,13 @@ some possible solutions or workarounds to get the process continued.
         it will pass a different value for step each time. There is a total of
         five steps. Some of these steps will not be executed depending on the
         type of scenario that is being deployed.
+
+Reporting a Bug
+---------------
+
+Please report bugs via the `OPNFV Apex JIRA <https://wiki.opnfv.org/apex>`_
+page.  You may now use the log collecting utility provided by Apex in order
+to gather all of the logs from the overcloud after a deployment failure.  To
+do this please use the ``opnfv-pyutil --fetch-logs`` command.  The log file
+location will be displayed at the end of executing the script.  Please attach
+this log to the JIRA Bug.