New Resource : `azurerm_mongo_cluster` #27636

sinbai · 2024-10-12T08:24:26Z

Community Note

Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
Please do not leave comments along the lines of "+1", "me too" or "any updates", they generate extra noise for PR followers and do not help prioritize for review

Description

New resource azurerm_mongo_cluster.

Swagger:https://github.com/Azure/azure-rest-api-specs/blob/15b16d1b5c3cccdecdd1cfe936f6a8005680c557/specification/mongocluster/resource-manager/Microsoft.DocumentDB/stable/2024-07-01/mongoCluster.json#L279

PR Checklist

I have followed the guidelines in our Contributing Documentation.
I have checked to ensure there aren't other open Pull Requests for the same update/change.
I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.
For example: “resource_name_here - description of change e.g. adding property new_property_name_here”

Changes to existing Resource / Data Source

I have added an explanation of what my changes do and why I'd like you to include them (This may be covered by linking to an issue above, but may benefit from additional explanation).
I have written new tests for my resource or datasource changes & updated any relevent documentation.
I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests.
(For changes that include a state migration only). I have manually tested the migration path between relevant versions of the provider.

Testing

My submission includes Test coverage as described in the Contribution Guide and the tests pass. (if this is not possible for any reason, please include details of why you did or could not add test coverage)

Test results:

PASS: TestAccMongoCluster_basic (1257.27s)
PASS: TestAccMongoCluster_requiresImport (1592.76s)
PASS: TestAccMongoCluster_update (2704.27s)
PASS: TestAccMongoCluster_previewFeature (2373.41s)

Change Log

Below please provide what should go into the changelog (if anything) conforming to the Changelog Format documented here.

