Skip to content

Peering Container documentation fix #193

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 14, 2020
Merged

Peering Container documentation fix #193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions website/docs/d/network_container.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wondering if the modifier should go be placed on the container rather than the region name, such as:

Suggested change
* `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

Suggested change
* `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.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Collaborator

@shum shum Apr 14, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

* `region` - The Atlas Azure region name for where this container will exist.
* `azure_subscription_id` - Unique identifer of the Azure subscription in which the VNet resides.
* `provisioned` - Indicates whether the project has Network Peering connections deployed in the container.
* `gcp_project_id` - Unique identifier of the GCP project in which the Network Peering connection resides.
Expand All @@ -57,4 +57,4 @@ In addition to all arguments above, the following attributes are exported:
* `vnet_name` - The name of the Azure VNet. This value is null until you provision an Azure VNet in the container.


See detailed information for arguments and attributes: [MongoDB API Network Peering Container](https://docs.atlas.mongodb.com/reference/api/vpc-create-container/)
See detailed information for arguments and attributes: [MongoDB API Network Peering Container](https://docs.atlas.mongodb.com/reference/api/vpc-create-container/)
6 changes: 3 additions & 3 deletions website/docs/d/network_containers.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,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 exists.
* `region` - The Atlas Azure region name for where this container exists.
* `azure_subscription_id` - Unique identifer of the Azure subscription in which the VNet resides.
* `provisioned` - Indicates whether the project has Network Peering connections deployed in the container.
* `gcp_project_id` - Unique identifier of the GCP project in which the Network Peering connection resides.
Expand All @@ -60,4 +60,4 @@ In addition to all arguments above, the following attributes are exported:
* `vnet_name` - The name of the Azure VNet. This value is null until you provision an Azure VNet in the container.


See detailed information for arguments and attributes: [MongoDB API Network Peering Container](https://docs.atlas.mongodb.com/reference/api/vpc-get-containers-list/)
See detailed information for arguments and attributes: [MongoDB API Network Peering Container](https://docs.atlas.mongodb.com/reference/api/vpc-get-containers-list/)
8 changes: 4 additions & 4 deletions website/docs/r/network_container.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ resource "mongodbatlas_network_container" "test" {
* `project_id` - (Required) The unique ID for the project to create the database user.
* `atlas_cidr_block` - (Required) 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` - (Optional) Cloud provider for this Network Peering connection. If omitted, Atlas sets this parameter to AWS.
* `region_name` - (Optional | AWS provider only) AWS region.
* `region` - (Optional | AZURE provider only) Azure region where the container resides.
* `region_name` - (Optional | AWS provider only) The Atlas AWS region name for where this container will exist.
* `region` - (Optional | AZURE provider only) The Atlas Azure region name for where this container will exist.


## Attributes Reference
Expand All @@ -69,8 +69,8 @@ In addition to all arguments above, the following attributes are exported:

* `container_id` - The Network Peering Container ID.
* `id` - The Terraform's unique identifier used internally for state management.
* `region_name` - AWS region.
* `region` - Azure region where the container resides.
* `region_name` - The Atlas AWS region name for where this container exists.
* `region` - The Atlas Azure region name for where this container exists.
* `azure_subscription_id` - Unique identifer of the Azure subscription in which the VNet resides.
* `provisioned` - Indicates whether the project has Network Peering connections deployed in the container.
* `gcp_project_id` - Unique identifier of the GCP project in which the Network Peering connection resides.
Expand Down