Модуль community.general.gitlab_project_members — Управление участниками проектов на GitLab-сервере

Примечание

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

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

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

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

Новая функция в community.general 2.2.0

Описание
Требования
Параметры
Атрибуты
Примеры

Описание

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

Требования

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

Права владельца или администратора проекта на GitLab-сервере
Модуль python-gitlab python <= 1.15.0
requests (библиотека Python https://pypi.org/project/requests/)

Параметры

Параметр	Комментарии
access_level строка	Уровень доступа для пользователя. Требуется, если `state=present`, состояние пользователя установлено в present. Варианты: `"guest"` `"reporter"` `"developer"` `"maintainer"`
api_job_token строка добавлено в community.general 4.2.0	Токен задачи GitLab CI для входа.
api_oauth_token строка добавлено в community.general 4.2.0	Токен GitLab OAuth для входа.
api_password строка	Пароль для аутентификации по API.
api_token строка	Токен доступа GitLab с правами API.
api_url строка	Доступный адрес API.
api_username строка	Имя пользователя для аутентификации по API.
ca_path строка добавлено в community.general 8.1.0	Файл сертификатов CA для проверки сертификата сервера GitLab.
gitlab_user список / элементы=строка	Имя пользователя или список имён пользователей для добавления/удаления из проекта GitLab. Взаимоисключающее с `gitlab_users_access`.
gitlab_users_access список / элементы=словарь добавлено в community.general 3.7.0	Список сопоставлений пользователей с уровнями доступа. Каждый словарь в этом списке определяет пользователя (по имени пользователя) и уровень доступа, который должен иметь пользователь. Взаимоисключающее с `gitlab_user` и `access_level`. Используйте вместе с `purge_users` для удаления из проекта всех пользователей, не указанных здесь.
access_level строка / требуется	Уровень доступа для пользователя. Требуется, если `state=present`, состояние пользователя установлено в present. Варианты: `"guest"` `"reporter"` `"developer"` `"maintainer"`
name строка / требуется	Имя пользователя или список имён пользователей для добавления/удаления из проекта GitLab.
project строка / требуется	Имя (или полный путь) проекта GitLab, к которому добавляется/удаляется член.
purge_users список / элементы=строка добавлено в community.general 3.7.0	Добавляет/удаляет пользователей с заданным уровнем доступа, чтобы соответствовать заданному списку `gitlab_user`/`gitlab_users_access` . Если опущено, не очищать сирот. Используется только когда `state=present`. Варианты: `"guest"` `"reporter"` `"developer"` `"maintainer"`
state строка	Состояние участника в проекте. При `present`, добавляет пользователя в проект GitLab. При `absent`, удаляет пользователя из проекта GitLab. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs булево	Проверять ли SSL-сертификаты при указании HTTPS-адреса. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

- name: Add a user to a GitLab Project
  community.general.gitlab_project_members:
    api_url: 'https://gitlab.example.com'
    api_token: 'Your-Private-Token'
    validate_certs: true
    project: projectname
    gitlab_user: username
    access_level: developer
    state: present

- name: Remove a user from a GitLab project
  community.general.gitlab_project_members:
    api_url: 'https://gitlab.example.com'
    api_token: 'Your-Private-Token'
    project: projectname
    gitlab_user: username
    state: absent

- name: Add a list of Users to A GitLab project
  community.general.gitlab_project_members:
    api_url: 'https://gitlab.example.com'
    api_token: 'Your-Private-Token'
    gitlab_project: projectname
    gitlab_user:
      - user1
      - user2
    access_level: developer
    state: present

- name: Add a list of Users with Dedicated Access Levels to A GitLab project
  community.general.gitlab_project_members:
    api_url: 'https://gitlab.example.com'
    api_token: 'Your-Private-Token'
    project: projectname
    gitlab_users_access:
      - name: user1
        access_level: developer
      - name: user2
        access_level: maintainer
    state: present

- name: Add a user, remove all others which might be on this access level
  community.general.gitlab_project_members:
    api_url: 'https://gitlab.example.com'
    api_token: 'Your-Private-Token'
    project: projectname
    gitlab_user: username
    access_level: developer
    purge_users: developer
    state: present

- name: Remove a list of Users with Dedicated Access Levels to A GitLab project
  community.general.gitlab_project_members:
    api_url: 'https://gitlab.example.com'
    api_token: 'Your-Private-Token'
    project: projectname
    gitlab_users_access:
      - name: user1
        access_level: developer
      - name: user2
        access_level: maintainer
    state: absent

Авторы

Сергей Михалцов (@metanovii)
Зайнаб Альсаффар (@zanssa)

Ссылки на сборник

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