Модуль community.mongodb.mongodb_atlas_user — Управление пользователями баз данных в Atlas

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.mongodb.

Чтобы использовать её в playbook, укажите: community.mongodb.mongodb_atlas_user.

Обзор
Параметры
Примеры

Обзор

Модуль mongodb_atlas_user позволяет создавать, изменять и удалять пользователей баз данных в вашем кластере.
Каждый пользователь имеет набор ролей, предоставляющих доступ к базам данных проекта.
Роли пользователя применяются ко всем кластерам в проекте.
Если у двух кластеров есть база данных «products», и у пользователя есть роль, предоставляющая доступ для чтения к базе данных «products»,
то у пользователя будет этот доступ к обеим базам данных.
Документация API

Параметры

Параметр	Комментарии
api_password псевдонимы: apiPassword строка / обязательно	Пароль для аутентификации с API Atlas. Можно использовать API-пользователей и токены (приватный ключ — пароль)
api_username псевдонимы: apiUsername строка / обязательно	Имя пользователя для аутентификации с API Atlas. Можно использовать API-пользователей и токены (открытый ключ — имя пользователя)
database_name псевдонимы: databaseName строка	База данных, для которой Atlas выполняет аутентификацию пользователя. Выбор: `"admin"` ← (по умолчанию) `"$external"`
group_id псевдонимы: groupId строка / обязательно	Уникальный идентификатор проекта Atlas.
password строка / обязательно	Пароль пользователя.
roles список / элементы=словарь / обязательно	Массив ролей пользователя и баз данных/коллекций, к которым эти роли применяются. Роль должна содержать следующие элементы
database_name псевдонимы: databaseName строка / обязательно	База данных, к которой пользователь имеет указанную роль. Роль в базе данных «admin» может включать привилегии, применяемые к другим базам данных.
role_name псевдонимы: roleName строка / обязательно	Название роли. Это значение может быть встроенной ролью или настраиваемой ролью.
scopes список / элементы=словарь	Список кластеров и Atlas Data Lakes, к которым может получить доступ этот пользователь. Atlas по умолчанию предоставляет пользователям баз данных доступ ко всем ресурсам. По умолчанию: `[]`
name строка / обязательно	Имя кластера или Atlas Data Lake, к которому может получить доступ пользователь базы данных.
type строка	Тип ресурса, к которому может получить доступ пользователь базы данных. Выбор: `"CLUSTER"` ← (по умолчанию) `"DATA_LAKE"`
state строка	Состояние ресурса. Выбор: `"present"` ← (по умолчанию) `"absent"`
username строка / обязательно	Имя пользователя для аутентификации с MongoDB.

Примеры

- name: test user
  community.mongodb.mongodb_atlas_user:
    api_username: "API_user"
    api_password: "API_passwort_or_token"
    group_id: "GROUP_ID"
    username: my_app_user
    password: SuperSecret!
    roles:
      - database_name: private_info
        role_name: read
      - database_name: public_info
        role_name: readWrite

Авторы

Martin Schurz (@schurzi)

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

© 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/mongodb/mongodb_atlas_user_module.html