Bug 1265829 - Clarify documentation around managing API credentials

This commit is contained in:
William Lachance 2016-04-19 14:29:59 -04:00
Родитель 708671c7b3
Коммит f44cd1c6ea
1 изменённых файлов: 16 добавлений и 3 удалений

Просмотреть файл

@ -71,7 +71,13 @@ Managing API credentials
------------------------
To submit data to Treeherder's API you need Hawk credentials,
even if you're submitting to your local server.
even if you're submitting to your local server. The recommended
process is slightly different for a development server versus
submitting to Treeherder staging or production, see below for
details.
Generating and using credentials on a local testing instance
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To generate credentials in the Vagrant instance run the following:
@ -83,12 +89,17 @@ The generated Hawk ``secret`` will be output to the console, which should then
be passed along with the chosen ``client_id`` to the TreeherderClient constructor.
For more details see the :doc:`submitting_data` section.
Generating and using credentials on treeherder stage or production
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Users can generate credentials for the deployed Mozilla Treeherder instances
(and view/delete existing ones) using the forms here:
`stage <https://treeherder.allizom.org/credentials/>`__ /
`production <https://treeherder.mozilla.org/credentials/>`__.
It is recommended that the same ``client_id`` string be used for both stage
and production.
and production. Once you've created your set of credentials, you can get
access to the Hawk ``secret`` by clicking on the link that should appear on the
credentials list page.
The credentials must be marked as approved by a Treeherder admin before they can
be used for submitting to the API. Request this for stage first, by filing a bug in
@ -96,11 +107,13 @@ be used for submitting to the API. Request this for stage first, by filing a bug
Once any submission issues are resolved on stage, file a new bug requesting
approval for production.
Once the credentials are approved, they may be used exactly in exactly
the same way as with a local testing instance (see above).
Treeherder administrators can manage credentials here:
`stage <https://treeherder.allizom.org/admin/credentials/credentials/>`__ /
`production <https://treeherder.mozilla.org/admin/credentials/credentials/>`__.
Add a new repository
--------------------