feat: search node management with mongodbatlas_search_deployment resource and data source

.github/workflows/acceptance-tests.yml

@@ -22,6 +22,7 @@ jobs:
       cluster_outage_simulation: ${{ steps.filter.outputs.cluster_outage_simulation }}
       advanced_cluster: ${{ steps.filter.outputs.advanced_cluster }}
       cluster: ${{ steps.filter.outputs.cluster }}
+      search_deployment: ${{ steps.filter.outputs.search_deployment }}
       generic: ${{ steps.filter.outputs.generic }}
       backup_online_archive: ${{ steps.filter.outputs.backup_online_archive }}
       backup_snapshots: ${{ steps.filter.outputs.backup_snapshots }}
@@ -49,6 +50,8 @@ jobs:
             - 'mongodbatlas/**advanced_cluster**.go'
           cluster:
             - 'mongodbatlas/**mongodbatlas_cluster**.go'
+          search_deployment:
+            - 'mongodbatlas/**search_deployment**.go'
           generic:
             - 'mongodbatlas/data_source_mongodbatlas_backup_compliance_policy*.go'
             - 'mongodbatlas/resource_mongodbatlas_backup_compliance_policy*.go'
@@ -185,6 +188,30 @@ jobs:
           TEST_REGEX: "^TestAccClusterRSCluster"
         run: make testacc
 
