Spec-Zone.ru › Ansible

Модуль community.general.gitlab_group – создание, обновление и удаление групп GitLab

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.general.gitlab_group.

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

Краткое описание

  • Если группа отсутствует в GitLab, она создается.
  • Если группа существует и state=absent, она удаляется.

Требования

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

  • модуль 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.

auto_devops_enabled

boolean

добавлено в community.general 3.7.0

Использовать конвейер Auto DevOps по умолчанию для всех проектов в этой группе.

Варианты:

  • false
  • true

avatar_path

path

добавлено в community.general 4.2.0

Абсолютный путь к изображению для настройки аватара. Размер файла не должен превышать 200 КБ.

Этот параметр используется только при создании, но не при обновлении.

ca_path

string

добавлено в community.general 8.1.0

Пакет сертификатов CA для проверки сертификата сервера GitLab.

default_branch

string

добавлено в community.general 9.5.0

Все запросы на слияние и коммиты выполняются для этой ветки, если не указать другую.

description

string

Описание группы.

enabled_git_access_protocol

string

добавлено в community.general 9.5.0

all означает, что SSH и HTTP(S) включены.

ssh означает, что включен только SSH.

http означает, что включен только HTTP(S).

Доступно только для групп верхнего уровня.

Варианты:

  • "all"
  • "ssh"
  • "http"

force_delete

boolean

добавлено в community.general 7.5.0

Принудительно удалить группу, даже если в ней есть проекты.

Используется только при state=absent.

Варианты:

  • false ← (по умолчанию)
  • true

lfs_enabled

boolean

добавлено в community.general 9.5.0

Проекты в этой группе могут использовать Git LFS.

Варианты:

  • false
  • true

lock_duo_features_enabled

boolean

добавлено в community.general 9.5.0

Принудительно включить функции GitLab Duo для всех подгрупп.

Доступно только для групп верхнего уровня.

Варианты:

  • false
  • true

membership_lock

boolean

добавлено в community.general 9.5.0

Пользователей нельзя добавлять в проекты этой группы.

Варианты:

  • false
  • true

mentions_disabled

boolean

добавлено в community.general 9.5.0

Упоминания группы отключены.

Варианты:

  • false
  • true

name

string / обязательный

Имя создаваемой группы.

parent

string

Разрешить создание подгрупп.

Идентификатор или полный путь родительской группы в формате group/name.

path

string

Путь создаваемой группы: api_url/path.

Если не указано, используется name.

prevent_forking_outside_group

boolean

добавлено в community.general 9.5.0

Запретить создание форков за пределами группы.

Варианты:

  • false
  • true

prevent_sharing_groups_outside_hierarchy

boolean

добавлено в community.general 9.5.0

Участники не могут приглашать группы за пределами этой группы и ее подгрупп.

Доступно только для групп верхнего уровня.

Варианты:

  • false
  • true

project_creation_level

string

добавлено в community.general 3.7.0

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

Варианты:

  • "developer"
  • "maintainer"
  • "noone"

request_access_enabled

boolean

добавлено в community.general 9.5.0

Пользователи могут запрашивать доступ (если видимость задана как общедоступная или внутренняя).

Варианты:

  • false
  • true

require_two_factor_authentication

boolean

добавлено в community.general 3.7.0

Требовать, чтобы все пользователи этой группы настроили двухфакторную аутентификацию.

Варианты:

  • false
  • true

service_access_tokens_expiration_enforced

boolean

добавлено в community.general 9.5.0

Срок действия токенов учетных записей служб.

Изменения не влияют на уже заданные сроки действия токенов.

Доступно только для групп верхнего уровня.

Варианты:

  • false
  • true

share_with_group_lock

boolean

добавлено в community.general 9.5.0

Проекты нельзя предоставлять другим группам.

Варианты:

  • false
  • true

state

string

Создать или удалить группу.

Возможные значения: present и absent.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

subgroup_creation_level

string

добавлено в community.general 3.7.0

Разрешение на создание подгрупп.

Варианты:

  • "maintainer"
  • "owner"

two_factor_grace_period

string

добавлено в community.general 9.5.0

Отсрочка обязательного включения двухфакторной аутентификации (в часах).

validate_certs

boolean

Проверять ли сертификаты SSL при указании конечной точки HTTPS.

Варианты:

  • false
  • true ← (по умолчанию)

visibility

string

Видимость группы по умолчанию.

Варианты:

  • "private" ← (по умолчанию)
  • "internal"
  • "public"

wiki_access_level

string

добавлено в community.general 9.5.0

enabled означает, что доступ к вики есть у всех.

private означает, что доступ к вики есть только у участников этой группы.

disabled означает, что вики на уровне группы отключена.

Варианты:

  • "enabled"
  • "private"
  • "disabled"

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: full

Может работать в режиме check_mode и возвращать прогноз изменения состояния, не изменяя целевой объект.

diff_mode

Поддержка: none

В режиме diff возвращает сведения об изменениях (или о том, что, возможно, требуется изменить в check_mode).

Примеры

- name: "Delete GitLab Group"
  community.general.gitlab_group:
    api_url: https://gitlab.example.com/
    api_token: "{{ access_token }}"
    name: my_first_group
    state: absent

- name: "Create GitLab Group"
  community.general.gitlab_group:
    api_url: https://gitlab.example.com/
    validate_certs: true
    api_username: dj-wasabi
    api_password: "MySecretPassword"
    name: my_first_group
    path: my_first_group
    state: present

# The group will by created at https://gitlab.dj-wasabi.local/super_parent/parent/my_first_group
- name: "Create GitLab SubGroup"
  community.general.gitlab_group:
    api_url: https://gitlab.example.com/
    validate_certs: true
    api_username: dj-wasabi
    api_password: "MySecretPassword"
    name: my_first_group
    path: my_first_group
    state: present
    parent: "super_parent/parent"

# Other group which only allows sub-groups - no projects
- name: "Create GitLab Group for SubGroups only"
  community.general.gitlab_group:
    api_url: https://gitlab.example.com/
    validate_certs: true
    api_username: dj-wasabi
    api_password: "MySecretPassword"
    name: my_main_group
    path: my_main_group
    state: present
    project_creation_level: noone
    auto_devops_enabled: false
    subgroup_creation_level: maintainer

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

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

Ключ

Описание

error

string

Сообщение об ошибке, возвращенное API GitLab.

Возвращается: failed

Пример: "400: path is already in use"

group

dictionary

Объект API.

Возвращается: всегда

msg

string

Сообщение об успешном выполнении или ошибке.

Возвращается: всегда

Пример: "Success"

result

dictionary

Ответ сервера, разобранный как JSON.

Возвращается: всегда

Авторы

  • Werner Dijkerman (@dj-wasabi)
  • Guillaume Martinez (@Lunik)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Запросить помощь
  • Отправить отчет об ошибке
  • Предложить новую функцию
  • Связь

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API