summaryrefslogtreecommitdiff
path: root/src/zuulv3/tutorial.rst
blob: 7272594b0d9b0cb4a728e371d98b84e26345fb5a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
. display in 68x24
.. display in 88x24

.. pygments yaml? (only file breaks (---) tinted)
.. slide on high level v3 changes
.. slide on nodepool

.. transition:: dissolve
   :duration: 0.4

Test Slide
==========
.. hidetitle::

.. ansi:: images/testslide.ans

Preshow
=======
.. hidetitle::

.. ansi:: images/cursor.ans images/cursor2.ans

Zuul
====
.. hidetitle::
.. ansi:: images/title.ans

Overview
========

* Discussion of concepts
* Installation of software
* Configurting Zuul
* Writing jobs

Please Ask Questions
====================

Pre-show
========

While we talk about other things ...

* Install docker, docker-compose, git-review

Debian/Ubuntu:

::

  apt-get install docker-compose git git-review

Red Hat / SuSE

::

  yum install docker-compose git git-review

* git clone https://git.zuul-ci.org/zuul
* cd zuul
* git review -d 608344
* cd doc/source/admin/examples
* docker-compose up

Output in docker-compose window
===============================

* All services running with debug logging to stdout
* Tons of information will have been output - including some errors
* Zuul connects to Gerrit before it's fully configured
* As it becomes configured, Zuul notices and becomes happy
* Once happy, it should stablize and become idle

We'll come back to this
=======================

It's going to do a bunch of network - and this is a conference.

Red Hat
=======
.. hidetitle::
.. container:: handout
   i work for

.. ansi:: images/redhat.ans

OpenStack
=========
.. hidetitle::
.. ansi:: images/openstack.ans

OpenStack Infra
===============

::

  "most insane CI infrastructure I've ever been a part of"

    -- Alex Gaynor

  "OpenStack Infra are like the SpaceX of CI"

    -- Emily Dunham

Zuul
====
.. hidetitle::
.. ansi:: images/zuul.ans


Spoilers
========

* What Zuul does

  * multiple repositories
  * integrated deliverable
  * gated commits
  * open tooling
  * nobody is special
  * testing like deployment

OpenStack Is
============

  * Federated
  * Distributed
  * Large
  * Open
  * Not Alone

Federated
=========

  * Hundreds of involved companies
  * No 'main' company
  * "Decisions are made by those who show up"
  * Union of priorities/use cases

Impact of being Federated
=========================

  * No company can appoint people to positions in the project
  * The project cannot fire anyone
  * Variable background of contributors
  * Heavy reliance on consensus

Distributed
===========

  * There is no office
  * Contributor base is global
  * Multitude of contributor backgrounds

Impact of being Distributed
===========================

  * Tooling must empower all contributors, regardless of background,
    skill level or cultural context
  * Heavy preference for text-based communication
  * Cannot assume US-centric needs or solutions

Large numbers of
================

  * Contributors (\~2k in any given 6 month period)
  * Changes
  * Code Repositories (1955 as of this morning)

Not Bragging About Scale
========================

OpenStack Scale Comparison
==========================

  * 2KJPH (2,000 jobs per hour)
  * Build Nodes from 13 Regions of 5 Public and 2 Private OpenStack Clouds
  * Rackspace, Internap, OVH, Vexxhost, CityCloud and Linaro, Limestone
  * 10,000 changes merged per month

OpenStack Scale Comparison
==========================

  * 2KJPH (2,000 jobs per hour)
  * Build Nodes from 13 Regions of 5 Public and 2 Private OpenStack Clouds
  * Rackspace, Internap, OVH, Vexxhost, CityCloud and Linaro, Limestone
  * 10,000 changes merged per month

    * By comparison, our friends at the amazing project Ansible received
      13,000 changes and had merged 8,000 of them in its first 4 years.

Four Opens
==========

  * Open Source
    (we don't hold back Enterprise features, we don't cripple things)
  * Open Design
    (design process open to all, decisions are not made inside company doors)
  * Open Development
    (public source code, public code review, all code is reviewed and gated)
  * Open Community
    (lazy consensus, democratic leadership from participants,
     public logged meetings in IRC, public archived mailing lists)

