blob: e26c8af477b993c32d6167f96f5c017bfc2906c4 (
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
|
#######
Runners
#######
Runners are external processes used to run CI jobs. They are deployed by the
administrator and registered to the GitLab instance.
Shared runners are available for all projects. Specific runners are enabled for
a list of projects.
Global runners (admin)
======================
Reference
---------
* v4 API:
+ :class:`gitlab.v4.objects.Runner`
+ :class:`gitlab.v4.objects.RunnerManager`
+ :attr:`gitlab.Gitlab.runners`
* v3 API:
+ :class:`gitlab.v3.objects.Runner`
+ :class:`gitlab.v3.objects.RunnerManager`
+ :attr:`gitlab.Gitlab.runners`
* GitLab API: https://docs.gitlab.com/ce/api/runners.html
Examples
--------
Use the ``list()`` and ``all()`` methods to list runners.
Both methods accept a ``scope`` parameter to filter the list. Allowed values
for this parameter are:
* ``active``
* ``paused``
* ``online``
* ``specific`` (``all()`` only)
* ``shared`` (``all()`` only)
.. note::
The returned objects hold minimal information about the runners. Use the
``get()`` method to retrieve detail about a runner.
.. literalinclude:: runners.py
:start-after: # list
:end-before: # end list
Get a runner's detail:
.. literalinclude:: runners.py
:start-after: # get
:end-before: # end get
Update a runner:
.. literalinclude:: runners.py
:start-after: # update
:end-before: # end update
Remove a runner:
.. literalinclude:: runners.py
:start-after: # delete
:end-before: # end delete
Project runners
===============
Reference
---------
* v4 API:
+ :class:`gitlab.v4.objects.ProjectRunner`
+ :class:`gitlab.v4.objects.ProjectRunnerManager`
+ :attr:`gitlab.v4.objects.Project.runners`
* v3 API:
+ :class:`gitlab.v3.objects.ProjectRunner`
+ :class:`gitlab.v3.objects.ProjectRunnerManager`
+ :attr:`gitlab.v3.objects.Project.runners`
+ :attr:`gitlab.Gitlab.project_runners`
* GitLab API: https://docs.gitlab.com/ce/api/runners.html
Examples
--------
List the runners for a project:
.. literalinclude:: runners.py
:start-after: # project list
:end-before: # end project list
Enable a specific runner for a project:
.. literalinclude:: runners.py
:start-after: # project enable
:end-before: # end project enable
Disable a specific runner for a project:
.. literalinclude:: runners.py
:start-after: # project disable
:end-before: # end project disable
|
