Модуль community.mongodb.mongodb_atlas_cluster – Управление кластерами баз данных в Atlas
Примечание
Этот модуль входит в коллекцию community.mongodb (версия 1.7.7).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.mongodb.
Для использования в playbook, укажите: community.mongodb.mongodb_atlas_cluster.
Обзор
- Модуль кластеров предоставляет доступ к конфигурациям вашего кластера.
- Модуль позволяет создавать, редактировать и удалять кластеры.
- Документация 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 aliases: replicationFactor integer | Количество членов реплицируемого набора. Каждый член сохраняет копию ваших баз данных, обеспечивая высокую доступность и избыточность данных. Варианты:
|
state string | Состояние ресурса. Варианты:
|
Примеры
- 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/mongodb/mongodb_atlas_cluster_module.html