We're Not Alone
===============

  * Dependencies (libvirt/kvm/xen, mysql/pg, rabbit,
    python/javascript, ceph/gluster, ansible/salt/puppet/chef, ovs/odl)
  * Adjacencies (kubernetes, ansible, terraform, opnfv, spinnaker)
  * Vendors (plugins, products, services, distros)

Developer Process In a Nutshell
===============================

  * Code Review - nobody has direct commit/push access
  * 3rd-Party CI for vendors
  * Gated Commits

OpenStack Developer Workflow
============================
.. container:: handout

  * Who has submitted a patch?
  * Who wants to?
  * (Who is here because the name of this talk is weird?)

::

            Hack             Review              Test
         =========         ==========         ==========

                    push              approve
               +-------------+    +-------------+
               |             |    |             |
        +------+--+       +--v----+--+       +--v-------+
        |         |       |          |       |          |
        | $EDITOR |       |  Gerrit  |       |   Zuul   |
        |         |       |          |       |          |
        +------^--+       +--+----^--+       +--+-------+
               |             |    |             |
               +-------------+    +-------------+
                    clone              merge

Gerrit
======
.. hidetitle::
.. container:: handout

   explain patch upload, zuul runs, test results displayed in gerrit
   this is all the interface to zuul users need to see

   switch to actual gertty screenshot

   also show zuul status page

   but zuul is doing a lot of work behind the scenes, and if you look
   closer, this is what you see

.. ansi:: images/color-gertty.ans

Zuul Architecture
=================

.. ansi:: images/architecture.ans

Nodepool
========

* A separate program that works very closely with *Zuul*
* Builds images daily and uploads to clouds
* Creates and destroys (at least) a vm for every job

  (Remember that 2,000 jobs per hour number?)

Zuul is not New
===============

  * Has been in Production for OpenStack for Six Years
  * Zuul v3 first release where not-OpenStack is first-class use case
  * Zuul is now a top-level effort of OpenStack Foundation

Not just for OpenStack
======================

  * Zuul is in production for OpenStack (in OpenStack VMs)

  Also running at:

  * BMW (control plane in OpenShift)
  * Easystack
  * GoDaddy (control plane in Kubernetes)
  * OpenContrail
  * OpenLab
  * Red Hat
  * others ...

Zuul in a nutshell
==================

  * Listens for code events
  * Prepares appropriate job config and git repo states
  * Allocates nodes for test jobs
  * Pushes git repo states to nodes
  * Runs user-defined Ansible playbooks
  * Collects/reports results
  * Potentially merges change

All in Service of Gating
========================

Gating
======

 Every change proposed for a repository is tested before it merges.

Co-gating
=========

 Changes to a set of repositories merge monotonically such
 that each change is tested with the current state of all
 the other related repositories before it merges.

Parallel Co-gating
==================

 Changes are serialized such that each change is tested
 with all of the changes ahead of it to satisfy the
 co-gating requirement while being able to run tests for
 multiple changes simultaneously.

Zuul Simulation
===============
.. transition:: pan
.. container:: handout

  * todo

.. ansi:: images/zsim-00.ans

Zuul Simulation
===============
.. transition:: cut
.. container:: handout

  * todo

.. ansi:: images/zsim-01.ans

Zuul Simulation
===============
.. transition:: cut
.. container:: handout

  * todo

.. ansi:: images/zsim-02.ans

Zuul Simulation
===============
.. transition:: cut
.. container:: handout

  * todo

.. ansi:: images/zsim-03.ans

Zuul Simulation
===============
.. transition:: cut
.. container:: handout

  * todo

.. ansi:: images/zsim-04.ans

Zuul Simulation
===============
.. transition:: cut
.. container:: handout

  * todo

.. ansi:: images/zsim-05.ans

Zuul Simulation
===============
.. transition:: cut
.. container:: handout

  * todo

.. ansi:: images/zsim-06.ans

Zuul Simulation
===============
.. transition:: cut
.. container:: handout

  * todo

.. ansi:: images/zsim-07.ans

Zuul Simulation
===============
.. transition:: cut
.. container:: handout

  * todo

.. ansi:: images/zsim-08.ans

Zuul Simulation
===============
.. transition:: cut
.. container:: handout

  * todo

