1212931 - Add docs for obtaining and using the new Hawk credentials

Status: RESOLVED FIXED

(Tree Management :: Treeherder, defect, P2)

Description

[Ed Morley [:emorley]]

We should replace the oauth docs on read the docs with ones for the new per-user hawk credentials.

We should cover:
* Adding a new client_id using https://treeherder.mozilla.org/credentials/
* How admins authorise that client_id using https://treeherder.allizom.org/admin/credentials/
* How to use the client_id and key with the python client

Comment 1

[William Lachance (:wlach)]

I'll take this.

Comment 2

[William Lachance (:wlach)]

Attachment: Update client documentation

This updates the python client documentation to suggest using hawk auth. I'll write the server side parts of this later.

Comment 3

[Ed Morley [:emorley]]

Comment on attachment 8672399 [details] [review]
Update client documentation

Cancelling review for now pending bug 1213857 / bug 1213847 :-)

Comment 4

[Ed Morley [:emorley]]

Pages for admins to approve API credentials:
https://treeherder.allizom.org/admin/credentials/credentials/
https://treeherder.mozilla.org/admin/credentials/credentials/

Pages for people to request API credentials:
https://treeherder.allizom.org/credentials/create/
https://treeherder.mozilla.org/credentials/create/

Comment 5

[William Lachance (:wlach)]

Comment on attachment 8672399 [details] [review]
Update client documentation

Updated the docs to reflect your recent changes.

I also tested stuff locally, found and fixed a few minor issues.

Comment 6

[Treeherder GitHub Bugbot]

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

https://github.com/mozilla/treeherder/commit/a164383961f7b726fef366fbad9c6ab1976b60f8
Bug 1212931 - Update the client documentation to describe hawk auth

Since the old auth "TreeherderAuth" system is now deprecated.