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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 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.
group string / обязательный	Путь и имя группы.
purge boolean	Если задано значение `true`, удаляются все переменные, не затронутые в задаче. Варианты: `false` ← (по умолчанию) `true`
state string	Создать или удалить переменную группы. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs boolean	Проверять ли сертификаты SSL при использовании конечной точки HTTPS. Варианты: `false` `true` ← (по умолчанию)
variables list / элементы=dictionary добавлен в community.general 4.5.0	Список словарей, представляющих переменные CI/CD. Внутри этот модуль работает с такой структурой, даже если используется устаревший параметр `vars`. По умолчанию: `[]`
description string добавлен в community.general 11.4.0	Описание переменной. Описания поддерживаются в GitLab версии 16.2 и выше.
environment_scope string	Область действия переменной. По умолчанию: `"*"`
hidden boolean добавлен в community.general 11.3.0	Определяет, скрыто ли значение переменной. Подразумевает `masked`. Скрытые значения поддерживаются в GitLab версии 17.4 и выше. Варианты: `false` ← (по умолчанию) `true`
masked boolean	Определяет, маскируется ли значение переменной. Варианты: `false` ← (по умолчанию) `true`
name string / обязательный	Имя переменной.
protected boolean	Определяет, защищено ли значение переменной. Варианты: `false` ← (по умолчанию) `true`
raw boolean добавлен в community.general 7.4.0	Определяет, является ли значение переменной необработанным. Необработанные значения поддерживаются в GitLab версии 15.7 и выше. Варианты: `false` ← (по умолчанию) `true`
value string	Значение переменной. Обязательно, если `state=present`.
variable_type string	Определяет, является ли переменная переменной окружения (`env_var`) или файлом (`file`). Варианты: `"env_var"` ← (по умолчанию) `"file"`
vars dictionary	Если элемент списка является простой парой ключ-значение, для `masked`, `hidden`, `raw` и `protected` задаётся значение `false`. Если элемент списка — словарь с ключами `value`, `masked`, `hidden`, `raw` и `protected`, пользователь может полностью управлять тем, следует ли маскировать или скрывать значение, обрабатывать его как необработанное, защищать его или сочетать эти параметры. Переменные групп поддерживаются в GitLab версии 9.5 и выше. Параметр environment_scope поддерживается в GitLab Premium версии 13.11 и выше. Защищённые значения поддерживаются в GitLab версии 9.3 и выше. Маскируемые значения поддерживаются в GitLab версии 11.10 и выше. Скрытые значения поддерживаются в GitLab версии 17.4 и выше; эта возможность добавлена в community.general 11.3.0. Необработанные значения поддерживаются в 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 dictionary	Четыре списка имён переменных: добавленных, обновлённых, удалённых или существующих. Возвращается: всегда
added list / элементы=string	Список созданных переменных. Возвращается: всегда Пример: `["ACCESS_KEY_ID", "SECRET_ACCESS_KEY"]`
removed list / элементы=string	Список удалённых переменных. Возвращается: всегда Пример: `["ACCESS_KEY_ID", "SECRET_ACCESS_KEY"]`
untouched list / элементы=string	Список существующих переменных. Возвращается: всегда Пример: `["ACCESS_KEY_ID", "SECRET_ACCESS_KEY"]`
updated list / элементы=string	Список переменных, значения которых были изменены. Возвращается: всегда Пример: `["ACCESS_KEY_ID", "SECRET_ACCESS_KEY"]`

Авторы

Florent Madiot (@scodeman)

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

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