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

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

OpenDev
=======

::

  "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


What Zuul Does
==============

  * gated changes
  * one or more git repositories
  * integrated deliverable
  * testing like deployment

Underlying Philosophy
=====================

  * All changes flow through code review
  * Changes only land if they pass all tests
  * Computers are cheaper than humans

Ramifications of Philosophy
===========================

  * No direct push access for anyone
  * Software should be installable from source
  * Testing should be automated and repeatable
  * Developers write tests with their patches
  * Code always works

Getting to Gating
=================

No Tests / Manual Tests
=======================

  * No test automation exists or ...
  * Developer runs test suite before pushing code
  * Prone to developer skipping tests for "trivial" changes
  * Doesn't scale organizationally

Periodic Testing
================

  * Developers push changes directly to shared branch
  * CI system runs tests from time to time - report if things still work
  * "Who broke the build?"
  * Leads to hacks like NVIE model

Post-Merge Testing
==================

  * Developers push changes directly to shared branch
  * CI system is triggered by push - reports if push broke something
  * Frequently batched / rolled up
  * Easier to diagnose which change broke things
  * Reactive - the bad changes are already in

Pre-Review Testing
==================

  * Changes are pushed to code review (Gerrit Change, GitHub PR, etc)
  * CI system is triggered by code review change creation
  * Test results inform review decisions
  * Proactive - testing code before it lands
  * Reviewers can get bored waiting for tests
  * Only tests code as written, not potential result of merging code

Gating
======

  * Changes are pushed to code review
  * CI system is triggered by code review approval
  * CI system merges code IFF tests pass
  * Proactive - testing code before it lands
  * Future state resulting from merge of code is tested
  * Reviewers can fire-and-forget safely

Mix and Match
=============

  * Zuul supports all of those modes
  * Zuul users frequently combine them
  * Run pre-review (check) and gating (gate) on each change
  * Post-merge/post-tag for release/publication automation
  * Periodic for catching bitrot

Multi-repository integration
============================

  * Multiple source repositories are needed for deliverable
  * Future state to be tested is the future state of all involved repos

To test proposed future state
=============================

  * Get tip of each project. Merge appropriate change. Test.
  * Changes must be serialized, otherwise state under test is invalid.
  * Integrated deliverable repos share serialized queue

Speculative Execution
=====================

  * Correct parallel processing of serialized future states
  * Create virtual serial queue of changes for each deliverable
  * Assume each change will pass its tests
  * Test successive changes with previous changes applied to starting state

Nearest Non-Failing Change
==========================

(aka 'The Jim Blair Algorithm')

  * If a change fails, move it aside
  * Cancel all test jobs behind it in the queue
  * Reparent queue items on the nearest non-failing change
  * Restart tests with new state

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

   * nodepool https://review.openstack.org/612168

       Make functional src jobs actually install from source
   * openstacksdk https://review.openstack.org/612186

       Don't start task managers passed in to Connection

       Depends-On: https://review.openstack.org/612168
   * openstacksdk https://review.openstack.org/604521

       Add support for per-service rate limits

       (git parent is 612186)
   * nodepool https://review.openstack.org/612169

       Consume rate limiting task manager from openstacksdk 

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

       (nodepool-functional-py35-src should pass, but
        nodepool-functional-py35 should not fail until openstacksdk release)

Lock Step Changes
=================

  * Circular Dependencies are not supported on purpose
  * Rolling upgrades across interdependent services
  * HOWEVER - many valid use cases - support will be coming

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

.. container:: handout

  Zuul is a distributed system, with a distributed configuration.

.. code:: yaml

   - tenant:
       name: openstack
       source:
         gerrit:
           config-repos:
             - opendev/project-config
           project-repos:
             - opendev/zuul-jobs
             - zuul/zuul
             - zuul/nodepool
             - ansible/ansible
             - openstack/openstacksdk

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")

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

.. ansi:: images/architecture.ans


Nodepool
========

  * A separate program that works very closely with *Zuul*
  * Creates and destroys zero or more node resources
  * Resources can include VMs, Containers, COE contexts or Bare Metals
  * Static driver for allocating pre-existing nodes to jobs
  * Optionally periodically builds images and uploads to clouds

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

  Where build nodes should come from

  * OpenStack
  * Static
  * Kubernetes

  In review:

  * OpenShift
  * AWS

  In work / coming soon:

  * Azure
  * GCE
  * Mac Stadium

What about test/job content?
============================

  * Written in Ansible
  * Ansible is excellent at running one or more tasks in one or more places
  * The answer to "how do I" is almost always "Ansible"

What Zuul Does
==============

  * 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

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
      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

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

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 }}"

OpenDev - Largest Known Zuul
====================================

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

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

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

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

  * BMW (control plane in OpenShift)
  * GoDaddy (control plane in Kubernetes)
  * Le Bon Coin
  * GoodMoney
  * Easystack
  * TungstenFabric
  * OpenLab
  * Red Hat
  * others ...

Code Review Systems
===================

  * Gerrit
  * GitHub (Public and Enterprise)

  In work / coming soon:

  * GitLab
  * Bitbucket

Support for non-git
===================

.. container:: progressive

  * Nope
  * helix4git may work for perforce, but is untested

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

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

* Containers: https://hub.docker.com/_/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

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

* Published on every commit
* Application/Process containers
* Config / Data should be bind-mounted in

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

Quick Start
===========

https://zuul-ci.org/docs/zuul/admin/quick-start.html

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/
* freenode:#zuul

Questions
=========

.. ansi:: images/questions.ans

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

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