Модуль community.mongodb.mongodb_atlas_cluster — управление кластерами баз данных в Atlas
Примечание
Этот модуль входит в коллекцию community.mongodb (версия 1.7.12).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.mongodb.
Чтобы использовать коллекцию в плейбуке, укажите: community.mongodb.mongodb_atlas_cluster.
Краткое описание
- Модуль clusters предоставляет доступ к конфигурациям кластеров.
- Модуль позволяет создавать, изменять и удалять кластеры.
- Документация API
Параметры
Параметр | Комментарии |
|---|---|
api_password псевдонимы: apiPassword строка / обязательный | Пароль для аутентификации в API Atlas. Можно использовать пользователей API и токены (закрытый ключ используется в качестве пароля) |
api_username псевдонимы: apiUsername строка / обязательный | Имя пользователя для аутентификации в API Atlas. Можно использовать пользователей API и токены (открытый ключ используется в качестве имени пользователя) |
auto_scaling псевдонимы: autoScaling словарь | Настройте автоматическое масштабирование хранилища и уровня кластера. |
|
disk_gb_enabled псевдонимы: diskGBEnabled логическое значение |
Указывает, включено ли автоматическое масштабирование диска. По умолчанию — true. Варианты:
|
cluster_type псевдонимы: clusterType строка | Тип создаваемого кластера. Варианты:
|
disk_size_gb псевдонимы: diskSizeGB целое число | Емкость корневого тома хоста в гигабайтах. Увеличьте это значение, чтобы увеличить емкость, максимум до 4096 (то есть 4 ТБ). Значение должно быть положительным целым числом. |
group_id псевдонимы: groupId строка / обязательный | Уникальный идентификатор проекта Atlas. |
mongo_db_major_version псевдонимы: mongoDBMajorVersion строка | Версия развертываемого кластера. Atlas всегда развертывает кластер с последним стабильным выпуском указанной версии. При изменении кластера можно выполнить обновление до более новой версии MongoDB. Варианты:
|
name строка / обязательный | Имя кластера, отображаемое в Atlas. После создания кластера его имя нельзя изменить. |
pit_enabled псевдонимы: pitEnabled логическое значение | Флаг, указывающий, что для кластера используются непрерывные облачные резервные копии. Варианты:
|
provider_backup_enabled псевдонимы: providerBackupEnabled логическое значение | Флаг, указывающий, используются ли для резервного копирования кластера Cloud Backups. Варианты:
|
provider_settings псевдонимы: providerSettings словарь / обязательный | Конфигурация серверов, на которых выполняется MongoDB. Доступные параметры зависят от поставщика облачных услуг. |
|
instance_size_name псевдонимы: instanceSizeName строка / обязательный |
Atlas предлагает кластеры разных уровней, каждый из которых имеет емкость хранилища и объем оперативной памяти по умолчанию. Выбранный уровень кластера применяется ко всем серверам с данными в вашем кластере. |
|
provider_name псевдонимы: providerName строка / обязательный |
Поставщик облачных услуг, у которого развернуты серверы. |
|
region_name псевдонимы: regionName строка / обязательный |
Физическое расположение кластера MongoDB. |
replication_factor псевдонимы: replicationFactor целое число | Количество участников набора реплик. Каждый участник хранит копию ваших баз данных, обеспечивая высокую доступность и избыточность данных. Варианты:
|
state строка | Состояние ресурса. Варианты:
|
Примеры
- name: test cluster
community.mongodb.mongodb_atlas_cluster:
api_username: "API_user"
api_password: "API_passwort_or_token"
group_id: "GROUP_ID"
name: "testcluster"
mongo_db_major_version: "4.0"
cluster_type: "REPLICASET"
provider_settings:
provider_name: "GCP"
region_name: "EUROPE_WEST_3"
instance_size_name: "M10"
...
Ссылки на коллекцию
© 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/mongodb/mongodb_atlas_cluster_module.html
