Модуль community.general.gitlab_instance_variable – Создаёт, обновляет или удаляет переменные GitLab экземпляра

Примечание

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

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

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

Для использования в плейбуке укажите: community.general.gitlab_instance_variable.

Новое в community.general 7.1.0

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

Обзор

Создаёт переменную экземпляра, если она не существует.
Если переменная экземпляра уже существует, её значение будет обновлено, если значения отличаются.
Поддержка переменных экземпляра требует GitLab >= 13.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	Токен OAuth GitLab для входа.
api_password строка	Пароль для аутентификации по API.
api_token строка	Токен доступа GitLab с разрешениями API.
api_url строка	Доступный конечный пункт API.
api_username строка	Имя пользователя для аутентификации по API.
ca_path строка добавлен в community.general 8.1.0	Файл с сертификатами CA для проверки сертификата сервера GitLab.
purge логическое	При установке в значение `true`, удалить все переменные, не указанные в задании. Выбор: `false` ← (по умолчанию) `true`
state строка	Создать или удалить переменную экземпляра. Выбор: `"present"` ← (по умолчанию) `"absent"`
validate_certs логическое	Подтверждать ли SSL-сертификаты при указании конечной точки HTTPS. Выбор: `false` `true` ← (по умолчанию)
variables список / элементы=словарь	Список словарей, представляющих переменные CI/CD. По умолчанию: `[]`
masked логическое	Маскировать ли значение переменной. Выбор: `false` ← (по умолчанию) `true`
name строка / обязательно	Имя переменной.
protected логическое	Защищено ли значение переменной. Выбор: `false` ← (по умолчанию) `true`
value строка	Значение переменной. Требуется при `state=present`.
variable_type строка	Переменная является ли переменной среды (`env_var`) или файлом (`file`). Выбор: `"env_var"` ← (по умолчанию) `"file"`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз о внесённых изменениях без модификации целевого объекта.
diff_mode	Поддержка: отсутствует	Возвращает подробности о том, что изменилось (или, возможно, должно измениться в `check_mode`) при работе в режиме diff.

Примеры

- name: Set or update some CI/CD variables
  community.general.gitlab_instance_variable:
    api_url: https://gitlab.com
    api_token: secret_access_token
    purge: false
    variables:
      - name: ACCESS_KEY_ID
        value: abc1312cba
      - name: SECRET_ACCESS_KEY
        value: 1337
        masked: true
        protected: true
        variable_type: env_var

- name: Delete one variable
  community.general.gitlab_instance_variable:
    api_url: https://gitlab.com
    api_token: secret_access_token
    state: absent
    variables:
      - name: ACCESS_KEY_ID

Значения возврата

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

Ключ	Описание
instance_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"]`

Авторы

Benedikt Braunger (@benibr)

Ссылки на коллекцию

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