.. ansi:: images/zsim-09.ans

Zuul Simulation
===============
.. transition:: cut
.. container:: handout

  * todo

.. ansi:: images/zsim-10.ans

Zuul Simulation
===============
.. transition:: cut
.. container:: handout

  * todo

.. ansi:: images/zsim-11.ans

Zuul Simulation
===============
.. transition:: cut
.. container:: handout

  * todo

.. ansi:: images/zsim-12.ans

Zuul Simulation
===============
.. transition:: cut
.. container:: handout

  * todo

.. ansi:: images/zsim-13.ans

Zuul Simulation
===============
.. transition:: cut
.. container:: handout

  * todo

.. ansi:: images/zsim-14.ans

Zuul Simulation
===============
.. transition:: cut
.. container:: handout

  * todo

.. ansi:: images/zsim-15.ans

Zuul Simulation
===============
.. transition:: cut
.. container:: handout

  * todo

.. ansi:: images/zsim-16.ans

Zuul Simulation
===============
.. transition:: cut
.. container:: handout

  * todo

.. ansi:: images/zsim-17.ans

Zuul Simulation
===============
.. transition:: cut
.. container:: handout

  * todo

.. ansi:: images/zsim-18.ans

Zuul Simulation
===============
.. transition:: cut
.. container:: handout

  * todo

.. ansi:: images/zsim-19.ans

Zuul Simulation
===============
.. transition:: cut
.. container:: handout

  * todo

.. ansi:: images/zsim-20.ans

Zuul Simulation
===============
.. transition:: cut
.. container:: handout

  * todo

.. ansi:: images/zsim-21.ans

Zuul Simulation
===============
.. transition:: cut
.. container:: handout

  * todo

.. ansi:: images/zsim-22.ans

Cross-Project Dependencies
==========================

Testing or gating dependencies manually specified by developers

.. container:: progressive

   * shade https://review.openstack.org/513913

       Add unittest tips jobs
   * os-client-config https://review.openstack.org/513915

       Add shade-tox-tips jobs

       Depends-On: https://review.openstack.org/513913
   * os-client-config https://review.openstack.org/513751

       Added nat_source flag for networks

       Depends-On: https://review.openstack.org/513915
   * shade https://review.openstack.org/51391

       Add support for configured NAT source variable

       Depends-On: https://review.openstack.org/513751


Live Configuration Changes
==========================

.. container:: handout

  Zuul is a distributed system, with a distributed configuration.

.. code:: yaml

   - tenant:
       name: openstack
       source:
         gerrit:
           config-repos:
             - openstack-infra/project-config
           project-repos:
             - openstack/nova
             - openstack/keystone
             - openstack-infra/devstack-gate

Zuul Startup
============

* Read config file

Zuul Startup
============

* Read config file
* Ask mergers for branches of each repo

.. ansi:: images/startup1.ans

Zuul Startup
============

* Read config file
* Ask mergers for branches of each repo
* Ask mergers for .zuul.yaml for each branch

    of each repo

.. ansi:: images/startup2.ans

When .zuul.yaml Changes
=======================

.. container:: progressive

  * Zuul looks for changes to .zuul.yaml
  * Asks mergers for updated content
  * Splices into configuration used for that change
  * Works with cross-repo dependencies

    ("This change depends on a change to the job definition")

How do you use this thing?
==========================
.. transition:: tilt
.. hidetitle::
.. figlet:: Configuration

Human Roles
===========

* Deployer
* Project Admin
* End User

Deployer Config
===============

Zuul: Connection, Triggers, Reporters
Nodepool: Launcher and Builder Config

Connection Plugins
==================

Describes how Zuul connects to external systems

* Gerrit
* Github
* git
* mqtt
* smtp
* sql

Trigger Plugins
===============

Input to Zuul for use in causing jobs to run

* Gerrit
* Github
* git
* zuul

Reporter Plugins
================

Where Zuul should send information about jobs

* Gerrit
* Github
* mqtt
* smtp
* sql

Nodepool Launcher
=================

Where build nodes should come from

* OpenStack
* Static

In works:

* Kubernetes
* OpenShift
* ec2
* Azure

Nodepool Builder
================

