community.general.gitlab_project_variable – Создаёт/обновляет/удаляет переменные проектов GitLab

Примечание

Этот плагин входит в коллекцию community.general (версия 1.3.2).

Для его установки используйте: ansible-galaxy collection install community.general.

Чтобы использовать его в книге задач, укажите: community.general.gitlab_project_variable.

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

Описание

Если переменная проекта не существует, она будет создана.
Если переменная проекта существует, её значение будет обновлено, если значения отличаются.
Переменные, которые не изменяются в книге задач, но не являются неизменёнными в проекте GitLab, останутся неизменёнными (purge — false) или будут удалены (purge — true).

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_password строка		Пароль для аутентификации по API.
api_token строка / обязательно		Токен доступа к GitLab с разрешениями API.
api_url строка		Доступный конечный пункт API.
api_username строка		Имя пользователя для аутентификации по API.
project строка / обязательно		Путь и имя проекта.
purge логическое	Варианты: нет ← да	При установке в значение `true` все переменные, которые не были изменены в задаче, будут удалены.
state строка	Варианты: present ← absent	Создание или удаление переменной проекта. Возможные значения — present и absent.
validate_certs логическое	Варианты: нет да ←	Выполнять ли проверку SSL-сертификатов при использовании https-адреса.
vars словарь	По умолчанию: {}	Если элемент списка — простая пара ключ-значение, значения masked и protected будут установлены в `false`. Если элемент списка — словарь с ключами value, masked и protected, пользователь может полностью управлять тем, будет ли значение скрыто, защищено или и то, и другое. Поддержка защищённых значений требует GitLab >= 9.3. Поддержка скрытых значений требует GitLab >= 11.10. Значение value должно быть строкой или числом. Поле variable_type должно быть строкой с одним из значений `env_var`, которое является значением по умолчанию, или `file`. Если значение скрыто, оно должно быть в Base64 и иметь длину не менее 8 символов. См. документацию GitLab по допустимым значениям для скрытой переменной (https://docs.gitlab.com/ce/ci/variables/#masked-variables).

Примеры

- name: Set or update some CI/CD variables
  community.general.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: Set or update some CI/CD variables
  community.general.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:
        value: 3214cbad
        masked: true
        protected: true
        variable_type: env_var

- name: Delete one variable
  community.general.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']

Авторы

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.10/collections/community/general/gitlab_project_variable_module.html