Add Buildbot Bridge documentation

ka7 · Nov 16, 2015 · c89721a · c89721a
1 parent 9710e0f
commit c89721a
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 0 deletions.
diff --git a/docs/buildbot_bridge.rst b/docs/buildbot_bridge.rst
@@ -0,0 +1,5 @@
+:mod:`buildbot_bridge`
+######################
+
+.. automodule:: mozci.sources.buildbot_bridge
+   :members:
diff --git a/docs/using_mozci.rst b/docs/using_mozci.rst
@@ -21,5 +21,6 @@ Data sources:
 
    allthethings
    buildapi
+   buildbot_bridge
    buildjson
    pushlog
diff --git a/mozci/sources/buildbot_bridge.py b/mozci/sources/buildbot_bridge.py
@@ -1,6 +1,25 @@
 """
 This module contains helper methods to help schedule tasks on TaskCluster
 which will use the buildbot-bridge system to trigger them on buildbot.
+
+Instead of using LDAP credentials like for Buildapi, you need to have a set of credentials
+with a couple of scopes for this purpose.
+
+At this moment only a limited number of a Mozilla employee can create credentials for you:
+
+* File a bug https://bugzilla.mozilla.org/enter_bug.cgi?product=Taskcluster&component=General
+* CC armenzg or adusca to vouch for you
+* Ask for your client to have the same scopes as this
+* https://tools.taskcluster.net/auth/roles/#client-id:bbb-scheduler
+
+After you receive your credentials you can specify your credentials with:
+
+* export TASKCLUSTER_CLIENT_ID=<value>
+* export TASKCLUSTER_ACCESS_TOKEN=<value>
+
+You can use the script
+https://github.com/mozilla/mozilla_ci_tools/blob/master/mozci/scripts/buildbot_to_taskcluster.py
+to schedule Buildbot jobs via TaskCluster.
 """
 from __future__ import absolute_import