Optionally periodically build and upload new base images

* OpenStack

main.yaml
=========

* Most of Zuul's config comes from git repos
* main.yaml is static config
* what git repos to manage
* what config objects to load
* which repos to get config from

Config Project vs. Untrusted Project
====================================

config project

* special project containing project admin content
* has access to features that are normally restricted
* job changes are not applied speculatively

untrusted project

* most projects
* some actions (like executing code on localhost) are blocked
* job changes are applied speculatively

Job Config
==========

Pipelines
=========

* A process definition that connects git repositories, jobs, and
  reporting mechanisms.
* A context to fix a set of jobs to each project.
* Pipeline Managers are Plugins: dependent, independent, supercedent

Check Pipeline
==============

.. code:: yaml

   - pipeline:
       name: check
       manager: independent
       source: gerrit
       trigger:
         gerrit:
           - event: patchset-created
           - event: change-restored
       success:
         gerrit:
           verified: 1

Gate Pipeline
=============

.. code:: yaml

   - pipeline:
       name: gate
       manager: dependent
       source: gerrit
       trigger:
         gerrit:
           - event: comment-added
             approval:
             - workflow: 1
       success:
         gerrit:
           verified: 2
           submit: true

Jobs
====

* Jobs run on nodes from nodepool (static or dynamic)
* Metadata defined in Zuul's configuration
* Execution content in Ansible
* Jobs may be defined centrally or in the repo being tested
* Jobs have contextual variants that simplify configuration

zuul-jobs
=========

* Zuul jobs are all defined in git repositories
* Designed to be directly shared across zuul installations
* Standard library: https://git.zuul-ci.org/zuul-jobs
* Zuul installs should add ``zuul-jobs`` to their config
* As changes land in ``zuul-jobs`` - Zuul installs will get them automatically

Job
===

.. code:: yaml

  - job:
      name: base
      parent: null
      description: |
        The base job for Zuul.
      timeout: 1800
      nodeset:
        nodes:
          - name: primary
            label: centos-7
      pre-run: playbooks/base/pre.yaml
      post-run:
        - playbooks/base/post-ssh.yaml
        - playbooks/base/post-logs.yaml
      secrets:
        - site_logs

Simple Job
==========

.. code:: yaml

   - job:
      name: tox
      pre-run: playbooks/setup-tox.yaml
      run: playbooks/tox.yaml
      post-run: playbooks/fetch-tox-output.yaml

Simple Job Inheritance
======================

.. code:: yaml

  - job:
      name: tox-py36
      parent: tox
      vars:
        tox_envlist: py36

Inheritance Works Like An Onion
===============================

  * pre-run playbooks run in order of inheritance
  * run playbook of job runs
  * post-run playbooks run in reverse order of inheritance
  * If pre-run playbooks fail, job is re-tried
  * All post-run playbooks run - as far as pre-run playbooks got

Inheritance Example
===================

For tox-py36 job

  * base pre-run playbooks/base/pre.yaml
  * tox pre-run playbooks/setup-tox.yaml
  * tox run playbooks/tox.yaml
  * tox post-run playbooks/fetch-tox-output.yaml
  * base post-run playbooks/base/post-ssh.yaml
  * base post-run playbooks/base/post-logs.yaml

Simple Job Variant
==================

.. code:: yaml

  - job:
      name: tox-py27
      branches: stable/mitaka
      nodeset:
        - name: ubuntu-trusty
          label: ubuntu-trusty

Nodesets for Multi-node Jobs
============================

.. code:: yaml

  - nodeset:
      name: ceph-cluster
      nodes:
        - name: controller
          label: centos-7
        - name: compute1
          label: fedora-28
        - name: compute2
          label: fedora-28
      groups:
        - name: ceph-osd
          nodes:
            - controller
        - name: ceph-monitor
          nodes:
            - controller
            - compute1
            - compute2

Multi-node Job
==============

* nodesets are provided to Ansible for jobs in inventory

.. code:: yaml

  - job:
      name: ceph-multinode
      nodeset: ceph-cluster
      run: playbooks/install-ceph.yaml

Multi-node Ceph Job Content
===========================

