gitlab_project – Создаёт/обновляет/удаляет проекты GitLab
Описание
- Если проект не существует в 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 boolean |
| Включить или отключить возможность создания задач. Возможные значения: true и false. |
| login_password строка | Пароль GitLab для пользователя login_user | |
| login_user строка | Имя пользователя GitLab. | |
| merge_requests_enabled boolean |
| Разрешить или запретить создание запросов на слияние. Возможные значения: true и false. |
| name строка / обязательно | Название проекта | |
| path строка | Путь к проекту, который вы хотите создать, это будет server_url/<group>/path Если не указано, используется значение name. | |
| server_url строка | URL сервера GitLab с протоколом (например, http или https). | |
| snippets_enabled boolean |
| Включить или отключить возможность создания фрагментов кода. Возможные значения: true и false. |
| state строка |
| Создать или удалить проект. Возможные значения: present и absent. |
| validate_certs boolean |
| Проверять сертификаты SSL при использовании https. |
| visibility строка |
| Приватный. Доступ к проекту необходимо явно предоставить каждому пользователю. Внутренний. Любой авторизованный пользователь может клонировать проект. Публичный. Проект может быть клонирован без аутентификации. псевдонимы: visibility_level |
| wiki_enabled boolean |
| Включить или отключить вики-страницы для проекта. Возможные значения: 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 строка | failed | Сообщение об ошибке, возвращенное 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.9/modules/gitlab_project_module.html
