community.general.gitlab_project – Создаёт/обновляет/удаляет проекты GitLab
Примечание
Этот плагин является частью коллекции community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general
Для использования в книге задач укажите: community.general.gitlab_project
Описание
- Если проект не существует в GitLab, он будет создан.
- Если проект существует, и state=absent, проект будет удалён.
- Если в проекте внесены изменения, проект будет обновлён.
Требования
Ниже перечислены требования, необходимые на хосте, на котором будет выполняться этот модуль.
- python >= 2.7
- модуль python-gitlab
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_password строка | Пароль для аутентификации по API | |
| api_token строка | Токен GitLab для входа. | |
| api_url строка | Доступный адрес для API | |
| api_username строка | Имя пользователя для аутентификации по API | |
| description строка | Описание проекта. | |
| group строка | Идентификатор или полный путь группы, к которой принадлежит этот проект. | |
| import_url строка | Git-репозиторий, который будет импортирован в GitLab. Сервер GitLab должен иметь права на чтение этого Git-репозитория. | |
| issues_enabled логический тип |
| Включать ли создание задач. Возможные значения: истина и ложь. |
| merge_method строка добавлен в 1.0.0 community.general |
| Требования к слияниям. Возможные значения: merge, rebase_merge коммит слияния с полулинейной историей, ff только слияния с быстрым продвижением. |
| merge_requests_enabled логический тип |
| Включать ли создание запросов на слияние. Возможные значения: истина и ложь. |
| name строка / обязательно | Название проекта | |
| path строка | Путь проекта, который вы хотите создать, это будет server_url/<group>/path. Если не указано, используется имя. | |
| snippets_enabled логический тип |
| Включать ли возможность создания фрагментов. Возможные значения: истина и ложь. |
| state строка |
| создание или удаление проекта. Возможные значения: present и absent. |
| validate_certs логический тип |
| Включать или нет валидацию SSL-сертификатов при использовании https-адреса. |
| visibility строка |
| Приватный. Доступ к проекту должен быть предоставлен явно для каждого пользователя. Внутренний. Проект может быть клонирован любым авторизованным пользователем. Публичный. Проект может быть клонирован без авторизации. алиасы: visibility_level |
| wiki_enabled логический тип |
| Включать ли вики для этого проекта. Возможные значения: истина и ложь. |
Примеры
- name: Delete GitLab Project
community.general.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
community.general.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
merge_method: rebase_merge
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 с сервера. |
Авторы
- 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.10/collections/community/general/gitlab_project_module.html