.. code:: yaml

  - hosts: all
    roles:
      - install-ceph

  - hosts: ceph-osd
    roles:
      - start-ceph-osd

  - hosts: ceph-monitor
    roles:
      - start-ceph-monitor

  - hosts: all
    roles:
      - do-something-interesting

Projects
========

* Projects are git repositories
* Specify a set of jobs for each pipeline
* golang git repo naming as been adopted:

::

  zuul@ubuntu-xenial:~$ find /home/zuul/src -mindepth 3 -maxdepth 3 -type d
  /home/zuul/src/git.openstack.org/openstack-infra/shade
  /home/zuul/src/git.openstack.org/openstack/keystoneauth
  /home/zuul/src/git.openstack.org/openstack/os-client-config
  /home/zuul/src/github.com/ansible/ansible

Project Config
==============

 * Specify a set of jobs for each pipeline

.. code:: yaml

   - project:
       check:
         jobs:
           - openstack-tox-py27
           - openstack-tox-py35
           - openstack-tox-docs
       gate:
         jobs:
           - openstack-tox-py27
           - openstack-tox-py35
           - openstack-tox-docs

Project with Local Variant
==========================

.. code:: yaml

   - project:
       check:
         jobs:
           - openstack-tox-py27
           - openstack-tox-py35
           - openstack-tox-py36:
               voting: false
           - openstack-tox-docs
       gate:
         jobs:
           - openstack-tox-py27
           - openstack-tox-py35
           - openstack-tox-docs

Project with More Local Variants
================================

.. code:: yaml

   - project:
       check:
         jobs:
           - openstack-tox-py27
           - openstack-tox-py35
           - openstack-tox-py36:
               voting: false
           - openstack-tox-docs:
               files: '^docs/.*$'

Project with Many Local Variants
================================

.. code:: yaml

   - project:
       check:
         jobs:
           - openstack-tox-py27:
              nodeset:
                - name: centos-7
                  label: centos-7
           - openstack-tox-py27:
               branches: stable/newton
               nodeset:
                 - name: ubuntu-trusty
                   label: ubuntu-trusty
           - openstack-tox-py35
           - openstack-tox-py36:
               voting: false
           - openstack-tox-docs:
               files: '^docs/.*$'

Project With Central and Local Config
=====================================

.. code:: yaml

   # In git.openstack.org/openstack-infra/project-config:
   - project:
       name: openstack/nova
       templates:
         - openstack-tox-jobs

.. code:: yaml

   # In git.openstack.org/openstack/nova/.zuul.yaml:
   - project:
       check:
         - nova-placement-functional-devstack

Project with Job Dependencies
=============================

.. code:: yaml

    - project:
        release:
          jobs:
            - build-artifacts
            - upload-tarball:
                dependencies: build-artifacts
            - upload-pypi:
                dependencies: build-artifacts
            - notify-mirror:
                dependencies:
                  - upload-tarball
                  - upload-pypi

Playbooks
=========

* Jobs run playbooks
* Playbooks may be defined centrally or in the repo being tested
* Playbooks can use roles from current or other Zuul repos or Galaxy
* Playbooks are not allowed to execute content on 'localhost'

devstack-tempest Run Playbook
=============================

.. code:: yaml

    # Changes that run through devstack-tempest are likely to have an impact on
    # the devstack part of the job, so we keep devstack in the main play to
    # avoid zuul retrying on legitimate failures.
    - hosts: all
      roles:
        - run-devstack

    # We run tests only on one node, regardless how many nodes are in the system
    - hosts: tempest
      roles:
        - setup-tempest-run-dir
        - setup-tempest-data-dir
        - acl-devstack-files
        - run-tempest

Simple Shell Playbook
=====================

.. code:: yaml

  hosts: controller
  roles:
   - shell: |
       cd {{ zuul.project.src_dir }}
       ./run_tests.sh


Test Like Production
====================

If you use Ansible for deployment, your test and deployment processes
and playbooks are the same

What if you don't use Ansible?
==============================

OpenStack Infra Control Plane uses Puppet (for now)
===================================================

