From 3a0bb916cf46fb76eccff9b2a042c46c6f1a54a8 Mon Sep 17 00:00:00 2001 From: rubenVB01 <95967197+rubenVB01@users.noreply.github.com> Date: Wed, 21 Aug 2024 15:59:38 +0200 Subject: [PATCH] doc: Add references to the terraform modules in the resources documentations (#2513) * add references to the modules in the resources documentations * fix pr comments --- docs/resources/encryption_at_rest.md | 2 ++ docs/resources/privatelink_endpoint.md | 4 +++- docs/resources/privatelink_endpoint_service.md | 2 ++ docs/resources/push_based_log_export.md | 2 ++ templates/resources/push_based_log_export.md.tmpl | 2 ++ 5 files changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/resources/encryption_at_rest.md b/docs/resources/encryption_at_rest.md index ea85a74fa2..5ac02ddbe4 100644 --- a/docs/resources/encryption_at_rest.md +++ b/docs/resources/encryption_at_rest.md @@ -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. diff --git a/docs/resources/privatelink_endpoint.md b/docs/resources/privatelink_endpoint.md index 0b4eb81665..2753926b24 100644 --- a/docs/resources/privatelink_endpoint.md +++ b/docs/resources/privatelink_endpoint.md @@ -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 @@ -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//) \ No newline at end of file +See detailed information for arguments and attributes: [MongoDB API Private Endpoint Service](https://docs.atlas.mongodb.com/reference/api/private-endpoints-service-create-one/) diff --git a/docs/resources/privatelink_endpoint_service.md b/docs/resources/privatelink_endpoint_service.md index b22f42de3b..1427810101 100644 --- a/docs/resources/privatelink_endpoint_service.md +++ b/docs/resources/privatelink_endpoint_service.md @@ -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 diff --git a/docs/resources/push_based_log_export.md b/docs/resources/push_based_log_export.md index 5c2f5cb41a..a3ae1e863b 100644 --- a/docs/resources/push_based_log_export.md +++ b/docs/resources/push_based_log_export.md @@ -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 diff --git a/templates/resources/push_based_log_export.md.tmpl b/templates/resources/push_based_log_export.md.tmpl index aadfb9d954..53f17c8e32 100644 --- a/templates/resources/push_based_log_export.md.tmpl +++ b/templates/resources/push_based_log_export.md.tmpl @@ -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