Bug 872428
| Summary: | Worked example showing process of updating, submitting and executing tasks | ||
|---|---|---|---|
| Product: | [Retired] Beaker | Reporter: | Nick Coghlan <ncoghlan> |
| Component: | Doc | Assignee: | Amit Saha <asaha> |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | |
| Severity: | unspecified | Docs Contact: | |
| Priority: | unspecified | ||
| Version: | 0.9 | CC: | asaha, dcallagh, ebaak, mishin, rglasz, rmancy |
| Target Milestone: | 0.11 | ||
| Target Release: | --- | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | Doc | ||
| Fixed In Version: | Doc Type: | Bug Fix | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2013-01-17 04:34:28 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-11-02 03:55:21 UTC
(In reply to comment #0) > The docs are missing a full example showing the process of: > > - creating/updating a task > - uploading that task to the task library > - submitting a job to execute that task > - getting the results of the task execution > > The "dogfood" task [1] that executes Beaker's own test suite inside a > running Beaker instance might serve as a suitable example, that isn't > completely trivial, but isn't too hard to understand, and can be guaranteed > to be available to anyone setting up or working on Beaker. > > Such an example could also be used as a useful integration test for someone > *setting up* a new Beaker installation: in that case, the dogfood tests > (which we know work in a properly configured Beaker instance) would really > be testing the correct operation of the *installation* rather than the > Beaker software. > > [1] > http://git.beaker-project.org/cgit/beaker/tree/Tasks/distribution/beaker/ > dogfood To start with, I am thinking about guiding the user who has just setup a Beaker installation, to create a task which would carry out a simple task like checking if ext4 support is available out of the box, or say it can access Internet resources, for example. And then write a Job XML to execute this task. Does that sounds like good value addition? It turns out there's a actually quite nice overview of this in the existing docs: http://beaker-project.org/guide/Administration-Chronological_Overview.html Moving or copying that into the User Guide near the new example would be a *good* thing. On Gerrit: http://gerrit.beaker-project.org/#/c/1469/ Possibly related would be a very basic "Writing your first test" guide: 1. Enabling the appropriate beaker-project.org repos 2. Installing beaker-client and rhts-test-env 3. Point readers to beakerlib docs* for info on how to write test cases *https://fedorahosted.org/beakerlib/wiki/Manual Fresh patch: http://gerrit.beaker-project.org/#/c/1520/ (In reply to comment #7) > Possibly related would be a very basic "Writing your first test" guide: > > 1. Enabling the appropriate beaker-project.org repos I think the position of this guide is way too deep for this information. > 2. Installing beaker-client and rhts-test-env > 3. Point readers to beakerlib docs* for info on how to write test cases The latest patch addresses these two I think. > > *https://fedorahosted.org/beakerlib/wiki/Manual Additional time used in updating the doc and investigating beaker-wizard's functionality and code (Also: https://bugzilla.redhat.com/show_bug.cgi?id=883203). Verified on local build of beaker-project.org Beaker 0.11.0 has been released. |