.. code:: yaml

    # In git.openstack.org/openstack-infra/project-config/roles/legacy-install-afs-with-puppet/tasks/main.yaml
    - name: Install puppet
      shell: ./install_puppet.sh
      args:
        chdir: "{{ ansible_user_dir }}/src/git.openstack.org/openstack-infra/system-config"
      environment:
        # Skip setting up pip, our images have already done this.
        SETUP_PIP: "false"
      become: yes

    - name: Copy manifest
      copy:
        src: manifest.pp
        dest: "{{ ansible_user_dir }}/manifest.pp"

    - name: Run puppet
      puppet:
        manifest: "{{ ansible_user_dir }}/manifest.pp"
      become: yes

Secrets
=======

* Inspired by Kubernetes Secrets API
* Projects can add named encrypted secrets to their .zuul.yaml file
* Jobs can request to use secrets by name
* Jobs using secrets are not reconfigured speculatively
* Secrets can only be used by the same project they are defined in
* Public key per project:
  ``{{ zuul_url }}/{{ tenant }}/{{ project }}.pub``

::
  GET https://zuul.openstack.org/openstack-infra/shade.pub

Secret Example (note, no admins had to enable this)
===================================================

.. code:: yaml

    # In git.openstack.org/openstack/loci/.zuul.yaml:
    - secret:
        name: loci_docker_login
        data:
          user: loci-username
          password: !encrypted/pkcs1-oaep
            - gUEX4eY3JAk/Xt7Evmf/hF7xr6HpNRXTibZjrKTbmI4QYHlzEBrBbHey27Pt/eYvKKeKw
              hk8MDQ4rNX7ZK1v+CKTilUfOf4AkKYbe6JFDd4z+zIZ2PAA7ZedO5FY/OnqrG7nhLvQHE
              5nQrYwmxRp4O8eU5qG1dSrM9X+bzri8UnsI7URjqmEsIvlUqtybQKB9qQXT4d6mOeaKGE
              5h6Ydkb9Zdi4Qh+GpCGDYwHZKu1mBgVK5M1G6NFMy1DYz+4NJNkTRe9J+0TmWhQ/KZSqo
              4ck0x7Tb0Nr7hQzV8SxlwkaCTLDzvbiqmsJPLmzXY2jry6QsaRCpthS01vnj47itoZ/7p
              taH9CoJ0Gl7AkaxsrDSVjWSjatTQpsy1ub2fuzWHH4ASJFCiu83Lb2xwYts++r8ZSn+mA
              hbEs0GzPI6dIWg0u7aUsRWMOB4A+6t2IOJibVYwmwkG8TjHRXxVCLH5sY+i3MR+NicR9T
              IZFdY/AyH6vt5uHLQDU35+5n91pUG3F2lyiY5aeMOvBL05p27GTMuixR5ZoHcvSoHHtCq
              7Wnk21iHqmv/UnEzqUfXZOque9YP386RBWkshrHd0x3OHUfBK/WrpivxvIGBzGwMr2qAj
              /AhJsfDXKBBbhGOGk1u5oBLjeC4SRnAcIVh1+RWzR4/cAhOuy2EcbzxaGb6VTM=

Secret Example
==============

.. code:: yaml

    # In git.openstack.org/openstack/loci/.zuul.yaml:
    - job:
        name: publish-loci-cinder
        parent: loci-cinder
        post-run: playbooks/push
        secrets:
          - loci_docker_login

    # In git.openstack.org/openstack/loci/playbooks/push.yaml:
    - hosts: all
      tasks:
        - include_vars: vars.yaml

    - name: Push project to DockerHub
      block:
        - command: docker login -u {{ loci_docker_login.user }} -p {{ loci_docker_login.password }}
          no_log: True
        - command: docker push openstackloci/{{ project }}:{{ branch }}-{{ item.name }}
          with_items: "{{ distros }}"

Important Links
===============

* https://zuul-ci.org/
* https://git.zuul-ci.org/cgit/zuul
* https://zuul-ci.org/docs/zuul
* https://zuul-ci.org/docs/zuul-jobs/
* https://docs.openstack.org/infra/openstack-zuul-jobs/
* freenode:#zuul

Coffee
======

I've been awake for many hours. Let's get a coffee?

Installation of Software
========================

Ways to Install Zuul
====================

