1239428 - Add more details to the docs about requesting API credential authorisation

Status: RESOLVED FIXED

(Tree Management :: Treeherder, defect, P2)

Description

[Ed Morley [:emorley]]

<erahm> Hi folks, I'm looking for someone to authorize my requests for credentials to post AreWeSlimYet data to the staging ('awsy-staging') and production ('awsy') treeherder instances
<erahm> camd, emorley: I heard talk you might be able to help me out ^
<emorley> typically the prod credentials will be authorised once the jobs are being submitting successfully to stage; I'll auth stage for you now
<emorley> erahm: I've marked the credentials on treeherder.allizom.org as authorised - I've also renamed the client_id to just 'awsy' so it matches prod. They are two separate systems so no need to namespace the client_id. Let us know if you have any issues :-)
<erahm> emorley: Thanks!
<emorley> erahm: when things are looking good on stage, file a bug in Tree Management:: Treeherder: API to ask the prod ones to be authorised and we'll do that for you :-)
<erahm> emorley: excellent, will do
<emorley> erahm: (it then also gives a papertrail back to bugs that performed the work, and helps us to know which components to file things in, in the future :-))
<erahm> emorley: Makes sense! Perhaps we could add it to the docs? https://treeherder.readthedocs.org/common_tasks.html#managing-api-credentials

Comment 1

[GitHub Autolander Bot]

Attachment: [treeherder] mozilla:improve-api-credentials-docs > mozilla:master

Comment 2

[Treeherder GitHub Bugbot]

Commit pushed to master at https://github.com/mozilla/treeherder

https://github.com/mozilla/treeherder/commit/6b6e78cc722f21b1049fa5b6915e316e689556f8
Bug 1239428 - Docs: Clarify process for API credential approval

* Recommend using the same `client_id` for stage/prod.
* Mention the need to file a bug (and where) for requesting approval.
* Explain prod approval needs submission to be working on stage first.

Comment 3

[Ed Morley [:emorley]]

Eric, hopefully this is clearer, let me know if there's anything else I can add :-)
http://treeherder.readthedocs.org/common_tasks.html#managing-api-credentials

Comment 4

[Eric Rahm [:erahm]]

(In reply to Ed Morley [:emorley] from comment #3)
> Eric, hopefully this is clearer, let me know if there's anything else I can
> add :-)
> http://treeherder.readthedocs.org/common_tasks.html#managing-api-credentials

That looks great, thank you.