From 8de734c7c04507476d63ed004c8d32fb466a0215 Mon Sep 17 00:00:00 2001 From: Joshua Hesketh Date: Tue, 24 Mar 2015 20:43:46 +1100 Subject: [PATCH] Fetch devstack-gate documentation from dg Move the documentation to append to apache indexes into the devstack-gate footer. Change-Id: Ifcc7b9ab40aad55bc45377183ea06d40d9fe2f78 Depends-On: I8b26cc58c2ad6ca029726d227cf1d38d72465627 --- .../files/logs/help/tempest-logs.html | 158 ------------------ .../files/logs/help/tempest-overview.html | 56 ------- modules/openstack_project/manifests/static.pp | 29 +++- 3 files changed, 25 insertions(+), 218 deletions(-) delete mode 100644 modules/openstack_project/files/logs/help/tempest-logs.html delete mode 100644 modules/openstack_project/files/logs/help/tempest-overview.html diff --git a/modules/openstack_project/files/logs/help/tempest-logs.html b/modules/openstack_project/files/logs/help/tempest-logs.html deleted file mode 100644 index 246bd9e459..0000000000 --- a/modules/openstack_project/files/logs/help/tempest-logs.html +++ /dev/null @@ -1,158 +0,0 @@ -

Guide to Devstack Gate Logs

-

- 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. -

-

Types of logs

-

-

-

-

Nova Compute Fails

-

- 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: -

-

Cinder Volume Fails

-

- If there is a volume failure in the test, the following is typically - the most fruitful order to look at things: -

-

-

About this Help

-

- This help file is part of the - - openstack-infra/system-config - project, and can be found at - - modules/openstack_project/files/logs/help/tempest-logs.html - . - The file can be updated via the standard OpenStack Gerrit Review process. -

diff --git a/modules/openstack_project/files/logs/help/tempest-overview.html b/modules/openstack_project/files/logs/help/tempest-overview.html deleted file mode 100644 index 8bf86b0bf1..0000000000 --- a/modules/openstack_project/files/logs/help/tempest-overview.html +++ /dev/null @@ -1,56 +0,0 @@ -

Guide to Tempest Results Runs

-

- 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. -

-

How To Debug - Quickstart

-

-

    -
  1. scroll to the end of console.html -
  2. work your way backwards until the first failing test -
  3. copy the timestamp of that failing test -
  4. go into logs directory and look at that time stamp in related - service logs for traces, failures, or other oddities -
-

-

File Overview

-

console.html

-This file contains the stdout/stderr console of the devstack-gate -job. The basic flow of the file goes as follows: - -

- 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. -

-

logs

-

- The logs directory contains all the screen logs - from all the services during the devstack-gate run. -

-

About this Help

-

- This help file is part of the - - openstack-infra/system-config - project, and can be found at - - modules/openstack_project/files/logs/help/tempest-overview.html - . - The file can be updated via the standard OpenStack Gerrit Review process. -

diff --git a/modules/openstack_project/manifests/static.pp b/modules/openstack_project/manifests/static.pp index d3ee26e08a..826ba2aee9 100644 --- a/modules/openstack_project/manifests/static.pp +++ b/modules/openstack_project/manifests/static.pp @@ -151,18 +151,39 @@ class openstack_project::static ( require => File['/etc/os_loganalyze'], } + vcsrepo { '/opt/devstack-gate': + ensure => latest, + provider => git, + revision => 'master', + source => 'https://git.openstack.org/openstack-infra/devstack-gate', + } + file { '/srv/static/logs/help': ensure => directory, - recurse => true, - purge => true, - force => true, owner => 'root', group => 'root', mode => '0755', - source => 'puppet:///modules/openstack_project/logs/help', require => File['/srv/static/logs'], } + file { '/srv/static/logs/help/tempest-logs.html': + ensure => present, + owner => 'root', + group => 'root', + mode => '0444', + source => 'file:///opt/devstack-gate/help/tempest-logs.html', + require => [File['/srv/static/logs/help'], Vcsrepo['/opt/devstack-gate']], + } + + file { '/srv/static/logs/help/tempest-overview.html': + ensure => present, + owner => 'root', + group => 'root', + mode => '0444', + source => 'file:///opt/devstack-gate/help/tempest-overview.html', + require => [File['/srv/static/logs/help'], Vcsrepo['/opt/devstack-gate']], + } + file { '/usr/local/sbin/log_archive_maintenance.sh': ensure => present, owner => 'root',