community.general.gitlab_group_variable – Создаёт, обновляет или удаляет переменные GitLab-групп

Примечание

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

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

Для использования в книге задач укажите: community.general.gitlab_group_variable.

Новое в версии 1.2.0: из community.general

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

Описание

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

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_password строка		Пароль для аутентификации с API
api_token строка / обязательно		Токен доступа GitLab с API-разрешениями.
api_url строка		Резолвимый конечный пункт API
api_username строка		Имя пользователя для аутентификации с API
group строка / обязательно		Путь и имя группы.
purge логическое значение	Варианты: no ← yes	Если установлено в `true`, удалить все переменные, которые не отмечены как неизменные в задаче.
state строка	Варианты: present ← absent	Создать или удалить переменную группы.
validate_certs логическое значение	Варианты: no yes ←	Требовать валидацию 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).

Примечания

Примечание

Поддерживает режим проверки check_mode.

Примеры

- name: Set or update some CI/CD variables
  community.general.gitlab_group_variable:
    api_url: https://gitlab.com
    api_token: secret_access_token
    group: scodeman/testgroup/
    purge: false
    vars:
      ACCESS_KEY_ID: abc123
      SECRET_ACCESS_KEY: 321cba

- name: Set or update some CI/CD variables
  community.general.gitlab_group_variable:
    api_url: https://gitlab.com
    api_token: secret_access_token
    group: scodeman/testgroup/
    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_group_variable:
    api_url: https://gitlab.com
    api_token: secret_access_token
    group: scodeman/testgroup/
    state: absent
    vars:
      ACCESS_KEY_ID: abc123

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

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

Ключ		Возвращаемое значение	Описание
group_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']

Авторы

Florent Madiot (@scodeman)

© 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_group_variable_module.html