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