-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathJenkinsConfiguration.html
More file actions
873 lines (703 loc) · 71.1 KB
/
Copy pathJenkinsConfiguration.html
File metadata and controls
873 lines (703 loc) · 71.1 KB
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
<!DOCTYPE html>
<html lang="en" data-content_root="./" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Jenkins Configuration — MantidProject main documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=a95f357e85573c9b56d5" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=a95f357e85573c9b56d5" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="_static/css/style.css?v=562d7d41" />
<!-- So that users can add custom icons -->
<script defer src="_static/scripts/fontawesome.js?digest=a95f357e85573c9b56d5"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=a95f357e85573c9b56d5" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=a95f357e85573c9b56d5" />
<script src="_static/documentation_options.js?v=a8da1a53"></script>
<script src="_static/doctools.js?v=fd6eb6e6"></script>
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'JenkinsConfiguration';</script>
<script>DOCUMENTATION_OPTIONS.search_as_you_type = false;</script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Release Checklist" href="ReleaseChecklist.html" />
<link rel="prev" title="The Automated Build Process" href="AutomatedBuildProcess.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en">
<link rel="icon" sizes="32x32" href="_static/images/favicon.ico">
</head>
<body data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<dialog id="pst-search-dialog">
<form class="bd-search d-flex align-items-center"
action="search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</dialog>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header id="pst-header" class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class="col-lg-3 navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="index.html">
<img src="_static/images/mantid_logo_light.png" class="logo__image only-light" alt="Logo image">
<img src="_static/images/mantid_logo_dark.png" class="logo__image only-dark" alt="Logo image">
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item"><ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="https://download.mantidproject.org">Downloads</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org/nightly/tutorials/">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org">User Docs</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://developer.mantidproject.org">Develop</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org/release/">Release notes</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://www.mantidproject.org/contact">Contact Us</a>
</li>
</ul></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<div class="navbar-item">
<div class="theme-switch-container dropdown pst-js-only" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Color mode">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button dropdown-toggle" aria-label="Color mode" data-bs-toggle="dropdown">
<i class="theme-switch fa-solid fa-sun fa-lg fa-fw" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg fa-fw" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg fa-fw" data-mode="auto" title="System Settings"></i>
</button>
<ul class="dropdown-menu dropdown-menu-end">
<li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg fa-fw me-1"></i>System Settings</button></li>
<li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="light"><i class="fa-solid fa-sun fa-lg fa-fw me-1"></i>Light</button></li>
<li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="dark"><i class="fa-solid fa-moon fa-lg fa-fw me-1"></i>Dark</button></li>
</ul>
</div></div>
<div class="navbar-item"><ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
<li class="nav-item">
<a class="nav-link" href="https://github.com/mantidproject/mantid" rel="noopener" target="_blank" title="GitHub">
<span><i class="fab fa-github-square"></i></span>
<label class="sr-only">GitHub</label>
</a>
</li>
</ul></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
<span class="fa-solid fa-outdent"></span>
</button>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item"><ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="https://download.mantidproject.org">Downloads</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org/nightly/tutorials/">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org">User Docs</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://developer.mantidproject.org">Develop</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org/release/">Release notes</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://www.mantidproject.org/contact">Contact Us</a>
</li>
</ul></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<div class="theme-switch-container dropdown pst-js-only" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Color mode">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button dropdown-toggle" aria-label="Color mode" data-bs-toggle="dropdown">
<i class="theme-switch fa-solid fa-sun fa-lg fa-fw" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg fa-fw" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg fa-fw" data-mode="auto" title="System Settings"></i>
</button>
<ul class="dropdown-menu dropdown-menu-end">
<li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg fa-fw me-1"></i>System Settings</button></li>
<li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="light"><i class="fa-solid fa-sun fa-lg fa-fw me-1"></i>Light</button></li>
<li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="dark"><i class="fa-solid fa-moon fa-lg fa-fw me-1"></i>Dark</button></li>
</ul>
</div></div>
<div class="navbar-item"><ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
<li class="nav-item">
<a class="nav-link" href="https://github.com/mantidproject/mantid" rel="noopener" target="_blank" title="GitHub">
<span><i class="fab fa-github-square"></i></span>
<label class="sr-only">GitHub</label>
</a>
</li>
</ul></div>
</div>
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item pst-sidebar-collapse"><button id="pst-collapse-sidebar-button" aria-expanded="true" aria-controls="pst-primary-sidebar"><svg class="pst-icon svg-inline--fa" role="img" aria-hidden="true" focusable="false" viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg">
<path fill="currentColor" d="M3 15.5C2.36232 15.5 1.74874 15.2564 1.28478 14.8189C0.820828 14.3815 0.541576 13.7832 0.504167 13.1467L0.5 13L0.5 3C0.499965 2.36232 0.743605 1.74874 1.18107 1.28478C1.61854 0.820828 2.21676 0.541576 2.85333 0.504167L3 0.5L13 0.5C13.6377 0.499965 14.2513 0.743605 14.7152 1.18107C15.1792 1.61854 15.4584 2.21676 15.4958 2.85333L15.5 3L15.5 13C15.5 13.6377 15.2564 14.2513 14.8189 14.7152C14.3815 15.1792 13.7832 15.4584 13.1467 15.4958L13 15.5L3 15.5ZM3 13.8333L10.5 13.8333L10.5 2.16667L3 2.16667C2.79589 2.16669 2.59889 2.24163 2.44636 2.37726C2.29383 2.5129 2.19638 2.69979 2.1725 2.9025L2.16667 3L2.16667 13C2.16669 13.2041 2.24163 13.4011 2.37726 13.5536C2.5129 13.7062 2.69979 13.8036 2.9025 13.8275L3 13.8333ZM6.65583 10.325L6.5775 10.2558L4.91083 8.58917C4.76735 8.44567 4.68116 8.25476 4.66843 8.05223C4.65569 7.84971 4.71729 7.6495 4.84167 7.48917L4.91083 7.41083L6.5775 5.74417C6.72747 5.59471 6.9287 5.50794 7.14032 5.50148C7.35194 5.49502 7.55809 5.56935 7.7169 5.70937C7.8757 5.8494 7.97525 6.04463 7.99533 6.25539C8.01541 6.46616 7.95451 6.67667 7.825 6.84417L7.75583 6.9225L6.67917 8L7.75583 9.0775C7.89931 9.22099 7.98551 9.41191 7.99824 9.61443C8.01097 9.81695 7.94938 10.0172 7.825 10.1775L7.75583 10.2558C7.61234 10.3993 7.42142 10.4855 7.2189 10.4982C7.01638 10.511 6.81617 10.4494 6.65583 10.325Z"/>
</svg>
<span class="pst-collapse-sidebar-label">Collapse Sidebar</span>
<span class="pst-expand-sidebar-label">Expand Sidebar</span>
</button></div>
<div class="sidebar-primary-item">
<nav class="bd-docs-nav bd-links"
aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav"></div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div id="ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
</div></div>
</div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">
<li class="breadcrumb-item breadcrumb-home">
<a href="index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">Jenkins Configuration</span></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="jenkins-configuration">
<span id="jenkinsconfiguration"></span><h1>Jenkins Configuration<a class="headerlink" href="#jenkins-configuration" title="Link to this heading">#</a></h1>
<section id="summary">
<h2>Summary<a class="headerlink" href="#summary" title="Link to this heading">#</a></h2>
<p>Mantid uses the <a class="reference external" href="https://jenkins.io/">Jenkins</a> automation server to support
its continuous integration needs.
This document describes the general setup of the system.</p>
</section>
<section id="introduction">
<h2>Introduction<a class="headerlink" href="#introduction" title="Link to this heading">#</a></h2>
<p>Jenkins works on a ‘controller -> agent’ principle.
The controller is responsible for orchestrating jobs and managing the agents where the work is actually performed.
The controller node is located at <a class="reference external" href="https://builds.mantidproject.org">https://builds.mantidproject.org</a> and
each facility is responsible for providing hardware to act as agents for the various required configurations.</p>
</section>
<section id="setting-up-a-new-agent">
<h2>Setting up a New Agent<a class="headerlink" href="#setting-up-a-new-agent" title="Link to this heading">#</a></h2>
<section id="windows">
<h3>Windows<a class="headerlink" href="#windows" title="Link to this heading">#</a></h3>
<p>First install the prerequisites tools that cannot be provided through conda:</p>
<ol class="arabic simple">
<li><p>Install the <a class="reference external" href="https://visualstudio.microsoft.com/downloads/">Command line Visual C++ 2019 build tools</a>.
2019 matches the version used by conda-forge.
You may need to scroll to the botton and “click Older Downloads” to find it.
Once the installer has downloaded run it as administrator and select the
C++ workload.</p></li>
<li><p>Install <a class="reference external" href="https://git-scm.com/download/win">Git for Windows</a> using the
64-bit Standalone Installer. Once downloaded run it as administrator and
ensure the installation location is <code class="docutils literal notranslate"><span class="pre">C:\ProgramFiles\Git</span></code>.
When the installer has finished, open a PowerShell prompt as administrator
and run <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">config</span> <span class="pre">--system</span> <span class="pre">--get</span> <span class="pre">core.longpaths</span> <span class="pre">true</span></code> to configure
Git for long paths.</p></li>
<li><p>Configure long paths in the registry by running <code class="docutils literal notranslate"><span class="pre">regedit</span></code> from a
Powershell administrator prompt and setting the
<code class="docutils literal notranslate"><span class="pre">Computer\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem\LongPathsEnabled</span></code>
key to <code class="docutils literal notranslate"><span class="pre">1</span></code>.</p></li>
<li><p>Install Java from <a class="reference external" href="https://adoptium.net/en-GB/temurin/releases/?version=11">Adoptium</a>
Select <code class="docutils literal notranslate"><span class="pre">OS=Windows</span></code>, <code class="docutils literal notranslate"><span class="pre">Architecture=x64</span></code>, <cite>Package Type=JRE`</cite>, <code class="docutils literal notranslate"><span class="pre">Version=11</span></code>.
Install as administrator and add to that <code class="docutils literal notranslate"><span class="pre">PATH</span></code> for all users.</p></li>
<li><p>Reboot the machine</p></li>
</ol>
<section id="agent-connection">
<h4>Agent Connection<a class="headerlink" href="#agent-connection" title="Link to this heading">#</a></h4>
<p>To connect the agent to Jenkins you will need to login to the controller at
<a class="reference external" href="https://builds.mantidproject.org">https://builds.mantidproject.org</a>. Once logged in:</p>
<ol class="arabic simple">
<li><p>Click “New Node” at <a class="reference external" href="https://builds.mantidproject.org/computer/">https://builds.mantidproject.org/computer/</a>.</p></li>
<li><p>It is recommended to select “Copy Existing Node” and choose another Windows-based
agent.</p></li>
<li><p>Set the name to following the pattern <code class="docutils literal notranslate"><span class="pre">FACILITY-HOSTNAME</span></code>.</p></li>
<li><p>Edit the description to describe where the machine is located.</p></li>
<li><p>Edit the <code class="docutils literal notranslate"><span class="pre">win-64</span></code> label to <code class="docutils literal notranslate"><span class="pre">xwin-64</span></code> to avoid the node being added to the
pool straight away.</p></li>
<li><p>Under the “Environment variables” section at the bottom change the values to
match the node properties, e.g. build threads to match number of cores.</p></li>
<li><p>Click “Save” to be returned to the front page of the new node.</p></li>
<li><p>On the desktop of the node visit
<a class="reference external" href="https://builds.mantidproject.org/computer">https://builds.mantidproject.org/computer</a>/<node-name>/jenkins-agent.jnlp,
where <code class="docutils literal notranslate"><span class="pre"><node-name></span></code> is the name of the node when created above.
Take note of the download location for the next step.</p></li>
<li><p>Open PowerShell as an administrator and change directory to that noted in the
previous step. Run the agent file: <cite>.jenkins-agent.jnlp</cite>.</p></li>
<li><p>In the GUI that pops up a <code class="docutils literal notranslate"><span class="pre">File</span></code> menu will appear after a few seconds</p></li>
<li><p>Click <code class="docutils literal notranslate"><span class="pre">File->Install</span> <span class="pre">Service</span></code>.</p></li>
<li><p>Check back on the Jenkins agent description page and it should be connected.</p></li>
</ol>
</section>
<section id="connecting-through-a-proxy-server">
<h4>Connecting Through a Proxy Server<a class="headerlink" href="#connecting-through-a-proxy-server" title="Link to this heading">#</a></h4>
<p>It is a little more tricky to add Windows agents connected through a proxy.
To do this you must modify the Java arguments that are used to start the <code class="docutils literal notranslate"><span class="pre">jenkins-slave</span></code> process.
Once the “Install as a Windows Service” has completed you should:</p>
<ol class="arabic simple">
<li><p>Find the directory on the machine, such as <code class="docutils literal notranslate"><span class="pre">C:\Jenkins</span></code>, that was configured as the Jenkins filesystem root</p></li>
<li><p>Open the <code class="docutils literal notranslate"><span class="pre">jenkins-slave.xml</span></code> file</p></li>
<li><p>Edit the java arguments tag and add <code class="docutils literal notranslate"><span class="pre">-Dhttp.proxyHost=PROXYHOST</span> <span class="pre">-Dhttp.proxyPort=PROXYPORT</span></code> to the list</p></li>
<li><p>Save the file and restart the service (or machine)</p></li>
</ol>
</section>
</section>
<section id="linux">
<h3>Linux<a class="headerlink" href="#linux" title="Link to this heading">#</a></h3>
<p>Linux-based nodes should use the Docker-based setup described
<a class="reference external" href="https://github.com/mantidproject/dockerfiles/tree/main/jenkins-node">here</a>.
The base OS does not need to be RancherOS and can be anything as long as Docker
will run.</p>
<p>The agent will connect automatically when the Docker container starts running.</p>
</section>
<section id="mac-os">
<h3>Mac OS<a class="headerlink" href="#mac-os" title="Link to this heading">#</a></h3>
<p>Enable <a class="reference external" href="https://apple.stackexchange.com/a/73919">SSH (“Remote Login”) and VNC (“Remote Management”)</a>.
If you have connection issues from a non-OS X client then try adjusting your color
depth settings (True Color 32bpp works on Remmina).</p>
<p>In order to run the Qt tests, which require a connection to the windowing system,
the user that is running the Jenkins agent must be left logged in and the
automatic screen lock must be disabled.
This is most easily done by VNC - connect, log in, then disconnect.
If you see errors such as:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">_RegisterApplication</span><span class="p">(),</span> <span class="n">FAILED</span> <span class="n">TO</span> <span class="n">establish</span> <span class="n">the</span> <span class="n">default</span> <span class="n">connection</span> <span class="n">to</span> <span class="n">the</span> <span class="n">WindowServer</span><span class="p">,</span>
<span class="n">_CGSDefaultConnection</span><span class="p">()</span> <span class="ow">is</span> <span class="n">NULL</span><span class="o">.</span>
</pre></div>
</div>
<p>then no one is logged in to the system.</p>
<p>Disable saved application states that cause a dialog to be raised after a
program crash resulting in a test hanging waiting for a user to click ok on a dialog:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">defaults</span> <span class="n">write</span> <span class="n">org</span><span class="o">.</span><span class="n">python</span><span class="o">.</span><span class="n">python</span> <span class="n">NSQuitAlwaysKeepsWindows</span> <span class="o">-</span><span class="nb">bool</span> <span class="n">false</span>
<span class="n">defaults</span> <span class="n">write</span> <span class="n">org</span><span class="o">.</span><span class="n">mantidproject</span><span class="o">.</span><span class="n">MantidPlot</span> <span class="n">NSQuitAlwaysKeepsWindows</span> <span class="o">-</span><span class="nb">bool</span> <span class="n">false</span>
</pre></div>
</div>
<p>Finally, install Java 11 JRE from <a class="reference external" href="https://adoptium.net/temurin/releases/">https://adoptium.net/temurin/releases/</a> by selecting
<code class="docutils literal notranslate"><span class="pre">macOS</span></code>, <code class="docutils literal notranslate"><span class="pre">x64</span></code>, <code class="docutils literal notranslate"><span class="pre">JRE</span></code> and <code class="docutils literal notranslate"><span class="pre">11</span></code> for the respective options.
Download the <code class="docutils literal notranslate"><span class="pre">.pkg</span></code> and install following the instructions.</p>
<p>Restart the machine and ensure you leave the jenkins-agent user logged in as
per the instructions above.</p>
<section id="id1">
<h4>Agent Connection<a class="headerlink" href="#id1" title="Link to this heading">#</a></h4>
<p>The Jenkins JNLP connections are maintained by a crontab entry.
The script is in the <a class="reference external" href="https://github.com/mantidproject/mantid/blob/main/buildconfig/Jenkins/jenkins-slave.sh">mantid repository</a>.
The comments at the top describe a how to customize the script for a new agent.</p>
</section>
</section>
</section>
<section id="misc-groovy-scripts">
<h2>Misc Groovy Scripts<a class="headerlink" href="#misc-groovy-scripts" title="Link to this heading">#</a></h2>
<p>The following is a collection of groovy scripts that can be run either at <a class="reference external" href="https://builds.mantidproject.org/script">https://builds.mantidproject.org/script</a> (for master node) or on a given node, e.g <a class="reference external" href="https://builds.mantidproject.org/computer/isis-mantidlx3/script">isis-mantidx3</a>.
You must have admin privileges to run them.</p>
<p><a class="github reference external" href="https://github.com/jenkinsci/jenkins-scripts/tree/main/scriptler">jenkinsci/jenkins-scripts</a> was helpful for coming up with some of these.</p>
<section id="print-the-value-of-an-environment-variable-on-all-nodes">
<h3>Print the Value of an Environment Variable on All Nodes<a class="headerlink" href="#print-the-value-of-an-environment-variable-on-all-nodes" title="Link to this heading">#</a></h3>
<div class="highlight-groovy notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">jenkins.model.*</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">hudson.model.*</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">hudson.slaves.*</span>
<span class="n">VARIABLE_NAME</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"ENV_VARIABLE_NAME"</span>
<span class="n">nodes</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Jenkins</span><span class="o">.</span><span class="na">instance</span><span class="o">.</span><span class="na">getNodes</span><span class="o">()</span>
<span class="n">println</span><span class="o">(</span><span class="s2">"Displaying values of "</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">VARIABLE_NAME</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="s2">" on all nodes"</span><span class="o">)</span>
<span class="n">println</span><span class="o">()</span>
<span class="k">for</span><span class="o">(</span><span class="n">node</span><span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="n">nodes</span><span class="o">)</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="n">node_props</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">node</span><span class="o">.</span><span class="na">nodeProperties</span><span class="o">.</span><span class="na">getAll</span><span class="o">(</span><span class="n">hudson</span><span class="o">.</span><span class="na">slaves</span><span class="o">.</span><span class="na">EnvironmentVariablesNodeProperty</span><span class="o">.</span><span class="na">class</span><span class="o">)</span>
<span class="w"> </span><span class="k">if</span><span class="o">(</span><span class="n">node_props</span><span class="o">.</span><span class="na">size</span><span class="o">()</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="mi">1</span><span class="o">)</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="n">env_vars</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">node_props</span><span class="o">[</span><span class="mi">0</span><span class="o">].</span><span class="na">getEnvVars</span><span class="o">()</span>
<span class="w"> </span><span class="k">if</span><span class="o">(</span><span class="n">env_vars</span><span class="o">.</span><span class="na">containsKey</span><span class="o">(</span><span class="n">VARIABLE_NAME</span><span class="o">))</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="n">pv_dir</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">env_vars</span><span class="o">.</span><span class="na">get</span><span class="o">(</span><span class="n">VARIABLE_NAME</span><span class="o">,</span><span class="w"> </span><span class="s2">""</span><span class="o">)</span>
<span class="w"> </span><span class="o">}</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="n">pv_dir</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">VARIABLE_NAME</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="s2">" not set."</span>
<span class="w"> </span><span class="o">}</span>
<span class="w"> </span><span class="n">println</span><span class="o">(</span><span class="n">node</span><span class="o">.</span><span class="na">getDisplayName</span><span class="o">()</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="s2">": "</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">pv_dir</span><span class="o">)</span>
<span class="w"> </span><span class="o">}</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="n">pv_dir</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">VARIABLE_NAME</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="s2">" not set."</span>
<span class="w"> </span><span class="o">}</span>
<span class="o">}</span>
</pre></div>
</div>
</section>
<section id="remove-directories-across-multiple-nodes">
<h3>Remove directories across multiple nodes<a class="headerlink" href="#remove-directories-across-multiple-nodes" title="Link to this heading">#</a></h3>
<p>The example here will remove the build directories from pull request build and test jobs.
Useful, for example, when a dependency change requires a clean build.
It is advised to ensure nothing is running and pause the build queue.</p>
<div class="highlight-groovy notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">hudson.model.*</span>
<span class="n">nodes</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Jenkins</span><span class="o">.</span><span class="na">instance</span><span class="o">.</span><span class="na">slaves</span>
<span class="n">JOB_PREFIX</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"pull_requests-"</span>
<span class="n">suffixes</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">[</span><span class="s2">"conda-linux"</span><span class="o">,</span><span class="w"> </span><span class="s2">"conda-osx"</span><span class="o">,</span><span class="w"> </span><span class="s2">"conda-windows"</span><span class="o">];</span>
<span class="k">for</span><span class="w"> </span><span class="o">(</span><span class="n">node</span><span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="n">nodes</span><span class="o">)</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="o">(</span><span class="n">suffix</span><span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="n">suffixes</span><span class="o">)</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="n">FilePath</span><span class="w"> </span><span class="n">fp</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">node</span><span class="o">.</span><span class="na">createPath</span><span class="o">(</span><span class="n">node</span><span class="o">.</span><span class="na">getRootPath</span><span class="o">().</span><span class="na">toString</span><span class="o">()</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">File</span><span class="o">.</span><span class="na">separator</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="s2">"workspace"</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">File</span><span class="o">.</span><span class="na">separator</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">JOB_PREFIX</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">suffix</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">File</span><span class="o">.</span><span class="na">separator</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="s2">"build"</span><span class="o">);</span>
<span class="w"> </span><span class="k">if</span><span class="o">(</span><span class="n">fp</span><span class="o">!=</span><span class="kc">null</span><span class="w"> </span><span class="o">&&</span><span class="w"> </span><span class="n">fp</span><span class="o">.</span><span class="na">exists</span><span class="o">())</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="n">println</span><span class="o">(</span><span class="n">fp</span><span class="o">.</span><span class="na">toString</span><span class="o">())</span>
<span class="w"> </span><span class="n">fp</span><span class="o">.</span><span class="na">deleteRecursive</span><span class="o">()</span>
<span class="w"> </span><span class="o">}</span>
<span class="w"> </span><span class="o">}</span>
<span class="o">}</span>
</pre></div>
</div>
</section>
<section id="remove-pull-request-build-directories-from-specific-nodes">
<h3>Remove pull request build directories from specific nodes<a class="headerlink" href="#remove-pull-request-build-directories-from-specific-nodes" title="Link to this heading">#</a></h3>
<p>Take the target nodes offline and edit the list of agentNames.</p>
<div class="highlight-groovy notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">hudson.model.*</span>
<span class="c1">// Example: ["isis-win-1", "isis-win-2", "isis-win-3", "isis-linux-1", "isis-linux-5", "isis-linux-9", "isis-ndw2996mac"]</span>
<span class="n">agentNames</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">[</span><span class="s2">"agent-name-1"</span><span class="o">,</span><span class="w"> </span><span class="s2">"agent-name-2"</span><span class="o">,</span><span class="w"> </span><span class="o">...]</span>
<span class="n">JOB_PREFIX</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"pull_requests-"</span>
<span class="n">suffixes</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">[</span><span class="s2">"conda-linux"</span><span class="o">,</span><span class="w"> </span><span class="s2">"conda-osx"</span><span class="o">,</span><span class="w"> </span><span class="s2">"conda-windows"</span><span class="o">,</span><span class="w"> </span><span class="s2">"doc-tests"</span><span class="o">];</span>
<span class="n">DRY_RUN</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="w"> </span><span class="c1">// set to false to actually delete</span>
<span class="n">nodes</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Jenkins</span><span class="o">.</span><span class="na">instance</span><span class="o">.</span><span class="na">slaves</span>
<span class="k">for</span><span class="w"> </span><span class="o">(</span><span class="n">node</span><span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="n">nodes</span><span class="o">)</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="o">(</span><span class="n">agentName</span><span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="n">agentNames</span><span class="o">)</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="o">(</span><span class="n">node</span><span class="o">.</span><span class="na">name</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="n">agentName</span><span class="o">)</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="o">(</span><span class="n">suffix</span><span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="n">suffixes</span><span class="o">)</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="n">FilePath</span><span class="w"> </span><span class="n">fp</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">node</span><span class="o">.</span><span class="na">createPath</span><span class="o">(</span><span class="n">node</span><span class="o">.</span><span class="na">getRootPath</span><span class="o">().</span><span class="na">toString</span><span class="o">()</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">File</span><span class="o">.</span><span class="na">separator</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="s2">"workspace"</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">File</span><span class="o">.</span><span class="na">separator</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">JOB_PREFIX</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">suffix</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">File</span><span class="o">.</span><span class="na">separator</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="s2">"build"</span><span class="o">);</span>
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="o">(</span><span class="n">fp</span><span class="w"> </span><span class="o">!=</span><span class="w"> </span><span class="kc">null</span><span class="w"> </span><span class="o">&&</span><span class="w"> </span><span class="n">fp</span><span class="o">.</span><span class="na">exists</span><span class="o">())</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="n">println</span><span class="o">(</span><span class="s2">"Node: ${node.name}"</span><span class="o">)</span>
<span class="w"> </span><span class="n">println</span><span class="o">(</span><span class="s2">"Path: ${fp}"</span><span class="o">)</span>
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="o">(</span><span class="n">DRY_RUN</span><span class="o">)</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="n">println</span><span class="o">(</span><span class="s2">"DRY RUN: Would delete ${fp}\n"</span><span class="o">)</span>
<span class="w"> </span><span class="o">}</span>
<span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="n">println</span><span class="o">(</span><span class="s2">"Deleting ${fp}\n"</span><span class="o">)</span>
<span class="w"> </span><span class="n">fp</span><span class="o">.</span><span class="na">deleteRecursive</span><span class="o">()</span>
<span class="w"> </span><span class="o">}</span>
<span class="w"> </span><span class="o">}</span>
<span class="w"> </span><span class="o">}</span>
<span class="w"> </span><span class="o">}</span>
<span class="w"> </span><span class="o">}</span>
<span class="o">}</span>
</pre></div>
</div>
</section>
<section id="update-branches-for-jobs">
<h3>Update Branches For Jobs<a class="headerlink" href="#update-branches-for-jobs" title="Link to this heading">#</a></h3>
<div class="highlight-groovy notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">hudson.plugins.git.GitSCM</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">hudson.plugins.git.BranchSpec</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">static</span><span class="w"> </span><span class="n">com</span><span class="o">.</span><span class="na">google</span><span class="o">.</span><span class="na">common</span><span class="o">.</span><span class="na">collect</span><span class="o">.</span><span class="na">Lists</span><span class="o">.</span><span class="na">newArrayList</span><span class="o">;</span>
<span class="kt">def</span><span class="w"> </span><span class="n">NEW_BRANCH</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"*/release-next"</span>
<span class="c1">// Access to the Hudson Singleton</span>
<span class="kt">def</span><span class="w"> </span><span class="n">jenkins</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">jenkins</span><span class="o">.</span><span class="na">model</span><span class="o">.</span><span class="na">Jenkins</span><span class="o">.</span><span class="na">instance</span><span class="o">;</span>
<span class="c1">// Retrieve matching jobs</span>
<span class="kt">def</span><span class="w"> </span><span class="n">allItems</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">jenkins</span><span class="o">.</span><span class="na">items</span>
<span class="kt">def</span><span class="w"> </span><span class="n">chosenJobs</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">allItems</span><span class="o">.</span><span class="na">findAll</span><span class="o">{</span><span class="n">job</span><span class="w"> </span><span class="o">-></span><span class="w"> </span><span class="n">job</span><span class="o">.</span><span class="na">name</span><span class="w"> </span><span class="o">=-</span><span class="w"> </span><span class="s">/release_/</span><span class="o">};</span>
<span class="n">println</span><span class="w"> </span><span class="s2">"Updating branch for chosen jobs to $NEW_BRANCH"</span>
<span class="n">println</span><span class="w"> </span><span class="s2">""</span>
<span class="c1">// Do work</span>
<span class="n">chosenJobs</span><span class="o">.</span><span class="na">each</span><span class="w"> </span><span class="o">{</span><span class="w"> </span><span class="n">job</span><span class="w"> </span><span class="o">-></span>
<span class="w"> </span><span class="kt">def</span><span class="w"> </span><span class="n">scm</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">job</span><span class="o">.</span><span class="na">scm</span><span class="o">;</span>
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="o">(</span><span class="n">scm</span><span class="w"> </span><span class="k">instanceof</span><span class="w"> </span><span class="n">GitSCM</span><span class="w"> </span><span class="o">&&</span><span class="w"> </span><span class="n">job</span><span class="o">.</span><span class="na">name</span><span class="w"> </span><span class="o">!=</span><span class="w"> </span><span class="s2">"release_nightly_deploy"</span><span class="w"> </span><span class="o">)</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="c1">//def newScm = scm.clone()</span>
<span class="w"> </span><span class="n">println</span><span class="w"> </span><span class="s2">"Updating branch for "</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">job</span><span class="o">.</span><span class="na">name</span>
<span class="w"> </span><span class="n">scm</span><span class="o">.</span><span class="na">branches</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">newArrayList</span><span class="o">(</span><span class="k">new</span><span class="w"> </span><span class="n">BranchSpec</span><span class="o">(</span><span class="n">NEW_BRANCH</span><span class="o">))</span>
<span class="w"> </span><span class="n">println</span><span class="w"> </span><span class="s2">"Branch for "</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">job</span><span class="o">.</span><span class="na">name</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="s2">": "</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">scm</span><span class="o">.</span><span class="na">branches</span>
<span class="w"> </span><span class="n">println</span><span class="w"> </span><span class="s2">""</span>
<span class="w"> </span><span class="o">}</span>
<span class="o">}</span>
</pre></div>
</div>
</section>
<section id="list-all-scm-urls">
<h3>List All SCM Urls<a class="headerlink" href="#list-all-scm-urls" title="Link to this heading">#</a></h3>
<div class="highlight-groovy notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">jenkins.model.*</span><span class="o">;</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">hudson.model.*</span><span class="o">;</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">hudson.tasks.*</span><span class="o">;</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">hudson.plugins.git.*</span><span class="o">;</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">org.eclipse.jgit.transport.RemoteConfig</span><span class="o">;</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">org.eclipse.jgit.transport.URIish</span><span class="o">;</span>
<span class="k">for</span><span class="o">(</span><span class="n">project</span><span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="n">Hudson</span><span class="o">.</span><span class="na">instance</span><span class="o">.</span><span class="na">items</span><span class="o">)</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="k">try</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="n">scm</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">project</span><span class="o">.</span><span class="na">scm</span><span class="o">;</span>
<span class="w"> </span><span class="o">}</span><span class="w"> </span><span class="k">catch</span><span class="o">(</span><span class="n">Exception</span><span class="o">)</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="k">continue</span>
<span class="w"> </span><span class="o">}</span>
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="o">(</span><span class="n">scm</span><span class="w"> </span><span class="k">instanceof</span><span class="w"> </span><span class="n">hudson</span><span class="o">.</span><span class="na">plugins</span><span class="o">.</span><span class="na">git</span><span class="o">.</span><span class="na">GitSCM</span><span class="o">)</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="o">(</span><span class="n">RemoteConfig</span><span class="w"> </span><span class="n">cfg</span><span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="n">scm</span><span class="o">.</span><span class="na">getRepositories</span><span class="o">())</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="o">(</span><span class="n">URIish</span><span class="w"> </span><span class="n">uri</span><span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="n">cfg</span><span class="o">.</span><span class="na">getURIs</span><span class="o">())</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="n">println</span><span class="o">(</span><span class="s2">"SCM "</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">uri</span><span class="o">.</span><span class="na">toString</span><span class="o">()</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="s2">" for project "</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">project</span><span class="o">);</span>
<span class="w"> </span><span class="o">}</span>
<span class="w"> </span><span class="o">}</span>
<span class="w"> </span><span class="o">}</span>
<span class="o">}</span>
</pre></div>
</div>
</section>
<section id="update-urls-on-all-jobs">
<h3>Update Urls on All Jobs<a class="headerlink" href="#update-urls-on-all-jobs" title="Link to this heading">#</a></h3>
<div class="highlight-groovy notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">jenkins.model.*</span><span class="o">;</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">hudson.model.*</span><span class="o">;</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">hudson.tasks.*</span><span class="o">;</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">hudson.plugins.git.*</span><span class="o">;</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">org.eclipse.jgit.transport.RemoteConfig</span><span class="o">;</span>
<span class="kt">def</span><span class="w"> </span><span class="nf">modifyGitUrl</span><span class="o">(</span><span class="n">url</span><span class="o">)</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="k">if</span><span class="o">(</span><span class="n">url</span><span class="o">.</span><span class="na">startsWith</span><span class="o">(</span><span class="s1">'git://'</span><span class="o">))</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="s2">"https://"</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">url</span><span class="o">.</span><span class="na">substring</span><span class="o">(</span><span class="mi">6</span><span class="o">);</span>
<span class="w"> </span><span class="o">}</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">url</span><span class="o">;</span>
<span class="w"> </span><span class="o">}</span>
<span class="o">}</span>
<span class="k">for</span><span class="o">(</span><span class="n">project</span><span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="n">Hudson</span><span class="o">.</span><span class="na">instance</span><span class="o">.</span><span class="na">items</span><span class="o">)</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="k">try</span><span class="o">{</span>
<span class="w"> </span><span class="n">oldScm</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">project</span><span class="o">.</span><span class="na">scm</span><span class="o">;</span>
<span class="w"> </span><span class="o">}</span><span class="w"> </span><span class="k">catch</span><span class="o">(</span><span class="n">Exception</span><span class="o">)</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="k">continue</span>
<span class="w"> </span><span class="o">}</span>
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="o">(</span><span class="n">oldScm</span><span class="w"> </span><span class="k">instanceof</span><span class="w"> </span><span class="n">hudson</span><span class="o">.</span><span class="na">plugins</span><span class="o">.</span><span class="na">git</span><span class="o">.</span><span class="na">GitSCM</span><span class="o">)</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="kt">def</span><span class="w"> </span><span class="n">newUserRemoteConfigs</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">oldScm</span><span class="o">.</span><span class="na">userRemoteConfigs</span><span class="o">.</span><span class="na">collect</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="k">new</span><span class="w"> </span><span class="n">UserRemoteConfig</span><span class="o">(</span><span class="n">modifyGitUrl</span><span class="o">(</span><span class="n">it</span><span class="o">.</span><span class="na">url</span><span class="o">),</span><span class="w"> </span><span class="n">it</span><span class="o">.</span><span class="na">name</span><span class="o">,</span><span class="w"> </span><span class="n">it</span><span class="o">.</span><span class="na">refspec</span><span class="o">,</span><span class="w"> </span><span class="n">it</span><span class="o">.</span><span class="na">credentialsId</span><span class="o">)</span>
<span class="w"> </span><span class="o">}</span>
<span class="w"> </span><span class="kt">def</span><span class="w"> </span><span class="n">newScm</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">new</span><span class="w"> </span><span class="n">GitSCM</span><span class="o">(</span><span class="n">newUserRemoteConfigs</span><span class="o">,</span><span class="w"> </span><span class="n">oldScm</span><span class="o">.</span><span class="na">branches</span><span class="o">,</span><span class="w"> </span><span class="n">oldScm</span><span class="o">.</span><span class="na">doGenerateSubmoduleConfigurations</span><span class="o">,</span>
<span class="w"> </span><span class="n">oldScm</span><span class="o">.</span><span class="na">submoduleCfg</span><span class="o">,</span><span class="w"> </span><span class="n">oldScm</span><span class="o">.</span><span class="na">browser</span><span class="o">,</span><span class="w"> </span><span class="n">oldScm</span><span class="o">.</span><span class="na">gitTool</span><span class="o">,</span><span class="w"> </span><span class="n">oldScm</span><span class="o">.</span><span class="na">extensions</span><span class="o">)</span>
<span class="w"> </span><span class="n">project</span><span class="o">.</span><span class="na">scm</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">newScm</span><span class="o">;</span>
<span class="w"> </span><span class="n">project</span><span class="o">.</span><span class="na">save</span><span class="o">();</span>
<span class="w"> </span><span class="o">}</span>
<span class="o">}</span>
</pre></div>
</div>
</section>
<section id="print-all-loggers">
<h3>Print All Loggers<a class="headerlink" href="#print-all-loggers" title="Link to this heading">#</a></h3>
<div class="highlight-groovy notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">java.util.logging.*</span><span class="o">;</span>
<span class="n">LogManager</span><span class="o">.</span><span class="na">getLogManager</span><span class="o">().</span><span class="na">getLoggerNames</span><span class="o">().</span><span class="na">each</span><span class="o">()</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="n">println</span><span class="w"> </span><span class="s2">"${it}"</span><span class="o">;</span>
<span class="o">}</span>
</pre></div>
</div>
</section>
<section id="run-a-process-on-a-single-node">
<h3>Run a Process On a Single Node<a class="headerlink" href="#run-a-process-on-a-single-node" title="Link to this heading">#</a></h3>
<div class="highlight-groovy notranslate"><div class="highlight"><pre><span></span><span class="n">Process</span><span class="w"> </span><span class="n">p</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"cmd /c dir"</span><span class="o">.</span><span class="na">execute</span><span class="o">()</span>
<span class="n">println</span><span class="w"> </span><span class="s2">"${p.text}"</span>
<span class="c1">// kill process on windows slave</span>
<span class="n">Process</span><span class="w"> </span><span class="n">p</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"cmd /c Taskkill /F /IM MantidPlot.exe"</span><span class="o">.</span><span class="na">execute</span><span class="o">()</span>
<span class="n">println</span><span class="w"> </span><span class="s2">"${p.text}"</span>
</pre></div>
</div>
</section>
<section id="run-a-process-across-all-nodes">
<h3>Run a Process Across All Nodes<a class="headerlink" href="#run-a-process-across-all-nodes" title="Link to this heading">#</a></h3>
<div class="highlight-groovy notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">hudson.util.RemotingDiagnostics</span><span class="o">;</span>
<span class="k">for</span><span class="w"> </span><span class="o">(</span><span class="n">slave</span><span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="n">hudson</span><span class="o">.</span><span class="na">model</span><span class="o">.</span><span class="na">Hudson</span><span class="o">.</span><span class="na">instance</span><span class="o">.</span><span class="na">slaves</span><span class="o">)</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="n">println</span><span class="w"> </span><span class="n">slave</span><span class="o">.</span><span class="na">name</span><span class="o">;</span>
<span class="w"> </span><span class="c1">// is it connected?</span>
<span class="w"> </span><span class="k">if</span><span class="o">(</span><span class="n">slave</span><span class="o">.</span><span class="na">getChannel</span><span class="o">())</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="n">println</span><span class="w"> </span><span class="n">RemotingDiagnostics</span><span class="o">.</span><span class="na">executeGroovy</span><span class="o">(</span><span class="s2">"println \"ls\".execute().text"</span><span class="o">,</span><span class="w"> </span><span class="n">slave</span><span class="o">.</span><span class="na">getChannel</span><span class="o">());</span>
<span class="w"> </span><span class="o">}</span>
<span class="o">}</span>
</pre></div>
</div>
</section>
<section id="update-default-values-for-job-parameters">
<h3>Update default values for job parameters<a class="headerlink" href="#update-default-values-for-job-parameters" title="Link to this heading">#</a></h3>
<div class="highlight-groovy notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">hudson.model.*</span>
<span class="kt">def</span><span class="w"> </span><span class="n">SUFFIX_VARIABLE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"PACKAGE_SUFFIX"</span>
<span class="kt">def</span><span class="w"> </span><span class="n">NEW_SUFFIX</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"nightly"</span>
<span class="c1">// Access to the Hudson Singleton</span>
<span class="kt">def</span><span class="w"> </span><span class="n">jenkins</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">jenkins</span><span class="o">.</span><span class="na">model</span><span class="o">.</span><span class="na">Jenkins</span><span class="o">.</span><span class="na">instance</span><span class="o">;</span>
<span class="c1">// Retrieve matching jobs</span>
<span class="kt">def</span><span class="w"> </span><span class="n">chosenJobs</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">[</span><span class="s2">"release_clean-rhel7"</span><span class="o">]</span><span class="w"> </span><span class="c1">//, "release_clean-ubuntu-16.04", "release_clean-ubuntu"]</span>
<span class="n">println</span><span class="w"> </span><span class="s2">"Updating default package suffix for chosen jobs to ${NEW_SUFFIX}"</span>
<span class="n">println</span><span class="w"> </span><span class="s2">""</span>
<span class="c1">// Do work</span>
<span class="n">chosenJobs</span><span class="o">.</span><span class="na">each</span><span class="w"> </span><span class="o">{</span><span class="w"> </span><span class="n">jobName</span><span class="w"> </span><span class="o">-></span>
<span class="w"> </span><span class="n">job</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">jenkins</span><span class="o">.</span><span class="na">getItem</span><span class="o">(</span><span class="n">jobName</span><span class="o">)</span>
<span class="w"> </span><span class="n">println</span><span class="o">(</span><span class="n">job</span><span class="o">)</span>
<span class="w"> </span><span class="n">paramsDef</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">job</span><span class="o">.</span><span class="na">getAction</span><span class="o">(</span><span class="n">ParametersDefinitionProperty</span><span class="o">)</span>
<span class="w"> </span><span class="n">params</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">paramsDef</span><span class="o">.</span><span class="na">getParameterDefinitions</span><span class="o">()</span>
<span class="w"> </span><span class="n">params</span><span class="o">.</span><span class="na">each</span><span class="w"> </span><span class="o">{</span><span class="w"> </span><span class="n">it</span><span class="w"> </span><span class="o">-></span>
<span class="w"> </span><span class="k">if</span><span class="o">(</span><span class="n">it</span><span class="o">.</span><span class="na">getName</span><span class="o">()</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="n">SUFFIX_VARIABLE</span><span class="o">)</span><span class="w"> </span><span class="o">{</span>
<span class="w"> </span><span class="n">println</span><span class="o">(</span><span class="s2">"Updating default value of '${SUFFIX_VARIABLE}' variable to '${NEW_SUFFIX}'"</span><span class="o">)</span>
<span class="w"> </span><span class="n">it</span><span class="o">.</span><span class="na">setDefaultValue</span><span class="o">(</span><span class="n">NEW_SUFFIX</span><span class="o">)</span>
<span class="w"> </span><span class="o">}</span>
<span class="w"> </span><span class="o">}</span>
<span class="o">}</span>
</pre></div>
</div>
</section>
</section>
</section>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="left-prev"
href="AutomatedBuildProcess.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">The Automated Build Process</p>
</div>
</a>
<a class="right-next"
href="ReleaseChecklist.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Release Checklist</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div>
</footer>
</div>
<dialog id="pst-secondary-sidebar-modal"></dialog>
<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div
id="pst-page-navigation-heading-2"
class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> On this page
</div>
<nav id="pst-page-toc-nav" class="page-toc" aria-labelledby="pst-page-navigation-heading-2">
<ul class="pst-show_toc_level nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#summary">Summary</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#introduction">Introduction</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#setting-up-a-new-agent">Setting up a New Agent</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#windows">Windows</a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#agent-connection">Agent Connection</a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#connecting-through-a-proxy-server">Connecting Through a Proxy Server</a></li>
</ul>
</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#linux">Linux</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#mac-os">Mac OS</a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#id1">Agent Connection</a></li>
</ul>
</li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#misc-groovy-scripts">Misc Groovy Scripts</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#print-the-value-of-an-environment-variable-on-all-nodes">Print the Value of an Environment Variable on All Nodes</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#remove-directories-across-multiple-nodes">Remove directories across multiple nodes</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#remove-pull-request-build-directories-from-specific-nodes">Remove pull request build directories from specific nodes</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#update-branches-for-jobs">Update Branches For Jobs</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#list-all-scm-urls">List All SCM Urls</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#update-urls-on-all-jobs">Update Urls on All Jobs</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#print-all-loggers">Print All Loggers</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#run-a-process-on-a-single-node">Run a Process On a Single Node</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#run-a-process-across-all-nodes">Run a Process Across All Nodes</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#update-default-values-for-job-parameters">Update default values for job parameters</a></li>
</ul>
</li>
</ul>
</nav></div>
<div class="sidebar-secondary-item">
<div class="tocsection sourcelink">
<a href="_sources/JenkinsConfiguration.rst.txt">
<i class="fa-solid fa-file-lines"></i> Show Source
</a>
</div>
</div>
</div></div>
</div>
<footer class="bd-footer-content">
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="_static/scripts/bootstrap.js?digest=a95f357e85573c9b56d5"></script>
<script defer src="_static/scripts/pydata-sphinx-theme.js?digest=a95f357e85573c9b56d5"></script>
<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
<div class="footer-items__start">
<div class="footer-item">
<p class="copyright">
© Copyright 2007-2026, Mantid.
<br/>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
<br/>
</p>
</div>
</div>
<div class="footer-items__end">
<div class="footer-item">
<p class="theme-version">
<!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.19.0.
</p></div>
</div>
</div>
</footer>
</body>
</html>