Peering Container documentation fix #193
Conversation
Upstream Atlas API docs incorrect described these parameters. Fixing here and submitted a bug report upstream. Examples in both, however, are correct.
ghost
added
| @@ -47,8 +47,8 @@ In addition to all arguments above, the following attributes are exported: | |||
| * `id` - The Network Peering Container ID. | |||
| * `atlas_cidr_block` - CIDR block that Atlas uses for your clusters. Atlas uses the specified CIDR block for all other Network Peering connections created in the project. The Atlas CIDR block must be at least a /24 and at most a /21 in one of the following [private networks](https://tools.ietf.org/html/rfc1918.html#section-3). | |||
| * `provider_name` - Cloud provider for this Network Peering connection. If omitted, Atlas sets this parameter to AWS. | |||
| * `region_name` - AWS region. | |||
| * `region` - Azure region where the container resides. | |||
| * `region_name` - The Atlas AWS region name for where this container will exist. | |||
There was a problem hiding this comment.
Wondering if the modifier should go be placed on the container rather than the region name, such as:
| * `region_name` - The Atlas AWS region name for where this container will exist. | |
| * `region_name` - The AWS region name for where this Atlas container will exist. |
or
| * `region_name` - The Atlas AWS region name for where this container will exist. | |
| * `region_name` - The AWS region name for where Atlas' network peering container will exist. |
Since I'm not sure what the original confusion was caused by, also fine with "the Atlas AWS/Azure region name" pattern.
There was a problem hiding this comment.
So the actual Atlas doc is wrong, it's the Atlas region name that is needed, not the AWS region name. The examples are right the main Atlas API docs but not the text (DOCSP-9914 for fix) so was trying to clarify here as we had someone trying to use the AWS region name, which is slightly different, so it failed. Make more sense now?
There was a problem hiding this comment.
Oh got it, then your original suggestion is correct. "Atlas AWS/Azure region name" is a bit of a mouthful but I don't think we have anything better available.
LGTM.
There was a problem hiding this comment.
That's why I was open to suggestions - it's awkward to phrase. If docs had a better way I'll update this then. Thanks for the feedback/discussion!
Upstream Atlas API docs incorrect described these parameters. Fixing here and submitted a bug report upstream. Examples in both, however, are correct.