Skip to content

Commit

Permalink
doc: Add references to the terraform modules in the resources documen…
Browse files Browse the repository at this point in the history
…tations (#2513)

* add references to the modules in the resources documentations

* fix pr comments
  • Loading branch information
rubenVB01 authored Aug 21, 2024
1 parent dfa3421 commit 3a0bb91
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/resources/encryption_at_rest.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
[Azure Key Vault](https://docs.atlas.mongodb.com/security-azure-kms/#security-azure-kms)
[Google Cloud KMS](https://docs.atlas.mongodb.com/security-gcp-kms/#security-gcp-kms)

The [encryption at rest Terraform module](https://registry.terraform.io/modules/terraform-mongodbatlas-modules/encryption-at-rest/mongodbatlas/latest) makes use of this resource and simplifies its use.

After configuring at least one Encryption at Rest provider for the Atlas project, Project Owners can enable Encryption at Rest for each Atlas cluster for which they require encryption. The Encryption at Rest provider does not have to match the cluster cloud service provider.

Atlas does not automatically rotate user-managed encryption keys. Defer to your preferred Encryption at Rest provider’s documentation and guidance for best practices on key rotation. Atlas automatically creates a 90-day key rotation alert when you configure Encryption at Rest using your Key Management in an Atlas project.
Expand Down
4 changes: 3 additions & 1 deletion docs/resources/privatelink_endpoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

`mongodbatlas_privatelink_endpoint` provides a Private Endpoint resource. This represents a [Private Endpoint Service](https://www.mongodb.com/docs/atlas/security-private-endpoint/#private-endpoint-concepts) that can be created in an Atlas project.

The [private link Terraform module](https://registry.terraform.io/modules/terraform-mongodbatlas-modules/private-endpoint/mongodbatlas/latest) makes use of this resource and simplifies its use.

~> **IMPORTANT:**You must have one of the following roles to successfully handle the resource:
* Organization Owner
* Project Owner
Expand Down Expand Up @@ -79,4 +81,4 @@ Private Endpoint Service can be imported using project ID, private link ID, prov
$ terraform import mongodbatlas_privatelink_endpoint.test 1112222b3bf99403840e8934-3242342343112-AWS-us-east-1
```

See detailed information for arguments and attributes: [MongoDB API Private Endpoint Service](https://docs.atlas.mongodb.com/reference/api/private-endpoints-service-create-one//)
See detailed information for arguments and attributes: [MongoDB API Private Endpoint Service](https://docs.atlas.mongodb.com/reference/api/private-endpoints-service-create-one/)
2 changes: 2 additions & 0 deletions docs/resources/privatelink_endpoint_service.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

`mongodbatlas_privatelink_endpoint_service` provides a Private Endpoint Interface Link resource. This represents a Private Endpoint Interface Link, which adds one [Interface Endpoint](https://www.mongodb.com/docs/atlas/security-private-endpoint/#private-endpoint-concepts) to a private endpoint connection in an Atlas project.

The [private link Terraform module](https://registry.terraform.io/modules/terraform-mongodbatlas-modules/private-endpoint/mongodbatlas/latest) makes use of this resource and simplifies its use.

~> **IMPORTANT:**You must have one of the following roles to successfully handle the resource:
* Organization Owner
* Project Owner
Expand Down
2 changes: 2 additions & 0 deletions docs/resources/push_based_log_export.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
`mongodbatlas_push_based_log_export` provides a resource for push-based log export feature. The resource lets you configure, enable & disable the project level settings for the push-based log export feature. Using this resource you
can continually push logs from mongod, mongos, and audit logs to an Amazon S3 bucket. Atlas exports logs every 5 minutes.

The [push based log export Terraform module](https://registry.terraform.io/modules/terraform-mongodbatlas-modules/push-based-log-export/mongodbatlas/latest) makes use of this resource and simplifies its use.


## Example Usages

Expand Down
2 changes: 2 additions & 0 deletions templates/resources/push_based_log_export.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
`{{.Name}}` provides a resource for push-based log export feature. The resource lets you configure, enable & disable the project level settings for the push-based log export feature. Using this resource you
can continually push logs from mongod, mongos, and audit logs to an Amazon S3 bucket. Atlas exports logs every 5 minutes.

The [push based log export Terraform module](https://registry.terraform.io/modules/terraform-mongodbatlas-modules/push-based-log-export/mongodbatlas/latest) makes use of this resource and simplifies its use.


## Example Usages

Expand Down

0 comments on commit 3a0bb91

Please sign in to comment.