| James E. Blair | eff5a9d | 2017-06-20 00:00:37 -0700 | [diff] [blame] | 1 | :title: Connection Configuration |
| 2 | |
| 3 | .. _connection-config: |
| 4 | |
| 5 | Connection Configuration |
| 6 | ======================== |
| 7 | |
| 8 | Most of Zuul's configuration is contained in the git repositories upon |
| 9 | which Zuul operates, however, some configuration outside of git |
| 10 | repositories is still required to bootstrap the system. This includes |
| 11 | information on connections between Zuul and other systems, as well as |
| 12 | identifying the projects Zuul uses. |
| 13 | |
| 14 | .. _connections: |
| 15 | |
| 16 | Connections |
| 17 | ----------- |
| 18 | |
| 19 | In order to interact with external systems, Zuul must have a |
| 20 | *connection* to that system configured. Zuul includes a number of |
| 21 | drivers, each of which implements the functionality necessary to |
| 22 | connect to a system. Each connection in Zuul is associated with a |
| 23 | driver. |
| 24 | |
| 25 | To configure a connection in Zuul, select a unique name for the |
| 26 | connection and add a section to **zuul.conf** with the form |
| 27 | "[connection NAME]". For example, a connection to a gerrit server may |
| 28 | appear as:: |
| 29 | |
| 30 | [connection mygerritserver] |
| 31 | driver=gerrit |
| 32 | server=review.example.com |
| 33 | |
| 34 | .. _drivers: |
| 35 | |
| 36 | Drivers |
| 37 | ------- |
| 38 | |
| 39 | Drivers may support any of the following functions: |
| 40 | |
| 41 | * Sources -- hosts git repositories for projects. Zuul can clone git |
| 42 | repos for projects and fetch refs. |
| 43 | * Triggers -- emits events to which Zuul may respond. Triggers are |
| 44 | configured in pipelines to cause changes or other refs to be |
| 45 | enqueued. |
| 46 | * Reporters -- outputs information when a pipeline is finished |
| 47 | processing an item. |
| 48 | |
| 49 | Zuul includes the following drivers: |
| 50 | |
| 51 | .. toctree:: |
| 52 | :maxdepth: 2 |
| 53 | |
| 54 | drivers/gerrit |
| 55 | drivers/github |
| 56 | drivers/smtp |
| 57 | drivers/sql |
| 58 | drivers/timer |
| 59 | drivers/zuul |