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)

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

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:

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

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

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