summaryrefslogtreecommitdiff
path: root/docs/gl_objects/runners.rst
diff options
context:
space:
mode:
authorNejc Habjan <hab.nejc@gmail.com>2021-12-01 01:04:53 +0100
committerGitHub <noreply@github.com>2021-12-01 01:04:53 +0100
commit8d76826fa64460e504acc5924f859f8dbc246b42 (patch)
tree083fefada982c795e2415092794db429abb0c184 /docs/gl_objects/runners.rst
parent5a1678f43184bd459132102cc13cf8426fe0449d (diff)
parent86ab04e54ea4175f10053decfad5086cda7aa024 (diff)
downloadgitlab-master.tar.gz
Merge pull request #1723 from python-gitlab/jlvillal/dead_mastermaster
Close-out `master` branch
Diffstat (limited to 'docs/gl_objects/runners.rst')
-rw-r--r--docs/gl_objects/runners.rst137
1 files changed, 0 insertions, 137 deletions
diff --git a/docs/gl_objects/runners.rst b/docs/gl_objects/runners.rst
deleted file mode 100644
index 1919975..0000000
--- a/docs/gl_objects/runners.rst
+++ /dev/null
@@ -1,137 +0,0 @@
-#######
-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`
-
-* 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.
-
-::
-
- # List owned runners
- runners = gl.runners.list()
- # With a filter
- runners = gl.runners.list(scope='active')
- # List all runners, using a filter
- runners = gl.runners.all(scope='paused')
-
-Get a runner's detail::
-
- runner = gl.runners.get(runner_id)
-
-Register a new runner::
-
- runner = gl.runners.create({'token': secret_token})
-
-Update a runner::
-
- runner = gl.runners.get(runner_id)
- runner.tag_list.append('new_tag')
- runner.save()
-
-Remove a runner::
-
- gl.runners.delete(runner_id)
- # or
- runner.delete()
-
-Verify a registered runner token::
-
- try:
- gl.runners.verify(runner_token)
- print("Valid token")
- except GitlabVerifyError:
- print("Invalid token")
-
-Project/Group runners
-=====================
-
-Reference
----------
-
-* v4 API:
-
- + :class:`gitlab.v4.objects.ProjectRunner`
- + :class:`gitlab.v4.objects.ProjectRunnerManager`
- + :attr:`gitlab.v4.objects.Project.runners`
- + :class:`gitlab.v4.objects.GroupRunner`
- + :class:`gitlab.v4.objects.GroupRunnerManager`
- + :attr:`gitlab.v4.objects.Group.runners`
-
-* GitLab API: https://docs.gitlab.com/ce/api/runners.html
-
-Examples
---------
-
-List the runners for a project::
-
- runners = project.runners.list()
-
-Enable a specific runner for a project::
-
- p_runner = project.runners.create({'runner_id': runner.id})
-
-Disable a specific runner for a project::
-
- project.runners.delete(runner.id)
-
-Runner jobs
-===========
-
-Reference
----------
-
-* v4 API:
-
- + :class:`gitlab.v4.objects.RunnerJob`
- + :class:`gitlab.v4.objects.RunnerJobManager`
- + :attr:`gitlab.v4.objects.Runner.jobs`
-
-* GitLab API: https://docs.gitlab.com/ce/api/runners.html
-
-Examples
---------
-
-List for jobs for a runner::
-
- jobs = runner.jobs.list()
-
-Filter the list using the jobs status::
-
- # status can be 'running', 'success', 'failed' or 'canceled'
- active_jobs = runner.jobs.list(status='running')