+  search_deployment:
+    needs: [ change-detection ]
+    if: ${{ needs.change-detection.outputs.search_deployment == 'true' || github.event_name == 'workflow_dispatch' || github.event_name == 'schedule' || github.event.label.name == 'run-testacc' || github.event.label.name == 'run-testacc-search-deployment' || inputs.parent-event-name == 'release' }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Go
+        uses: actions/setup-go@v4
+        with:
+          go-version-file: 'go.mod'
+      - name: Acceptance Tests
+        env:
+          MONGODB_ATLAS_PUBLIC_KEY: ${{ secrets.MONGODB_ATLAS_PUBLIC_KEY_CLOUD_DEV }}
+          MONGODB_ATLAS_PRIVATE_KEY: ${{ secrets.MONGODB_ATLAS_PRIVATE_KEY_CLOUD_DEV }}
+          MONGODB_ATLAS_ORG_ID: ${{ vars.MONGODB_ATLAS_ORG_ID_CLOUD_DEV }}
+          MONGODB_ATLAS_BASE_URL: ${{ vars.MONGODB_ATLAS_BASE_URL }}
+          ACCTEST_TIMEOUT: ${{ vars.ACCTEST_TIMEOUT }}
+          TF_LOG: ${{ vars.LOG_LEVEL }}
+          TF_ACC: 1
+          PARALLEL_GO_TEST: 20
+          TEST_REGEX: "^TestAccSearchDeployment"
+        run: make testacc
+
   generic: # Acceptance tests that do not use any time-consuming resource (example: cluster)
     needs: [ change-detection ]
     if: ${{ needs.change-detection.outputs.generic == 'true' || github.event_name == 'workflow_dispatch' || github.event_name == 'schedule' || github.event.label.name == 'run-testacc' || github.event.label.name == 'run-testacc-generic' || inputs.parent-event-name == 'release' }}

examples/atlas-search-deployment/README.md

@@ -0,0 +1,11 @@
+# MongoDB Atlas Provider - Atlas Cluster with dedicated Search Nodes Deployment
+
+This example shows how you can use Atlas Dedicated Search Nodes in Terraform. As part of it, a project and cluster resource are created as a prerequisite.
+
+Variables Required to be set:
+
+- `public_key`: Atlas public key
+- `private_key`: Atlas  private key
+- `org_id`: Organization ID where the project and cluster will be created.
+
+For additional information you can visit the [Search Node Documentation](https://www.mongodb.com/docs/atlas/cluster-config/multi-cloud-distribution/#search-nodes-for-workload-isolation).

examples/atlas-search-deployment/main.tf

@@ -0,0 +1,33 @@
+resource "mongodbatlas_project" "example" {
+  name   = "project-name"
+  org_id = var.org_id
+}
+
+resource "mongodbatlas_advanced_cluster" "example" {
+  project_id   = mongodbatlas_project.example.id
+  name         = "ClusterExample"
+  cluster_type = "REPLICASET"
+
+  replication_specs {
+    region_configs {
+      electable_specs {
+        instance_size = "M10"
+        node_count    = 3
+      }
+      provider_name = "AWS"
+      priority      = 7
+      region_name   = "US_EAST_1"
+    }
+  }
+}
+
+resource "mongodbatlas_search_deployment" "example" {
+  project_id   = mongodbatlas_project.example.id
+  cluster_name = mongodbatlas_advanced_cluster.example.name
+  specs = [
+    {
+      instance_size = "S20_HIGHCPU_NVME"
+      node_count    = 2
+    }
+  ]
+}

examples/atlas-search-deployment/provider.tf

@@ -0,0 +1,4 @@
+provider "mongodbatlas" {
+  public_key  = var.public_key
+  private_key = var.private_key
+}

examples/atlas-search-deployment/variables.tf

@@ -0,0 +1,12 @@
+variable "public_key" {
+  description = "Public API key to authenticate to Atlas"
+  type        = string
+}
+variable "private_key" {
+  description = "Private API key to authenticate to Atlas"
+  type        = string
+}
+variable "org_id" {
+  description = "Atlas Organization ID"
+  type        = string
+} 

examples/atlas-search-deployment/versions.tf

@@ -0,0 +1,9 @@
+terraform {
+  required_providers {
+    mongodbatlas = {
+      source  = "mongodb/mongodbatlas"
+      version = "~> 1.13"
+    }
+  }
+  required_version = ">= 1.0"
+}

mongodbatlas/framework/retry/retry_state.go

@@ -4,4 +4,8 @@ const (
 	RetryStrategyPendingState   = "PENDING"
 	RetryStrategyCompletedState = "COMPLETED"
 	RetryStrategyErrorState     = "ERROR"
+	RetryStrategyPausedState    = "PAUSED"
+	RetryStrategyUpdatingState  = "UPDATING"
+	RetryStrategyIdleState      = "IDLE"
+	RetryStrategyDeletedState   = "DELETED"
 )

mongodbatlas/fw_data_source_mongodbatlas_search_deployment.go

@@ -0,0 +1,99 @@
+package mongodbatlas
+
+import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-framework/datasource"
+	"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/types"
+)
+
+var _ datasource.DataSource = &SearchDeploymentDS{}
+var _ datasource.DataSourceWithConfigure = &SearchDeploymentDS{}
+
+func NewSearchDeploymentDS() datasource.DataSource {
+	return &SearchDeploymentDS{
+		DSCommon: DSCommon{
+			dataSourceName: searchDeploymentName,
+		},
+	}
+}
+
+type tfSearchDeploymentDSModel struct {
+	ID          types.String `tfsdk:"id"`
+	ClusterName types.String `tfsdk:"cluster_name"`
+	ProjectID   types.String `tfsdk:"project_id"`
+	Specs       types.List   `tfsdk:"specs"`
+	StateName   types.String `tfsdk:"state_name"`
+}
+
+type SearchDeploymentDS struct {
+	DSCommon
+}
+
+func (d *SearchDeploymentDS) Schema(ctx context.Context, req datasource.SchemaRequest, resp *datasource.SchemaResponse) {
+	resp.Schema = schema.Schema{
+		Attributes: map[string]schema.Attribute{
+			"id": schema.StringAttribute{
+				Computed: true,
+			},
+			"cluster_name": schema.StringAttribute{
+				Required: true,
+			},
+			"project_id": schema.StringAttribute{
+				Required: true,
+			},
+			"specs": schema.ListNestedAttribute{
+				NestedObject: schema.NestedAttributeObject{
+					Attributes: map[string]schema.Attribute{
+						"instance_size": schema.StringAttribute{
+							Computed: true,
+						},
+						"node_count": schema.Int64Attribute{
+							Computed: true,
+						},
+					},
+				},
+				Computed: true,
+			},
+			"state_name": schema.StringAttribute{
+				Computed: true,
+			},
+		},
+	}
+}
+
+func (d *SearchDeploymentDS) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
+	var searchDeploymentConfig tfSearchDeploymentDSModel
+	resp.Diagnostics.Append(req.Config.Get(ctx, &searchDeploymentConfig)...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	connV2 := d.client.AtlasV2
+	projectID := searchDeploymentConfig.ProjectID.ValueString()
+	clusterName := searchDeploymentConfig.ClusterName.ValueString()
+	deploymentResp, _, err := connV2.AtlasSearchApi.GetAtlasSearchDeployment(ctx, projectID, clusterName).Execute()
+	if err != nil {
+		resp.Diagnostics.AddError("error getting search node information", err.Error())
+		return
+	}
+
+	newSearchDeploymentModel, diagnostics := newTFSearchDeployment(ctx, clusterName, deploymentResp, nil)
+	resp.Diagnostics.Append(diagnostics...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+	dsModel := convertToDSModel(newSearchDeploymentModel)
+	resp.Diagnostics.Append(resp.State.Set(ctx, dsModel)...)
+}
+
+func convertToDSModel(inputModel *tfSearchDeploymentRSModel) tfSearchDeploymentDSModel {
+	return tfSearchDeploymentDSModel{
+		ID:          inputModel.ID,
+		ClusterName: inputModel.ClusterName,
+		ProjectID:   inputModel.ProjectID,
+		Specs:       inputModel.Specs,
+		StateName:   inputModel.StateName,
+	}
+}

mongodbatlas/fw_provider.go

@@ -413,6 +413,7 @@ func (p *MongodbtlasProvider) DataSources(context.Context) []func() datasource.D
 		NewProjectIPAccessListDS,
 		NewAtlasUserDS,
 		NewAtlasUsersDS,
+		NewSearchDeploymentDS,
 	}
 }
 
@@ -423,6 +424,7 @@ func (p *MongodbtlasProvider) Resources(context.Context) []func() resource.Resou
 		NewDatabaseUserRS,
 		NewAlertConfigurationRS,
 		NewProjectIPAccessListRS,
+		NewSearchDeploymentRS,
 	}
 }