Skip to content

documentation fix #335 and examples added for the Azure VNET peering and AWS Private Link #340

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.

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 3 commits into from
Oct 21, 2020
Merged

Conversation

nikhil-mongo
Copy link
Collaborator

Description

Please include a summary of the fix/feature/change, including any relevant motivation and context.

Link to any related issue(s):

Type of change:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Documentation fix/enhancement

Required Checklist:

  • I have signed the MongoDB CLA
  • I have read the Terraform contribution guidelines
  • I have added tests that prove my fix is effective or that my feature works per HashiCorp requirments
  • I have added any necessary documentation (if appropriate)
  • I have run make fmt and formatted my code

Further comments

documentation fix #335 and examples added for the Azure VNET peering and AWS Private Link

@themantissa
Copy link
Collaborator

@nikhil-mongo I'll review this as is but in the future:

  1. PRs should be one topic at a time. Note how the submissions from DigitialOnUs are broken out. This allows one to keep code changes separate. This should be 3 PRs. One for each example, one for the doc fix.
  2. When a PR is ready request a review from me. If it's one we need more on I'll add other reviewers.

Copy link
Contributor

@leofigy leofigy left a comment

Choose a reason for hiding this comment

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

LGTM, please wait for Melissa's feedback

Copy link
Collaborator

@themantissa themantissa left a comment

Choose a reason for hiding this comment

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

@nikhil-mongo left a few non blocking comments for next time you submit a PR. A great start of examples and appreciated!

replication_factor = 3
provider_backup_enabled = true
auto_scaling_disk_gb_enabled = true
mongo_db_major_version = "4.2"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Just for next time we may want to start using 4.4 in examples.

}
output "plstring" {
value = lookup(mongodbatlas_cluster.cluster-atlas.connection_strings[0].aws_private_link_srv, aws_vpc_endpoint.ptfe_service.id)
}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Most linters will comment if you don't have a final newline, not blocking but fyi.

name_prefix = "default-"
description = "Default security group for all instances in ${aws_vpc.primary.id}"
vpc_id = aws_vpc.primary.id
ingress {
Copy link
Collaborator

Choose a reason for hiding this comment

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

I would lean towards providing more locked down examples or add a comment to be sure to narrow ranges, blocks, etc. Fine for now but if you'd like to submit a 2nd PR based on this input that would be fine. No rush.

@@ -0,0 +1,32 @@
variable "public_key" {
description = "The public API key for MongoDB Atlas"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Normally when I include any secrets I remind folks it's better to use a secret manager, etc and to be sure to git ignore any variables files in as many places as possible. Again not a blocker but a nice-to-do for, especially new, users

@@ -8,7 +8,7 @@ description: |-

# mongodbatlas_private_endpoint_link

`mongodbatlas_private_endpoint_link` describe a Private Endpoint Link. This represents a Private Endpoint Link Connection that wants to retrieve details in an Atlas project.
`mongodbatlas_private_endpoint_interface_link` describe a Private Endpoint Link. This represents a Private Endpoint Link Connection that wants to retrieve details in an Atlas project.
Copy link
Collaborator

Choose a reason for hiding this comment

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

lol I fixed the resource and missed the datasource! Nice catch, ty!

@themantissa themantissa merged commit 9092546 into mongodb:master Oct 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Typo in documentation
3 participants