How to Report Issues in Arvados » History » Version 3

Brett Smith, 09/22/2014 07:41 PM
merge two bullet points - want to emphasize the sharing point for Collections too

1 1 Brett Smith
h1. How to Report Issues in Arvados
2 1 Brett Smith
3 2 Tom Clegg
First: Thanks for helping us improve Arvados!
4 2 Tom Clegg
5 1 Brett Smith
If you encounter a problem using Arvados, the surest way to make sure it gets fixed is to "report an issue on our bug tracker":  The best bug reports include:
6 1 Brett Smith
7 1 Brett Smith
* all the steps you took that led to the issue,
8 1 Brett Smith
* the action Arvados took, including the full text of any error messages it reported, and
9 1 Brett Smith
* the action you expected Arvados to take (even if that's as simple as "it shouldn't crash").
10 1 Brett Smith
11 2 Tom Clegg
If the problem involves Workbench, it can also be very helpful to report the Workbench and API versions you were using (click the Help icon at the top right, and choose "show version/debugging info").
12 1 Brett Smith
13 2 Tom Clegg
h2. Privacy
14 2 Tom Clegg
15 2 Tom Clegg
Some issues are best illustrated with reference to specific data in Arvados—for example, maybe you're having trouble accessing a particular collection.  When you file issues like this, please be aware that certain identifiers, like portable data hashes and block locators from Collection objects, can reveal details about your work to the public. Here are some guidelines to help protect your privacy:
16 2 Tom Clegg
* API tokens *should not be shared.*
17 2 Tom Clegg
* Collection portable data hashes like @1f4b0bc7583c2a7f9102c395f4ffc5e3+45@ and block identifiers like @acbd18db4cc2f85cedef654fccc4a4d8+3@ *should not be shared* if you don't want people to know which datasets you are working with.[1]
18 2 Tom Clegg
* Keep block permission signatures are not sensitive _as long as you don't share your API tokens._
19 3 Brett Smith
* Arvados UUIDs for jobs, pipeline instances, pipeline templates, and collections do not reveal anything about content (except, of course, to other users who have access to those items via Arvados's sharing features).  They look like @zzzzz-yyyyy-abcde12345fghij@.
20 2 Tom Clegg
* If you're having trouble with sensitive data or processes, refer to it through data that's safe to talk about—for example, "the input parameter of pipeline instance P," or "the output of job J."
21 2 Tom Clegg
* If you're including a large error message like a backtrace from a command-line tool, please take care to edit out any sensitive identifiers, and other strings like filenames, that shouldn't be public.
22 2 Tom Clegg
23 2 Tom Clegg
If you must report an issue that includes sensitive information, or you're just not confident that you have removed all sensitive information, please send it by e-mail to
24 2 Tom Clegg
25 2 Tom Clegg
fn1. Showing a hash does not give anyone access to the data content, but it does enable someone who already has access to that data by some other means (or even just its data hash) to confirm that you were using it. You might not want to reveal _the fact that you are using that dataset,_ even if the dataset itself only contains unrestricted public data.