Bug 888136

Summary:	Add Troubleshooting section to User Guide
Product:	[Retired] Beaker	Reporter:	Nick Coghlan <ncoghlan>
Component:	Doc	Assignee:	Roman Joost <rjoost>
Status:	CLOSED CURRENTRELEASE	QA Contact:	tools-bugs <tools-bugs>
Severity:	unspecified	Docs Contact:
Priority:	medium
Version:	0.10	CC:	dcallagh, dowang, ebaak, jingwang, qwan, rjoost, tools-bugs
Target Milestone:	23.0	Keywords:	Documentation, Patch, Triaged
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:	Doc
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2016-07-07 23:12:37 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description Nick Coghlan 2012-12-18 04:07:40 UTC

A lot of things can go wrong when running tests in Beaker. Currently, there's no mechanism for capturing info about hard to diagnose common mistakes and their solutions in the project documentation. A simple troubleshooting guide may make a useful point of reference for tips and tricks like:

- for systems with 2 network cards attached, ensure ksdevice is set appropriately in the kernel parameters

- when triggering a reboot in a test, ensure that test correctly checks if the reboot has already happened

etc

Comment 3 Stefanie Forrester 2012-12-19 13:56:39 UTC

Here's one we see a lot in eng-ops.

Error: 

After installation, the console is filled with 
'ls: cannot access /var/run/beah/rhts-compat/launchers: No such file or directory'

Causes: 

1. Network connection may be offline. (most likely)
2. Some kind of installation error occurred, which is 'fixed' by rebooting the host.
3. The system is incompatible with rhts-compat, so it must be disabled in the job xml.

Comment 4 Nick Coghlan 2013-06-07 08:39:25 UTC

Something else the Troubleshooting guide should cover is the different levels where things can go wrong:

For the task authors and submitters to fix:
* in the task
* in the job specification
* in any job level custom kickstart snippets/templates

For the Beaker instance maintainers to fix:
* in the physical machine
* in the network configuration
* in the conserver setup
* in the distro import
* in the power controller setup
* in the log archiver configuration
* in any site level custom kickstart snippets/templates

For the Beaker developers to fix:
* in the default kickstart templates
* in the default tasks
* in the test harness
* in the lab controller
* in the main server

Comment 5 Raymond Mancy 2013-11-27 00:56:47 UTC

(In reply to Nick Coghlan from comment #4)
> Something else the Troubleshooting guide should cover is the different
> levels where things can go wrong:
> 
> For the task authors and submitters to fix:
> * in the task
> * in the job specification
> * in any job level custom kickstart snippets/templates
> 
> For the Beaker instance maintainers to fix:
> * in the physical machine
> * in the network configuration
> * in the conserver setup
> * in the distro import
> * in the power controller setup
> * in the log archiver configuration
> * in any site level custom kickstart snippets/templates
> 

Ideally we want troubleshooting guides for these
admin related tasks. I've created the following bug to track this, BZ#1035059

> For the Beaker developers to fix:
> * in the default kickstart templates
> * in the default tasks
> * in the test harness
> * in the lab controller
> * in the main server

Comment 6 Roman Joost 2016-04-12 00:46:36 UTC

Patch filed in gerrit:

https://gerrit.beaker-project.org/#/c/4796/

Comment 7 Roman Joost 2016-04-21 01:16:56 UTC

This has been published under:

https://beaker-project.org/docs-develop/user-guide/

Comment 9 Dan Callaghan 2016-07-07 23:12:37 UTC

Beaker 23.0 has been released.