summaryrefslogtreecommitdiff
path: root/src/zuulv3/zuul.rst
blob: b38675bafee6ad28fe30e6a99d815bd488897d19 (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
. 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

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


Ansible
=======
.. hidetitle::
.. ansi:: images/ansible.ans

Presentation Checklist
======================

::

   [X] Logos

Spoilers
========

* What Zuul v3 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)

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

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

Presentation Checklist
======================

::

  [x] Logos
  [x] Architecture diagram

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?)
  
Not just for OpenStack
======================

  * Zuul v3 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

Gating
======

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

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

.. cowsay:: 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
==================

.. cowsay:: 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.

Presentation Checklist
======================

::
   
  [x] Logos
  [x] Architecture diagram
  [x] Cows

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:
             - 'project-config'
           project-repos:
  	     - 'nova'
	     - 'keystone'
	     - '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

Pipelines
=========

* A process definition that connects git repositories, jobs, and
  reporting mechanisms.
* A context to fix a set of jobs to each project.
  
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

Job
===

.. code:: yaml

  - job:
      name: 'base'
      timeout: '30m'
      nodes: 'ubuntu-xenial'
      workspace: '/opt/workspace'
      pre-run:
        - 'setup-host'
      post-run:
        - 'archive-logs'

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

.. code:: yaml

  - job:
      name: 'python27'
      parent: 'base'

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

.. code:: yaml

  - job:
      name: 'python27'
      branch: 'stable/mitaka'
      nodes: 'ubuntu-trusty'
  
Multi-node Job
==============
.. container:: handout

   nodepool, shrews

.. code:: yaml

  - job:
      name: 'devstack-multinode'
      parent: 'base'
      nodes:
        - name: 'controller'
	  image: 'ubuntu-xenial'
        - name: 'compute'
	  image: 'ubuntu-xenial'

Projects
========

* Projects are git repositories
* Specify a set of jobs for each pipeline
  
Project
=======

.. code:: yaml

   - project:
       name: 'nova'
       check:
         jobs:
	   - python27
	   - python35
	   - docs

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

.. code:: yaml

   - project:
       name: 'nova'
       check:
         jobs:
	   - python27
	   - python35
	   - docs
	   - pypy:
  	       voting: false

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

.. code:: yaml

   - project:
       name: 'nova'
       check:
         jobs:
	   - python27
	   - python35
	   - docs:
	       files: '^docs/.*$'
	   - pypy:
	       voting: false

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

.. code:: yaml

   - project:
       name: 'nova'
       check:
         jobs:
	   - python27:
	       nodes: 'ubuntu-xenial'
	   - python27:
	       branch: 'stable/newton'
	       nodes: 'ubuntu-trusty'
	   - python35
	   - docs:
	       files: '^docs/.*$'
	   - pypy:
	       voting: false

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

.. code:: yaml

   - project:
       name: nova
       release:
         jobs:
	   - build-tarball:
	     jobs:
	       - upload-tarball:
	         jobs:
		   - update-mirror

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

Devstack-gate / Tempest Playbook
================================

.. code:: yaml

  # devstack-gate / tempest playbook
  ---
  hosts: all
  roles:
   - setup-multinode-networking
   - partition-swap
   - configure-mirrors
   - run-devstack
   - run-tempest

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

.. code:: yaml

  ---
  hosts: controller
  roles:
   - shell: |
       cd $WORKSPACE
       ./run_tests.sh


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

If you use Ansible for deployment, your test and deployment processes
and playbooks are the same
    
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

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