* Windmill: http://git.openstack.org/cgit/openstack/windmill
* Software Factory: https://softwarefactory-project.io/
* Puppet: http://git.openstack.org/cgit/openstack-infra/puppet-zuul
* Containers: https://hub.docker.com/_/zuul/

Zuul Containers
===============

* Published on every commit
* Application/Process containers
* Built using tool 'pbrx'
* Config / Data should be bind-mounted in

Container Philosophy
====================

* As minimal as possible
* OS inside of container does not matter

zuul/zuul-executor
==================

* In k8s, zuul-executor must be run privileged
* Uses bubblewrap for unprivileged sanboxing
* Restriction may be lifted in the future

Release Management
==================

* Zuul is a CI system
* C stands for "Continuous"
* It is run Continuously Delivered and Deployed upstream
* Releases are tagged from code run upstream
* There is no intent to have a 'stable' release
* 'stable' is a synonym for "old and buggy"

zuul/zuul-scheduler
===================

* SPOF
* We're working on it
* Recommend running scheduler from tags

Demo Installation using docker-compose
======================================

Remember this?

* Install docker, docker-compose, git-review

Debian/Ubuntu:

::

  apt-get install docker-compose git git-review

Red Hat / SuSE

::

  yum install docker-compose git git-review

* git clone https://git.zuul-ci.org/zuul
* cd zuul
* git review -d 608344
* cd doc/source/admin/examples
* docker-compose up

What's Running
==============

* Zookeeper
* Gerrit
* Nodepool Launcher
* Zuul Scheduler
* Zuul Web Server
* Zuul Executor
* Apache HTTPD
* A container to use as a 'static' build node

How they're connected
=====================

* End Users talk to Gerrit and Apache HTTPD
* Zuul Scheduler talks to Gerrit
* Nodepool Launcher, Zuul Scheduler, Zuul Web talk to Zookeeper
* Zuul Executor talks to Zuul Scheduler (using Gearman)

Initial provided config
=======================

* docker-compose has plumbed in basic config ``etc_zuul/zuul.conf``
  and ``etc_zuul/main.yaml``
* Gerrit Connection named "gerrit"
* Zuul user for that connection
* Git connection named "zuul-ci.org" for ``zuul-jobs`` standard library

Initial tenant
==============

* Zuul is (always) multi-tenant
* Example config contains a tenant called ``example-tenant``
* Three projects in the ``example-tenant`` tenant:
  ``zuul-config``, ``test1``, ``test2``
* Three projects are also in gerrit ready to use

zuul.conf
=========

::

  [gearman]
  server=scheduler

  [gearman_server]
  start=true

  [zookeeper]
  hosts=zk

  [scheduler]
  tenant_config=/etc/zuul/main.yaml

  [web]
  listen_address=0.0.0.0

  [executor]
  private_key_file=/var/ssh/nodepool
  default_username=root

zuul.conf part 2
================

::

  [connection "gerrit"]
  name=gerrit
  driver=gerrit
  server=gerrit
  sshkey=/var/ssh/zuul
  user=zuul
  password=secret
  baseurl=http://gerrit:8080
  auth_type=basic

  [connection "zuul-ci.org"]
  name=zuul-ci
  driver=git
  baseurl=https://git.zuul-ci.org/

main.yaml
=========

::

  - tenant:
      name: example-tenant
      source:
        gerrit:
          config-projects:
            - zuul-config
          untrusted-projects:
            - test1
            - test2
        zuul-ci.org:
          untrusted-projects:
            - zuul-jobs:
                include:
                  - job

Gerrit Account
==============

* Need a user account to interact with Gerrit
* Gerrit is configured in dev mode - no passwords required
* Visit http://localhost:8080
* Click "Become"
* Click "New Account"
* Click "Register"
* Enter Full Name
* Click "Save Changes"
* Enter username in Username field (match your local laptop user)
* Copy ``~/.ssh/id_rsa.pub`` contents into SSH Key field
* Click Continue

Config Repo
===========

* ``zuul-config`` is a trusted ``config-repo``
* Security and functionality of system depend on this repo
* Limit its contents to minimum required

Config Files vs. Directories
============================

* Zuul reads config from:
  ``.zuul.yaml``, ``zuul.yaml``, ``zuul.d`` or ``.zuul.d``
