Bug 1127509 - Document the ack/nak/comment system for recipe results
Summary: Document the ack/nak/comment system for recipe results
Alias: None
Product: Beaker
Classification: Community
Component: Doc
Version: 0.17
Hardware: Unspecified
OS: Unspecified
unspecified vote
Target Milestone: 0.18.1
Assignee: Dan Callaghan
QA Contact: tools-bugs
Depends On:
TreeView+ depends on / blocked
Reported: 2014-08-07 02:41 UTC by Nick Coghlan
Modified: 2018-02-06 00:41 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Last Closed: 2014-09-12 07:36:25 UTC

Attachments (Terms of Use)

Description Nick Coghlan 2014-08-07 02:41:42 UTC
Currently, the only reference to the ack/nak/comment system for recipe results appears to be a brief one in the capabilities list in the architecture guide: https://beaker-project.org/docs/architecture-guide/capabilities.html#results

It's highly desirable to get that clearly documented, so we can use it as a basis for evolving the feature in the future.

In particular, bug 1013445 (which covers a page redesign for the main results page) should be informed by a clear understanding of the intended purpose of this capability.

It's also relevant to improving the integration with the jobs matrix (i.e. if we implement bug 641219 to hide nak'ed results by default, we will need to link to docs that explain what nak'ing a result means).

Bug 620968 (which would allow filteringout nak'ed jobs from the main results) would also benefit from having docs to reference.

Comment 2 Nick Coghlan 2014-08-07 02:45:18 UTC
Oops, that matrix view issue is bug 649219.

Comment 3 Nick Coghlan 2014-08-07 02:50:16 UTC
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.

Comment 4 Dan Callaghan 2014-09-02 01:03:21 UTC
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

Comment 5 Nick Coghlan 2014-09-02 02:34:41 UTC
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).

Comment 6 Dan Callaghan 2014-09-02 03:55:44 UTC
Original design of the feature was done in bug 596410.

Comment 7 Dan Callaghan 2014-09-02 08:12:17 UTC
Description of the review system:

XMLRPC API docs for setting response (note getting/setting comment is currently not covered):

bkr job-modify --response is already documented:

Comment 8 Dan Callaghan 2014-09-02 08:12:49 UTC
(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.

Comment 10 Dan Callaghan 2014-09-12 07:36:25 UTC
Beaker 0.18.1 has been released.

Note You need to log in before you can comment on or make changes to this bug.