Модуль community.general.gitlab_instance_variable — создание, обновление и удаление переменных экземпляра GitLab

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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
requests (библиотека Python https://pypi.org/project/requests/)

Параметры

Параметр	Комментарии
api_job_token string добавлено в community.general 4.2.0	Токен задания GitLab CI для входа в систему.
api_oauth_token string добавлено в community.general 4.2.0	Токен OAuth GitLab для входа в систему.
api_password string	Пароль для аутентификации через API.
api_token string	Токен доступа GitLab с разрешениями API.
api_url string	Разрешаемая конечная точка API.
api_username string	Имя пользователя для аутентификации через API.
ca_path string добавлено в community.general 8.1.0	Пакет сертификатов CA для проверки сертификата сервера GitLab.
purge boolean	Если задано значение `true`, удаляются все переменные, не указанные в задании. Варианты: `false` ← (по умолчанию) `true`
state string	Создать или удалить переменную экземпляра. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs boolean	Проверять ли сертификаты SSL при указании конечной точки HTTPS. Варианты: `false` `true` ← (по умолчанию)
variables list / elements=dictionary	Список словарей, представляющих переменные CI/CD. По умолчанию: `[]`
description string добавлено в community.general 11.4.0	Описание переменной. Описания поддерживаются в GitLab версии 16.8 и выше.
masked boolean	Маскируется ли значение переменной. Варианты: `false` ← (по умолчанию) `true`
name string / обязательный	Имя переменной.
protected boolean	Защищено ли значение переменной. Варианты: `false` ← (по умолчанию) `true`
raw boolean добавлено в community.general 10.2.0	Обрабатывается ли значение переменной как необработанное. Поддержка необработанных значений доступна в GitLab версии 15.7 и выше. Варианты: `false` ← (по умолчанию) `true`
value string	Значение переменной. Обязательно, если `state=present`.
variable_type string	Тип переменной: переменная окружения (`env_var`) или файл (`file`). Варианты: `"env_var"` ← (по умолчанию) `"file"`

Атрибуты

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

Примеры

- 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 dictionary	Четыре списка имен переменных: добавленных, обновленных, удаленных или существующих. Возвращается: всегда
added list / elements=string	Список созданных переменных. Возвращается: всегда Пример: `["ACCESS_KEY_ID", "SECRET_ACCESS_KEY"]`
removed list / elements=string	Список удаленных переменных. Возвращается: всегда Пример: `["ACCESS_KEY_ID", "SECRET_ACCESS_KEY"]`
untouched list / elements=string	Список существующих переменных. Возвращается: всегда Пример: `["ACCESS_KEY_ID", "SECRET_ACCESS_KEY"]`
updated list / elements=string	Список существовавших ранее переменных, значения которых были заданы. Возвращается: всегда Пример: `["ACCESS_KEY_ID", "SECRET_ACCESS_KEY"]`

Авторы

Benedikt Braunger (@benibr)

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/gitlab_instance_variable_module.html