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

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

У вас может быть уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для её установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные зависимости. Подробнее см. Требования.

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

Новая в community.general 1.2.0

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

Описание

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

Требования

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

python-gitlab модуль python
requests (библиотека Python https://pypi.org/project/requests/)

Параметры

Параметр	Комментарии
api_job_token строка добавлено в community.general 4.2.0	Токен задания GitLab CI для входа.
api_oauth_token строка добавлено в community.general 4.2.0	Токен GitLab OAuth для входа.
api_password строка	Пароль для аутентификации с API.
api_token строка	Токен доступа GitLab с правами API.
api_url строка	Доступный конечный пункт для API.
api_username строка	Имя пользователя для аутентификации с API.
ca_path строка добавлено в community.general 8.1.0	Файл с сертификатами CA для проверки сертификата сервера GitLab.
group строка / обязательно	Путь и имя группы.
purge логическое значение	При установке в `true`, удаляются все переменные, которые не отмечены как неизмененные в задаче. Варианты: `false` ← (по умолчанию) `true`
state строка	Создание или удаление переменной группы. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs логическое значение	Проверка SSL-сертификатов при использовании конечной точки HTTPS. Варианты: `false` `true` ← (по умолчанию)
variables список / элементы=словарь добавлено в community.general 4.5.0	Список словарей, представляющих переменные CI/CD. Этот модуль работает внутренне с этой структурой, даже если используется более старый параметр `vars`. По умолчанию: `[]`
environment_scope строка	Область действия переменной. По умолчанию: `"*"`
masked логическое значение	Признак маскирования значения переменной. Варианты: `false` ← (по умолчанию) `true`
name строка / обязательно	Имя переменной.
protected логическое значение	Признак защиты значения переменной. Варианты: `false` ← (по умолчанию) `true`
raw логическое значение добавлено в community.general 7.4.0	Признак сырого значения переменной. Поддержка сырых значений требует GitLab >= 15.7. Варианты: `false` ← (по умолчанию) `true`
value строка	Значение переменной. Обязательно, когда `state=present`.
variable_type строка	Тип переменной: переменная среды (`env_var`) или файл (`file`). Варианты: `"env_var"` ← (по умолчанию) `"file"`

END_OF_DOCUMENT_MARKER

vars

словарь

Когда элемент списка представляет собой простую пару ключ-значение, значения masked, raw и protected будут установлены в false.

Когда элемент списка представляет собой словарь с ключами value, masked, raw и protected, пользователь может полностью контролировать, должно ли значение быть замаскированным, необработанным, защищённым или тем и другим.

Поддержка групповых переменных требует GitLab >= 9.5.

Поддержка параметра environment_scope требует GitLab Premium >= 13.11.

Поддержка защищённых значений требует GitLab >= 9.3.

Поддержка замаскированных значений требует GitLab >= 11.10.

Поддержка необработанных значений требует GitLab >= 15.7.

Значение value должно быть строкой или числом.

Поле variable_type должно быть строкой с env_var, что является значением по умолчанию, или file.

Если значение замаскировано, оно должно быть в Base64 и иметь длину не менее 8 символов. Смотрите документацию GitLab по допустимым значениям для замаскированной переменной (https://docs.gitlab.com/ce/ci/variables/#masked-variables).

Значение по умолчанию: {}

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз изменения состояния без изменения целевого объекта.
diff_mode	Поддержка: нет	Возвратит подробности о том, что изменилось (или, возможно, должно измениться в `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
    variables:
      - name: ACCESS_KEY_ID
        value: abc123
      - name: SECRET_ACCESS_KEY
        value: 3214cbad
        masked: true
        protected: true
        variable_type: env_var
        environment_scope: production

- name: Set or update some CI/CD variables with raw value
  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
        raw: true
        variable_type: env_var
        environment_scope: '*'

- name: Set or update some CI/CD variables with expandable value
  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: '$MY_OTHER_VARIABLE'
        masked: true
        protected: true
        raw: false
        variable_type: env_var
        environment_scope: '*'

- 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/gitlab_group_variable_module.html