diff --git a/help/README b/help/README new file mode 100644 index 00000000..3353fdfc --- /dev/null +++ b/help/README @@ -0,0 +1,2 @@ +This directory contains help files on how to read the logs generated +by devstack-gate. These are usually uploaded along-side the logs. diff --git a/help/tempest-logs.html b/help/tempest-logs.html new file mode 100644 index 00000000..e669d224 --- /dev/null +++ b/help/tempest-logs.html @@ -0,0 +1,158 @@ +
+ Above is a collection of log files from + the current tempest run. Within them + should be everything you need to get to the bottom of a test + failure. The screen-* logs will be your most valuable tools in this + process. Use the timestamp of the failed test in + the current tempest run. +
++
+ If there is a compute test failure, especially a server not getting + created correctly, or being in an unexpected state, the following is + typically the most fruitful order to look at things: +
+ If there is a volume failure in the test, the following is typically + the most fruitful order to look at things: +
+ This help file is part of the + + openstack-infra/devstack-gate + project, and can be found at + + help/tempest-logs.html + . + The file can be updated via the standard OpenStack Gerrit Review process. +
diff --git a/help/tempest-overview.html b/help/tempest-overview.html new file mode 100644 index 00000000..c1dc4623 --- /dev/null +++ b/help/tempest-overview.html @@ -0,0 +1,56 @@ ++ You are looking at the full test results of a devstack setup and + tempest run for the OpenStack gate, as well as all the logs of all the + relevant services that were running during that tempest test run. From + them you should have enough information to debug. +
++
+ All the devstack setup is done under bash tracing, so + is extremely verbose. This is to ensure enough data is captured + so that you can debug failures in the gate with the information provided. +
++ The tempest tests are the last 1% of the console.html. When looking + at failures it is typical best to start at the end of the file and + work backwards. +
++ The logs directory contains all the screen logs + from all the services during the devstack-gate run. +
++ This help file is part of the + + openstack-infra/devstack-gate + project, and can be found at + + help/tempest-overview.html + . + The file can be updated via the standard OpenStack Gerrit Review process. +