community.general.gitlab_runner модуль — Создание, изменение и удаление GitLab Runners

Описание

• Регистрация, обновление и удаление исполнителей на сервере GitLab с помощью API GitLab.
• Все операции выполняются с использованием API GitLab v4.
• Для получения подробной информации см. полную документацию API по адресу https://docs.gitlab.com/ee/api/runners.html и https://docs.gitlab.com/ee/api/users.html#create-a-runner-linked-to-a-user.
• Для всех операций требуется действительный токен API с правами доступа. Вы можете создать любое количество таких токенов с помощью веб-интерфейса GitLab по адресу https://$GITLAB_URL/profile/personal_access_tokens.
• Для регистрации нового исполнителя требуется действительный токен регистрации. Чтобы создать общих исполнителей, попросите своего администратора предоставить вам этот токен. Его можно найти по адресу https://$GITLAB_URL/admin/runners/.
• Этот модуль не обрабатывает процесс gitlab-runner, а только управляет исполнителем на сервере GitLab через его API. После создания исполнителя модулем, вы можете использовать сгенерированный токен для выполнения команды gitlab-runner register

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

• python-gitlab >= 1.5.0 для устаревшего процесса регистрации исполнителя (токена регистрации исполнителя - https://docs.gitlab.com/runner/register/#register-with-a-runner-registration-token-deprecated)
• python-gitlab >= 4.0.0 для нового процесса регистрации исполнителя (токена аутентификации исполнителя - https://docs.gitlab.com/runner/register/#register-with-a-runner-authentication-token)
• requests (библиотека Python https://pypi.org/project/requests/)

Параметры

Атрибуты

Примечания

Примеры

- name: Create an instance-level runner
  community.general.gitlab_runner:
    api_url: https://gitlab.example.com/
    api_token: "{{ access_token }}"
    description: Docker Machine t1
    state: present
    active: true
    tag_list: ['docker']
    run_untagged: false
    locked: false
  register: runner # Register module output to run C(gitlab-runner register) command in another task

- name: Create a group-level runner
  community.general.gitlab_runner:
    api_url: https://gitlab.example.com/
    api_token: "{{ access_token }}"
    description: Docker Machine t1
    state: present
    active: true
    tag_list: ['docker']
    run_untagged: false
    locked: false
    group: top-level-group/subgroup
  register: runner # Register module output to run C(gitlab-runner register) command in another task

- name: Create a project-level runner
  community.general.gitlab_runner:
    api_url: https://gitlab.example.com/
    api_token: "{{ access_token }}"
    description: Docker Machine t1
    state: present
    active: true
    tag_list: ['docker']
    run_untagged: false
    locked: false
    project: top-level-group/subgroup/project
  register: runner # Register module output to run C(gitlab-runner register) command in another task

- name: "Register instance-level runner with registration token (deprecated)"
  community.general.gitlab_runner:
    api_url: https://gitlab.example.com/
    api_token: "{{ access_token }}"
    registration_token: 4gfdsg345
    description: Docker Machine t1
    state: present
    active: true
    tag_list: ['docker']
    run_untagged: false
    locked: false
  register: runner # Register module output to run C(gitlab-runner register) command in another task

- name: "Delete runner"
  community.general.gitlab_runner:
    api_url: https://gitlab.example.com/
    api_token: "{{ access_token }}"
    description: Docker Machine t1
    state: absent

- name: Delete an owned runner as a non-admin
  community.general.gitlab_runner:
    api_url: https://gitlab.example.com/
    api_token: "{{ access_token }}"
    description: Docker Machine t1
    owned: true
    state: absent

- name: "Register a project-level runner with registration token (deprecated)"
  community.general.gitlab_runner:
    api_url: https://gitlab.example.com/
    api_token: "{{ access_token }}"
    registration_token: 4gfdsg345
    description: MyProject runner
    state: present
    project: mygroup/mysubgroup/myproject
  register: runner # Register module output to run C(gitlab-runner register) command in another task

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для этого модуля: