gitlab_project – Создаёт/обновляет/удаляет проекты Gitlab

Новая версия с 2.1.

Обзор
Требования
Параметры
Примеры
Возвращаемые значения
Статус

Обзор

Если проект не существует в Gitlab, он будет создан.
Если проект существует и state=absent, проект будет удалён.
При внесении изменений в проект, проект будет обновлён.

Требования

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

python >= 2.7
python-gitlab модуль python <= 1.12.1

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_password строка		Пароль для аутентификации по API
api_token строка		Токен Gitlab для входа. псевдонимы: login_token
api_url строка		Адрес API
api_username строка		Имя пользователя для аутентификации по API
description строка		Описание проекта.
group строка		Идентификатор или полное имя группы, к которой принадлежит этот проект.
import_url строка		Git репозиторий, который будет импортирован в Gitlab. Сервер Gitlab должен иметь доступ для чтения к этому Git репозиторию.
issues_enabled логическое	Варианты: нет да ←	Нужно ли создавать задачи? Возможные значения true и false.
login_password строка		Пароль Gitlab для логина
login_user строка		Имя пользователя Gitlab.
merge_requests_enabled логическое	Варианты: нет да ←	Разрешены ли запросы на слияние? Возможные значения true и false.
name строка / обязательно		Имя проекта
path строка		Путь проекта, который вы хотите создать, это будет server_url/<group>/path Если не указан, используется имя.
server_url строка		URL сервера GitLab с протоколом (например, http или https).
snippets_enabled логическое	Варианты: нет да ←	Должны ли быть доступны фрагменты? Возможные значения true и false.
state строка	Варианты: present ← absent	создание или удаление проекта. Возможные значения present и absent.
validate_certs логическое	Варианты: нет да ←	Нужно ли проверять SSL-сертификаты при указании https-адреса.
visibility строка	Варианты: private ← internal public	Приватный. Доступ к проекту должен быть явно предоставлен каждому пользователю. Внутренний. Проект может быть скопирован любым авторизованным пользователем. Публичный. Проект может быть скопирован без аутентификации. псевдонимы: visibility_level
wiki_enabled логическое	Варианты: нет да ←	Должна ли быть доступна вики для этого проекта? Возможные значения true и false.

Примеры

- name: Delete Gitlab Project
  gitlab_project:
    api_url: https://gitlab.example.com/
    api_token: "{{ access_token }}"
    validate_certs: False
    name: my_first_project
    state: absent
  delegate_to: localhost

- name: Create Gitlab Project in group Ansible
  gitlab_project:
    api_url: https://gitlab.example.com/
    validate_certs: True
    api_username: dj-wasabi
    api_password: "MySecretPassword"
    name: my_first_project
    group: ansible
    issues_enabled: False
    wiki_enabled: True
    snippets_enabled: True
    import_url: http://git.example.com/example/lab.git
    state: present
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
error строка	неудача	Сообщение об ошибке, возвращённое API Gitlab Пример: 400: путь уже используется
msg строка	всегда	Сообщение об успехе или неудаче Пример: Успешно
project словарь	всегда	Объект API
result словарь	всегда	Обработанный сервером ответ в формате json

Статус

Этот модуль не гарантирует обратную совместимость. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Werner Dijkerman (@dj-wasabi)
Guillaume Martinez (@Lunik)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/gitlab_project_module.html