gitlab_project_variable – Создаёт/обновляет/удаляет переменные GitLab проектов
Новая в версии 2.9.
Описание
- Если переменная проекта не существует, она будет создана.
- Если переменная проекта существует, её значение будет обновлено, если значения отличаются.
- Переменные, которые не тронуты в playbook, но не являются нетронутыми в GitLab проекте, останутся нетронутыми (purge —
false) или будут удалены (purge —true).
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- python-gitlab python модуль <= 1.12.1
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_password строка | Пароль, используемый для аутентификации по API | |
| api_token строка / обязательно | Токен доступа GitLab с правами API. | |
| api_url строка | Доступный конечный пункт для API | |
| api_username строка | Имя пользователя, используемое для аутентификации по API | |
| project строка / обязательно | Путь и имя проекта. | |
| purge логическое значение |
| При установке в значение «да», все переменные, которые не нетронуты в задаче, будут удалены. |
| state строка |
| Создать или удалить переменную проекта. Возможные значения — present и absent. |
| validate_certs логическое значение |
| Требуется ли проверка SSL-сертификатов при указании https-конечного пункта. |
| vars словарь | Значение по умолчанию: {} | Список пар «ключ-значение». |
Примеры
- name: Set or update some CI/CD variables
gitlab_project_variable:
api_url: https://gitlab.com
api_token: secret_access_token
project: markuman/dotfiles
purge: false
vars:
ACCESS_KEY_ID: abc123
SECRET_ACCESS_KEY: 321cba
- name: Delete one variable
gitlab_project_variable:
api_url: https://gitlab.com
api_token: secret_access_token
project: markuman/dotfiles
state: absent
vars:
ACCESS_KEY_ID: abc123
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| project_variable словарь | всегда | Четыре списка имён переменных, которые были добавлены, обновлены, удалены или существуют. | |
| added список | всегда | Список переменных, которые были созданы. Пример: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY'] | |
| removed список | всегда | Список переменных, которые были удалены. Пример: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY'] | |
| untouched список | всегда | Список переменных, которые существуют. Пример: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY'] | |
| updated список | всегда | Список переменных, значения которых были изменены. Пример: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY'] | |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Markus Bergholz (@markuman)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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_variable_module.html