azurerm_mongo_cluster - New resource azurerm_mongo_cluster [Support for CosmosDb for Mongodb vcore #24161]

This is a (please select all that apply):

Bug Fix
New Feature (ie adding a service, resource, or data source)
Enhancement
Breaking Change

Related Issue(s)

Fixes #24161

ms-zhenhua

Hi @sinbai,

Thanks for this PR - I've taken a look through and left some comments inline. If we can fix those up, this should be good to go 👍

ms-zhenhua · 2024-10-15T03:34:54Z

internal/services/mongocluster/mongo_cluster_resource.go

+			ValidateFunc: validation.All(
+				validation.StringLenBetween(3, 40),
+				validation.StringMatch(
+					regexp.MustCompile(`^[a-z0-9]+(-[a-z0-9]+)*$`),


seems the name cannot start with a hyphen but can end with a hyphen?
maybe you can refer to this code to combine these 2 validations?

I think it should be regexp.MustCompile(^[a-z\d][-a-z\d]{1,38}[a-z\d]$) because the name should have at least 3 characters.

ms-zhenhua · 2024-10-15T07:51:03Z

internal/services/mongocluster/mongo_cluster_resource.go

+				Properties: &mongoclusters.MongoClusterProperties{},
+			}
+
+			if _, ok := metadata.ResourceData.GetOk("administrator_login"); ok {


shall we use AdministratorLogin != "" instead of metadata.ResourceData.GetOk like other existing typed resources did? please also update other places.

ms-zhenhua · 2024-10-15T07:58:50Z

internal/services/mongocluster/mongo_cluster_resource.go

+			if _, ok := metadata.ResourceData.GetOk("administrator_login"); ok {
+				parameter.Properties.Administrator = &mongoclusters.AdministratorProperties{
+					UserName: pointer.To(state.AdministratorLogin),
+					Password: pointer.To(state.AdministratorLoginPassword),


since administrator_login_password is optional, do you need to judge whether it exists?

I added RequiredWith: []string{"administrator_username", "administrator_password"} for administrator_username and administrator_password properties. That's means once administrator_username is specified, the administrator_password is required. So, I assume that administrator_password doesn't need to be judged whether it exists here, what do you think?

ms-zhenhua · 2024-10-15T08:38:29Z

internal/services/mongocluster/mongo_cluster_resource_test.go

+	})
+}
+
+func TestAccMongoCluster_update(t *testing.T) {


shall we also test a scenario that the elements of preview_features are changed?

I assume that ForceNew property preview_features is not needed to test changes, right?

ms-zhenhua · 2024-10-15T08:52:01Z

internal/services/mongocluster/mongo_cluster_resource.go

+
+			switch state.CreateMode {
+			case string(mongoclusters.CreateModeDefault):
+				if _, ok := metadata.ResourceDiff.GetOk("administrator_login"); !ok {


shall we use state,AdministratorLogin != "" instead of metadata.ResourceDiff.GetOk ? Please also confirm other places below

ms-zhenhua · 2024-10-15T09:04:29Z

website/docs/r/mongo_cluster.html.markdown

+
+* `administrator_login` - (Optional) The administrator username of the Azure Cosmos DB for MongoDB vCore. Changing this forces a new resource to be created.
+
+* `create_mode` - (Optional) The creation mode for the Azure Cosmos DB for MongoDB vCore. Possibles values are `Default` and `GeoReplica`. Defaults to 'Default'. Changing this forces a new resource to be created.


Suggested change

* `create_mode` - (Optional) The creation mode for the Azure Cosmos DB for MongoDB vCore. Possibles values are `Default` and `GeoReplica`. Defaults to 'Default'. Changing this forces a new resource to be created.

* `create_mode` - (Optional) The creation mode for the Azure Cosmos DB for MongoDB vCore. Possibles values are `Default` and `GeoReplica`. Defaults to `Default`. Changing this forces a new resource to be created.

ms-zhenhua · 2024-10-15T09:05:51Z

website/docs/r/mongo_cluster.html.markdown

+
+* `create_mode` - (Optional) The creation mode for the Azure Cosmos DB for MongoDB vCore. Possibles values are `Default` and `GeoReplica`. Defaults to 'Default'. Changing this forces a new resource to be created.
+
+-> **Note** The creation mode "GeoReplica" is currently in preview. It is only available when specified via `preview_features`.


Suggested change

-> **Note** The creation mode "GeoReplica" is currently in preview. It is only available when specified via `preview_features`.

-> **Note** The creation mode `GeoReplica` is currently in preview. It is only available when `preview_features` is set.

ms-zhenhua · 2024-10-15T09:08:24Z

website/docs/r/mongo_cluster.html.markdown

+
+* `source_location` - (Optional) The location of the source Azure Cosmos DB for MongoDB vCore. Changing this forces a new resource to be created.
+
+* `source_resource_id` - (Optional) The ID of the replication source Azure Cosmos DB for MongoDB vCore. Changing this forces a new resource to be created.


should be source_server_id ?

ms-zhenhua · 2024-10-15T09:09:06Z

website/docs/r/mongo_cluster.html.markdown

+
+* `high_availability_mode` - (Optional) The high availability mode for the Azure Cosmos DB for MongoDB vCore. Possibles values are `Disabled` and `ZoneRedundantPreferred`.
+
+* `public_network_access_enabled` - (Optional) Whether public network access is allowed for the Azure Cosmos DB for MongoDB vCore. Defaults to 'true'.


Suggested change

* `public_network_access_enabled` - (Optional) Whether public network access is allowed for the Azure Cosmos DB for MongoDB vCore. Defaults to 'true'.

* `public_network_access_enabled` - (Optional) Whether public network access is allowed for the Azure Cosmos DB for MongoDB vCore. Defaults to `true`.

ms-zhenhua · 2024-10-15T09:12:08Z

internal/services/mongocluster/mongo_cluster_resource.go

+			}, false),
+		},
+
+		"preview_features": {


Elements in list can be duplicated. What will happen if duplicated elements are sent to Azure?
Will Azure reorder the element sequence in response if more than 1 elements are sent to Azure?

If duplicated elements are sent to Azure, the API returns a 400 Bad Request with an error message for duplicate array value.

Since there is currently only one possible value for preview_features(it could not be deleted once specified). I am not sure whether the API would reorder the elements.

Could you add the validation for the duplicated values in the customizeDiff function so that such error can be found in plan stage?

sinbai · 2024-10-16T09:17:50Z

Hi @sinbai,

Thanks for this PR - I've taken a look through and left some comments inline. If we can fix those up, this should be good to go 👍

Hi @ms-zhenhua thanks for your time and your feedback. I have fixed/replied to the comments. Could you please take another look?

ms-zhenhua · 2024-10-17T05:33:50Z

internal/services/mongocluster/mongo_cluster_resource.go

+				parameter.Properties.CreateMode = pointer.To(mongoclusters.CreateMode(state.CreateMode))
+			}
+
+			if v, ok := metadata.ResourceData.GetOk("preview_features"); ok {


shall we use PreviewFeatures instead of metadata.ResourceData.GetOk("preview_features")?

ms-zhenhua · 2024-10-17T05:34:56Z

internal/services/mongocluster/mongo_cluster_resource.go

+				parameter.Properties.PreviewFeatures = expandPreviewFeatures(v.([]interface{}))
+			}
+
+			if _, ok := metadata.ResourceData.GetOk("shard_count"); ok {


since shard_count is non-zero, you may use ShardCount != 0 instead of metadata.ResourceData.GetOk("shard_count")

ms-zhenhua · 2024-10-17T05:35:30Z

internal/services/mongocluster/mongo_cluster_resource.go

+				parameter.Properties.PublicNetworkAccess = pointer.To(mongoclusters.PublicNetworkAccessDisabled)
+			}
+
+			if _, ok := metadata.ResourceData.GetOk("storage_size_in_gb"); ok {


same as above

ms-zhenhua · 2024-10-17T05:36:55Z

internal/services/mongocluster/mongo_cluster_resource.go

+				}
+			}
+
+			if _, ok := metadata.ResourceData.GetOk("tags"); ok {


please use Tags instead of metadata.ResourceData.GetOk("tags")

sinbai · 2024-10-18T10:03:28Z

Hi @ms-zhenhua , thanks for your feedback again. I have fixed the comments. Could you please take another look?

ms-zhenhua · 2024-10-21T02:06:45Z

internal/services/mongocluster/mongo_cluster_resource.go

+				}
+			}
+
+			if len(state.Tags) > 0 {


Suggested change

if len(state.Tags) > 0 {

if state.Tags != nil {

ms-zhenhua · 2024-10-21T02:07:35Z

internal/services/mongocluster/mongo_cluster_resource.go

+				parameter.Properties.CreateMode = pointer.To(mongoclusters.CreateMode(state.CreateMode))
+			}
+
+			if len(state.PreviewFeatures) > 0 {


shall we put len(state.PreviewFeatures) > 0 into the expand function as other resources did?

ms-zhenhua

Hi @sinbai, thank you for your updates. LGTM~

stephybun

Hey @sinbai, I left some comments and questions in-line that would be good to have fixed up. Furthermore looking at the Azure documentation and how this resource is referred to in there, I'm wondering if this should actually be part of the cosmosdb service package instead of being separated into it's own mongocluster service package.

stephybun · 2024-10-23T12:15:06Z

internal/services/mongocluster/mongo_cluster_resource.go

+			Optional:     true,
+			ForceNew:     true,
+			ValidateFunc: validation.StringIsNotEmpty,
+			RequiredWith: []string{"administrator_username", "administrator_password"},


We don't need to specify the property name that the RequiredWith is applied to

Suggested change

RequiredWith: []string{"administrator_username", "administrator_password"},

RequiredWith: []string{"administrator_password"},

stephybun · 2024-10-23T12:18:34Z

internal/services/mongocluster/mongo_cluster_resource.go

+			Type:         schema.TypeString,
+			Optional:     true,
+			ForceNew:     true,
+			ValidateFunc: validation.StringIsNotEmpty,


This should have a stricter validation

Suggested change

ValidateFunc: validation.StringIsNotEmpty,

ValidateFunc: mongoclusters.ValidateMongoClusterID,

stephybun · 2024-10-23T12:18:52Z

internal/services/mongocluster/mongo_cluster_resource.go

+			Optional:     true,
+			Sensitive:    true,
+			ValidateFunc: validation.StringIsNotEmpty,
+			RequiredWith: []string{"administrator_username", "administrator_password"},


Suggested change

RequiredWith: []string{"administrator_username", "administrator_password"},

RequiredWith: []string{"administrator_username"},

stephybun · 2024-10-23T12:21:13Z

internal/services/mongocluster/mongo_cluster_resource.go

+			}
+
+			parameter := mongoclusters.MongoCluster{
+				Location:   azure.NormalizeLocation(state.Location),


This function is deprecated, please use location.Normalize

Suggested change

Location: azure.NormalizeLocation(state.Location),

Location: location.Normalize(state.Location),

stephybun · 2024-10-23T12:22:16Z

internal/services/mongocluster/mongo_cluster_resource.go

+			metadata.Logger.Info("Decoding state...")
+			var state MongoClusterResourceModel
+			if err := metadata.Decode(&state); err != nil {
+				return err


This error should be wrapped like we do in the create

Suggested change

return err

return fmt.Errorf("decoding: %+v", err)

stephybun · 2024-10-23T12:44:37Z

website/docs/r/mongo_cluster.html.markdown

+  Manages an Azure Cosmos DB for MongoDB vCore.
+---
+
+# azurerm_mongo_cluster
+
+Manages an Azure Cosmos DB for MongoDB vCore.


Suggested change

Manages an Azure Cosmos DB for MongoDB vCore.

---

# azurerm_mongo_cluster

Manages an Azure Cosmos DB for MongoDB vCore.

Manages a MongoDB Cluster using vCore Architecture.

---

# azurerm_mongo_cluster

Manages a MongoDB Cluster using vCore Architecture.

stephybun · 2024-10-23T12:44:58Z

website/docs/r/mongo_cluster.html.markdown

@@ -0,0 +1,129 @@
+---
+subcategory: "MongoCluster"


This should typically have spacing

Suggested change

subcategory: "MongoCluster"

subcategory: "Mongo Cluster"

stephybun · 2024-10-23T12:46:36Z

website/docs/r/mongo_cluster.html.markdown

+
+The following arguments are supported:
+
+* `name` - (Required) The name which should be used for the Azure Cosmos DB for MongoDB vCore. Changing this forces a new resource to be created.


Can you please update all references in these docs from Azure Cosmos DB for MongoDB vCore to

Suggested change

* `name` - (Required) The name which should be used for the Azure Cosmos DB for MongoDB vCore. Changing this forces a new resource to be created.

* `name` - (Required) The name which should be used for the MongoDB Cluster. Changing this forces a new resource to be created.

stephybun · 2024-10-23T12:47:19Z

website/docs/r/mongo_cluster.html.markdown

+
+## Import
+
+Monitor Azure Active Directory Diagnostic Settings can be imported using the `resource id`, e.g.


Suggested change

Monitor Azure Active Directory Diagnostic Settings can be imported using the `resource id`, e.g.

MongoDB Clusters can be imported using the `resource id`, e.g.

stephybun · 2024-10-23T12:47:35Z

website/allowed-subcategories

@@ -73,6 +73,7 @@ Maps
 Messaging
 Mixed Reality
 Mobile Network
+MongoCluster


Suggested change

MongoCluster

Mongo Cluster

sinbai · 2024-10-29T07:39:49Z

Hey @sinbai, I left some comments and questions in-line that would be good to have fixed up. Furthermore looking at the Azure documentation and how this resource is referred to in there, I'm wondering if this should actually be part of the cosmosdb service package instead of being separated into it's own mongocluster service package.

Hi @stephybun thanks for your time and feedback. I have fixed/replied the comments. Could you please take another look?

stephybun

Hey @sinbai, I left responses to some of the comments. Unless there is some additional evidence that this is an entirely new product, I still think this should be added to the cosmosdb service package instead of creating a new mongocluster service package.

github-actions bot added documentation dependencies size/XL waiting-response labels Oct 12, 2024

sinbai force-pushed the mongocluster/new_mongocluster_resource branch from 0f36d96 to e721f8a Compare October 12, 2024 11:07

github-actions bot added waiting-response and removed waiting-response labels Oct 12, 2024

sinbai force-pushed the mongocluster/new_mongocluster_resource branch from e721f8a to f313acb Compare October 12, 2024 13:41

github-actions bot added waiting-response and removed waiting-response labels Oct 12, 2024

sinbai force-pushed the mongocluster/new_mongocluster_resource branch from f313acb to 24d24cf Compare October 14, 2024 11:58

github-actions bot removed the waiting-response label Oct 14, 2024

rcskosir added the new-resource label Oct 14, 2024

ms-zhenhua suggested changes Oct 15, 2024

View reviewed changes

github-actions bot added waiting-response and removed waiting-response labels Oct 15, 2024

github-actions bot added the waiting-response label Oct 17, 2024

ms-zhenhua reviewed Oct 17, 2024

View reviewed changes

github-actions bot removed the waiting-response label Oct 18, 2024

ms-zhenhua reviewed Oct 21, 2024

View reviewed changes

github-actions bot added the waiting-response label Oct 21, 2024

ms-zhenhua reviewed Oct 21, 2024

View reviewed changes

github-actions bot removed the waiting-response label Oct 21, 2024

ms-zhenhua approved these changes Oct 21, 2024

View reviewed changes

sinbai marked this pull request as ready for review October 21, 2024 07:58

sinbai requested review from katbyte and a team as code owners October 21, 2024 07:58

stephybun requested changes Oct 23, 2024

View reviewed changes

sinbai added 3 commits October 28, 2024 16:31

new resource azurerm_mongo_cluster

c0ed3cf

fix comments

a4ff013

fix comments

efd3a7f

sinbai force-pushed the mongocluster/new_mongocluster_resource branch from 11f3acc to 868b10f Compare October 28, 2024 08:32

github-actions bot added waiting-response and removed waiting-response labels Oct 28, 2024

fix comments

969187a

sinbai force-pushed the mongocluster/new_mongocluster_resource branch from 868b10f to 969187a Compare October 29, 2024 05:10

github-actions bot removed the waiting-response label Oct 29, 2024

github-actions bot added the waiting-response label Oct 31, 2024

stephybun requested changes Oct 31, 2024

View reviewed changes


		* `administrator_login` - (Optional) The administrator username of the Azure Cosmos DB for MongoDB vCore. Changing this forces a new resource to be created.

		* `create_mode` - (Optional) The creation mode for the Azure Cosmos DB for MongoDB vCore. Possibles values are `Default` and `GeoReplica`. Defaults to 'Default'. Changing this forces a new resource to be created.


		* `create_mode` - (Optional) The creation mode for the Azure Cosmos DB for MongoDB vCore. Possibles values are `Default` and `GeoReplica`. Defaults to 'Default'. Changing this forces a new resource to be created.

		-> Note The creation mode "GeoReplica" is currently in preview. It is only available when specified via `preview_features`.

	-> Note The creation mode "GeoReplica" is currently in preview. It is only available when specified via `preview_features`.
	-> Note The creation mode `GeoReplica` is currently in preview. It is only available when `preview_features` is set.


		* `source_location` - (Optional) The location of the source Azure Cosmos DB for MongoDB vCore. Changing this forces a new resource to be created.

		* `source_resource_id` - (Optional) The ID of the replication source Azure Cosmos DB for MongoDB vCore. Changing this forces a new resource to be created.


		* `high_availability_mode` - (Optional) The high availability mode for the Azure Cosmos DB for MongoDB vCore. Possibles values are `Disabled` and `ZoneRedundantPreferred`.

		* `public_network_access_enabled` - (Optional) Whether public network access is allowed for the Azure Cosmos DB for MongoDB vCore. Defaults to 'true'.

	RequiredWith: []string{"administrator_username", "administrator_password"},
	RequiredWith: []string{"administrator_password"},

	ValidateFunc: validation.StringIsNotEmpty,
	ValidateFunc: mongoclusters.ValidateMongoClusterID,

	Location: azure.NormalizeLocation(state.Location),
	Location: location.Normalize(state.Location),


		The following arguments are supported:

		* `name` - (Required) The name which should be used for the Azure Cosmos DB for MongoDB vCore. Changing this forces a new resource to be created.


		## Import

		Monitor Azure Active Directory Diagnostic Settings can be imported using the `resource id`, e.g.

	Monitor Azure Active Directory Diagnostic Settings can be imported using the `resource id`, e.g.
	MongoDB Clusters can be imported using the `resource id`, e.g.

New Resource : azurerm_mongo_cluster #27636

Are you sure you want to change the base?

New Resource : azurerm_mongo_cluster #27636

Conversation

sinbai commented Oct 12, 2024 • edited Loading

Community Note

Description

PR Checklist

Changes to existing Resource / Data Source

Testing

Change Log

Related Issue(s)

ms-zhenhua left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sinbai commented Oct 16, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sinbai commented Oct 18, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ms-zhenhua left a comment

Choose a reason for hiding this comment

stephybun left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sinbai commented Oct 29, 2024

stephybun left a comment

Choose a reason for hiding this comment

New Resource : `azurerm_mongo_cluster` #27636

New Resource : `azurerm_mongo_cluster` #27636

sinbai commented Oct 12, 2024 •

edited

Loading