Ansible Community 文档

community.mongodb.mongodb_atlas_cluster 模块 – 在 Atlas 中管理数据库集群

注意

此模块是 community.mongodb 集合（版本 1.7.8）的一部分。

如果您正在使用 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.mongodb。

要在 playbook 中使用它，请指定：community.mongodb.mongodb_atlas_cluster。

概要 

集群模块提供对您的集群配置的访问。
该模块允许您创建、编辑和删除集群。
API 文档

参数 

参数	注释
api_password 别名：apiPassword 字符串 / 必需	用于与 Atlas API 进行身份验证的密码。可以使用 API 用户和令牌（私钥是密码）
api_username 别名：apiUsername 字符串 / 必需	用于与 Atlas API 进行身份验证的用户名。可以使用 API 用户和令牌（公钥是用户名）
auto_scaling 别名：autoScaling 字典	配置您的集群以自动缩放其存储和集群层。
disk_gb_enabled 别名：diskGBEnabled 布尔值	指定是否启用磁盘自动缩放。默认值为 true。选项 `false` `true`
cluster_type 别名：clusterType 字符串	您要创建的集群的类型。选项 `"REPLICASET"` ←（默认） `"SHARDED"`
disk_size_gb 别名：diskSizeGB 整数	主机根卷的容量，以千兆字节为单位。增加此数字以添加容量，最大可能值为 4096（即 4 TB）。此值必须是正整数。
group_id 别名：groupId 字符串 / 必需	Atlas 项目的唯一标识符。
mongo_db_major_version 别名：mongoDBMajorVersion 字符串	要部署的集群的版本。 Atlas 始终使用指定版本的最新稳定版本部署集群。修改集群时，您可以升级到较新版本的 MongoDB。选项 `"4.2"` `"4.4"` `"5.0"` `"6.0"` `"7.0"`
名称字符串 / 必需	集群在 Atlas 中显示的名称。创建集群后，其名称无法更改。
pit_enabled 别名：pitEnabled 布尔值	指示集群使用连续云备份的标志。选项 `false` `true`
provider_backup_enabled 别名：providerBackupEnabled 布尔值	指示集群是否使用云备份进行备份的标志。选项 `false` `true`
provider_settings 别名：providerSettings 字典 / 必需	MongoDB 运行所在的预配置服务器的配置。可用选项特定于云服务提供商。
instance_size_name 别名：instanceSizeName 字符串 / 必需	Atlas 提供不同的集群层，每个层都有默认的存储容量和 RAM 大小。您选择的集群用于集群层中的所有数据承载服务器。
provider_name 别名: providerName 字符串 / 必需	服务器配置所在的云服务提供商。
region_name 别名: regionName 字符串 / 必需	MongoDB 集群的物理位置。
replication_factor 别名: replicationFactor 整数	副本集成员的数量。每个成员都保留数据库的副本，提供高可用性和数据冗余。选项 `3` ← (默认) `5` `7`
state 字符串	资源的状态。选项 `"present"` ← (默认) `"absent"`

示例 

    - 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"
...

作者

Martin Schurz (@schurzi)

集合链接