* For projects with substantial zuul config, like ``zuul-config``
  ``zuul.d`` directory is likely best.
* The directories are read run-parts style.
* Recommended practice is splitting by type of object

Setting up Gating
=================

* We want to have changes to ``zuul-config`` be gated
* We need to define pipelines: ``check`` and ``gate``
* Need to attach ``zuul-config`` to them
* Start with builtin ``noop`` job (always return success)
* Use regex to attach all projects to ``check`` and ``gate``

Pipeline Definitions
====================

* Zuul has no built-in workflow definitions, let's add ``check`` and ``gate``

check pipeline
==============

::

  - pipeline:
      name: check
      description: |
        Newly uploaded patchsets enter this pipeline to receive an
        initial +/-1 Verified vote.
      manager: independent
      require:
        gerrit:
          open: True
          current-patchset: True
      trigger:
        gerrit:
          - event: patchset-created
          - event: change-restored
      success:
        gerrit:
          Verified: 1
      failure:
        gerrit:
          Verified: -1

gate pipeline
=============

:: 
    - pipeline:
        name: gate
        description: |
          Changes that have been approved are enqueued in order in this
          pipeline, and if they pass tests, will be merged.
        manager: dependent
        post-review: True
        require:
          gerrit:
            open: True
            current-patchset: True
            approval:
              - Workflow: 1
        trigger:
          gerrit:
            - event: comment-added
              approval:
                - Workflow: 1
        start:
          gerrit:
            Verified: 0
        success:
          gerrit:
            Verified: 2
            submit: true
        failure:
          gerrit:
            Verified: -2

Add the pipeline definitions
============================

.. code-block:: bash

  git clone http://localhost:8080/zuul-config
  cd zuul-config
  mkdir zuul.d
  cp ../examples/zuul-config/zuul.d/pipelines.yaml .

Shared Project Pipeline Definition
==================================

In ``examples/zuul-config/zuul.d/projects.yaml``

.. code-block:: yaml

  - project:
      name: ^.*$
      check:
        jobs: []
      gate:
        jobs: []

  - project:
      name: zuul-config
      check:
        jobs:
          - noop
      gate:
        jobs:
          - noop

Attach the projects to the pipelines
====================================

.. code-block:: bash

  cp ../examples/zuul-config/zuul.d/projects.yaml .

Commit the changes and push up for review
=========================================

.. code-block:: bash

   git add zuul.d
   git commit
   git review

Force merging bootstrap config
==============================

* Zuul is running with no config, so it won't do anything
* For this change (and this change only) we will bypass gating

Reviewing normally
==================

* visit http://localhost:8080/#/c/zuul-config/+/1001/
* click reply
* vote +2 Code Review +1 Approved

Verified +2 is Missing
======================

Verified +2 is what we have zuul configured to do.

::
        success:
          gerrit:
            Verified: 2
            submit: true


Bypassing Gating
================

* visit http://localhost:8080/
* click 'switch account'
* click 'admin'
* visit http://localhost:8080/#/c/zuul-config/+/1001/
* click reply
* vote +2 Verified (normal users do not see this)
* click submit (normal users do not see this)
* click 'switch account'
* click your username

Base Job
========

* Every Zuul installation must define a ``base`` job
* Push git repos to build node
* Publish logs/artifacts
* Any local specific setup
* Goes in config repo - because it impacts EVERY job

Add Base Job to zuul-config
===========================

::

  cp ../examples/zuul-config/zuul.d/jobs.yaml .
  git add jobs.yaml
  git commit
  git review

Then go to http://localhost:8080/#/c/zuul-config/+/1002/ and approve it

Zuul should merge the patch
===========================

zuul-config is configured to use the ``noop`` job

Zuul tests syntax automatically
===============================

* Edit jobs.yaml
* Change ``parent: null`` to ``parent: broken``
* git commit ; git review
* Check out the review in gerrit ... there should be errors!

Questions
=========

.. ansi:: images/questions.ans

Presentty
=========
.. hidetitle::
.. transition:: pan
.. figlet:: Presentty

* Console presentations written in reStructuredText
* Cross-fade, pan, tilt, cut transitions
* Figlet, cowsay!
* https://pypi.python.org/pypi/presentty