Bug 1127509
Summary: | Document the ack/nak/comment system for recipe results | ||
---|---|---|---|
Product: | [Retired] Beaker | Reporter: | Nick Coghlan <ncoghlan> |
Component: | Doc | Assignee: | Dan Callaghan <dcallagh> |
Status: | CLOSED CURRENTRELEASE | QA Contact: | tools-bugs <tools-bugs> |
Severity: | unspecified | Docs Contact: | |
Priority: | unspecified | ||
Version: | 0.17 | CC: | aigao, asaha, dcallagh, fyang, rmancy, xma |
Target Milestone: | 0.18.1 | Keywords: | Documentation, Patch |
Target Release: | --- | ||
Hardware: | Unspecified | ||
OS: | Unspecified | ||
Whiteboard: | |||
Fixed In Version: | Doc Type: | Bug Fix | |
Doc Text: | Story Points: | --- | |
Clone Of: | Environment: | ||
Last Closed: | 2014-09-12 07:36:25 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
2014-08-07 02:41:42 UTC
Oops, that matrix view issue is bug 649219. Note, I think it's more important to get this covered in the Architecture Guide than it is in the user guide. The architecture guide write-up is what we need as a basis for future design changes, and to explain to users that are curious the "why" of the system. For actual *usage*, we should be aiming for it to be sufficiently intuitive in the web UI that the users don't need dedicated docs. I'm not sure what exactly we need to add to the architecture guide here... It has this para currently: "To help filter out failures that are due to external environment issues (such as an outage of the lab network), results supports an acknowledgement system, where results may be accepted or rejected to indicate whether or not they represent a true failure or an incidental failure not related to the specific components being tested." which pretty much describes the entire feature and its purpose. I guess I can flesh that out into its own section "Result acknowledgement" which just mentions that: * it's per recipe-set * it's optional (defaults to neither ack nor nack) * you can add a comment as well Yep, that's what I had in mind - more details about what's already possible. If there's an API for it, then that may of interest to the virtlab folks, if not, then we should consider adding one (perhaps as part of a larger revamp of the results page). Original design of the feature was done in bug 596410. Description of the review system: http://gerrit.beaker-project.org/3307 XMLRPC API docs for setting response (note getting/setting comment is currently not covered): http://gerrit.beaker-project.org/3306 bkr job-modify --response is already documented: https://beaker-project.org/docs/man/bkr-job-modify.html#cmdoption-bkr-job-modify--response (In reply to Dan Callaghan from comment #7) > XMLRPC API docs for setting response (note getting/setting comment is > currently not covered): I mean, not covered by the API. There's no XMLRPC method to do it. This bug fix is available on the Beaker web site: https://beaker-project.org/docs-release-0.18/server-api/xmlrpc.html#bkr.server.jobs.jobs.set_response https://beaker-project.org/docs-release-0.18/architecture-guide/capabilities.html#result-comments-and-waivers Beaker 0.18.1 has been released. |