Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Для использования в книге задач укажите: community.general.gitlab_group.

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

Описание

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

Требования

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

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

Параметры

Параметр

Комментарии

api_job_token

string

added in community.general 4.2.0

Токен задания GitLab CI для входа.

api_oauth_token

string

added in 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

added in community.general 3.7.0

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

Варианты:

  • false
  • true

avatar_path

path

added in community.general 4.2.0

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

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

ca_path

string

added in community.general 8.1.0

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

default_branch

string

added in community.general 9.5.0

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

description

string

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

enabled_git_access_protocol

string

added in community.general 9.5.0

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

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

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

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

Варианты:

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

force_delete

boolean

added in community.general 7.5.0

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

Используется только когда state=absent.

Варианты:

  • false ← (default)
  • true

lfs_enabled

boolean

added in community.general 9.5.0

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

Варианты:

  • false
  • true

lock_duo_features_enabled

boolean

added in community.general 9.5.0

Применить функции GitLab Duo ко всем подгруппам.

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

Варианты:

  • false
  • true

membership_lock

boolean

added in community.general 9.5.0

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

Варианты:

  • false
  • true

mentions_disabled

boolean

added in community.general 9.5.0

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

Варианты:

  • false
  • true

name

string / required

Имя группы, которую вы хотите создать.

parent

string

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

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

path

string

Путь к группе, которую вы хотите создать, это будет api_url/group_path

Если не указано, будет использоваться group_name.

prevent_forking_outside_group

boolean

added in community.general 9.5.0

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

Choices:

  • false
  • true

prevent_sharing_groups_outside_hierarchy

boolean

added in community.general 9.5.0

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

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

Choices:

  • false
  • true

project_creation_level

string

added in community.general 3.7.0

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

Choices:

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

request_access_enabled

boolean

added in community.general 9.5.0

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

Choices:

  • false
  • true

require_two_factor_authentication

boolean

added in community.general 3.7.0

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

Choices:

  • false
  • true

service_access_tokens_expiration_enforced

boolean

added in community.general 9.5.0

Срок действия токенов доступа сервисной учётной записи.

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

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

Choices:

  • false
  • true

share_with_group_lock

boolean

added in community.general 9.5.0

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

Choices:

  • false
  • true

state

string

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

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

Choices:

  • "present" ← (default)
  • "absent"

subgroup_creation_level

string

added in community.general 3.7.0

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

Choices:

  • "maintainer"
  • "owner"

two_factor_grace_period

string

added in community.general 9.5.0

Задержка принудительного использования 2FA (в часах).

validate_certs

boolean

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

Choices:

  • false
  • true ← (default)

visibility

string

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

Choices:

  • "private" ← (default)
  • "internal"
  • "public"

wiki_access_level

string

added in community.general 9.5.0

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

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

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

Choices:

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

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Support: full

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

diff_mode

Support: none

Будет возвращать подробную информацию о том, что изменилось (или, возможно, нуждается в изменении в check_mode), в режиме diff.

Примеры

- 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

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

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

Ключ

Описание

ошибка

строка

сообщение об ошибке, возвращаемое API GitLab

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

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

группа

словарь

объект API

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

сообщение

строка

сообщение об успехе или неудаче

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

Пример: "Success"

результат

словарь

разбор json ответа сервера

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

Авторы

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

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

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

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

Spec-Zone.ru

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