Added - Support for OpenSearch OBO metering for external customers

Author: Seung Yeon Joo

examples/opensearch/opensearch_cluster_pipeline/main.tf

@@ -76,8 +76,12 @@ variable "opensearch_cluster_pipeline_opc_dry_run" {
   default = false
 }
 
+variable "opensearch_cluster_pipeline_node_shape" {
+  default = "VM.Standard.E3.Flex"
+}
+
 locals  {
-  pipeline_configuration_body = "version: 2\npipeline_configurations:\n  oci:\n    secrets:\n      opensearch-username:\n        secret_id: ocid1.vaultsecret.oc1.iad.amaaaaaahngrfpyagmlx4uz56urywg2rlenjwpdjuis6ncnzl4sfixltrxsq\n        refresh_interval: PT2H\n      opensearch-password:\n        secret_id: ocid1.vaultsecret.oc1.iad.amaaaaaahngrfpya5t4a2yhoqwbqg7rahhesrjuxjgyz2enopd6vkn2e5q7q\n        refresh_interval: PT2H\najapraka-log-pipeline:\n  source:\n    oci-object:\n      acknowledgments: true\n      codec:\n        newline:\n      compression: none\n      scan:\n        scheduling:\n          interval: PT30S\n        buckets:\n          - bucket:\n              namespace: idv3bncjikjv\n              name: data_prepper_integration_test_object_storage_source_bucket_0\n              region: us-ashburn-1\n  sink:\n    - opensearch:\n        hosts: [ ocid1.opensearchcluster.oc1.iad.amaaaaaahngrfpyazkwqhgnvrdtzr74fyl4nocmdw6qetnhdmqcx7baoe4zq ]\n        username: $${{oci_secrets:opensearch-username}}\n        password: $${{oci_secrets:opensearch-password}}\n        insecure: false\n        index: pipeline-stage-testing-index-1"
+  pipeline_configuration_body = "version: 2\npipeline_configurations:\n  oci:\n    secrets:\n      opensearch-username:\n        secret_id: {{username-vaultsecret}}\n        refresh_interval: PT2H\n      opensearch-password:\n        secret_id: {{password-vaultsecret}}\n        refresh_interval: PT2H\najapraka-log-pipeline:\n  source:\n    oci-object:\n      acknowledgments: true\n      codec:\n        newline:\n      compression: none\n      scan:\n        scheduling:\n          interval: PT30S\n        buckets:\n          - bucket:\n              namespace: idv3bncjikjv\n              name: data_prepper_integration_test_object_storage_source_bucket_0\n              region: us-ashburn-1\n  sink:\n    - opensearch:\n        hosts: [ {{clusterOCID}} ]\n        username: $${{oci_secrets:opensearch-username}}\n        password: $${{oci_secrets:opensearch-password}}\n        insecure: false\n        index: pipeline-stage-testing-index-1"
 }
 
 variable "opensearch_cluster_pipeline_reverse_connection_endpoints_customer_fqdn" {

internal/integrationtest/opensearch_opensearch_cluster_pipeline_test.go

@@ -49,6 +49,15 @@ var (
 	}
 
 	OpensearchOpensearchClusterRepresentation = map[string]interface{}{
+		"opendashboard_node_host_shape":      acctest.Representation{RepType: acctest.Optional, Create: `VM.Standard.E3.Flex`},
+		"master_node_host_shape":             acctest.Representation{RepType: acctest.Optional, Create: `VM.Standard.E3.Flex`},
+		"data_node_host_shape":               acctest.Representation{RepType: acctest.Optional, Create: `VM.Standard.E3.Flex`},
+		"search_node_host_shape":             acctest.Representation{RepType: acctest.Optional, Create: `VM.Standard.E3.Flex`},
+		"search_node_count":                  acctest.Representation{RepType: acctest.Required, Create: `1`},
+		"search_node_host_memory_gb":         acctest.Representation{RepType: acctest.Required, Create: `20`},
+		"search_node_host_ocpu_count":        acctest.Representation{RepType: acctest.Required, Create: `2`},
+		"search_node_host_type":              acctest.Representation{RepType: acctest.Required, Create: `FLEX`},
+		"search_node_storage_gb":             acctest.Representation{RepType: acctest.Required, Create: `50`},
 		"maintenance_details":                acctest.RepresentationGroup{RepType: acctest.Optional, Group: OpensearchOpensearchClusterMaintenanceDetailsRepresentation},
 		"compartment_id":                     acctest.Representation{RepType: acctest.Required, Create: `${var.compartment_id}`},
 		"data_node_count":                    acctest.Representation{RepType: acctest.Required, Create: `1`},
@@ -197,8 +206,17 @@ var (
 	}
 
 	OpensearchOpensearchClusterHorizontalResizeRepresentation = map[string]interface{}{
+		"opendashboard_node_host_shape":      acctest.Representation{RepType: acctest.Optional, Create: `VM.Standard.E3.Flex`},
+		"master_node_host_shape":             acctest.Representation{RepType: acctest.Optional, Create: `VM.Standard.E3.Flex`},
+		"data_node_host_shape":               acctest.Representation{RepType: acctest.Optional, Create: `VM.Standard.E3.Flex`},
+		"search_node_host_shape":             acctest.Representation{RepType: acctest.Optional, Create: `VM.Standard.E3.Flex`},
 		"maintenance_details":                acctest.RepresentationGroup{RepType: acctest.Optional, Group: OpensearchOpensearchClusterMaintenanceDetailsRepresentation},
 		"compartment_id":                     acctest.Representation{RepType: acctest.Required, Create: `${var.compartment_id}`},
+		"search_node_count":                  acctest.Representation{RepType: acctest.Required, Create: `1`, Update: `2`},
+		"search_node_host_memory_gb":         acctest.Representation{RepType: acctest.Required, Create: `20`},
+		"search_node_host_ocpu_count":        acctest.Representation{RepType: acctest.Required, Create: `2`},
+		"search_node_host_type":              acctest.Representation{RepType: acctest.Required, Create: `FLEX`},
+		"search_node_storage_gb":             acctest.Representation{RepType: acctest.Required, Create: `50`},
 		"data_node_count":                    acctest.Representation{RepType: acctest.Required, Create: `1`, Update: `2`},
 		"data_node_host_memory_gb":           acctest.Representation{RepType: acctest.Required, Create: `20`},
 		"data_node_host_ocpu_count":          acctest.Representation{RepType: acctest.Required, Create: `2`},
@@ -224,8 +242,17 @@ var (
 	}
 
 	OpensearchOpensearchClusterVerticalResizeRepresentation = map[string]interface{}{
+		"opendashboard_node_host_shape":      acctest.Representation{RepType: acctest.Optional, Create: `VM.Standard.E3.Flex`, Update: `VM.Standard.E4.Flex`},
+		"master_node_host_shape":             acctest.Representation{RepType: acctest.Optional, Create: `VM.Standard.E3.Flex`, Update: `VM.Standard.E4.Flex`},
+		"data_node_host_shape":               acctest.Representation{RepType: acctest.Optional, Create: `VM.Standard.E3.Flex`, Update: `VM.Standard.E4.Flex`},
+		"search_node_host_shape":             acctest.Representation{RepType: acctest.Optional, Create: `VM.Standard.E3.Flex`, Update: `VM.Standard.E4.Flex`},
 		"maintenance_details":                acctest.RepresentationGroup{RepType: acctest.Optional, Group: OpensearchOpensearchClusterMaintenanceDetailsRepresentation},
 		"compartment_id":                     acctest.Representation{RepType: acctest.Required, Create: `${var.compartment_id}`},
+		"search_node_count":                  acctest.Representation{RepType: acctest.Required, Create: `1`, Update: `2`},
+		"search_node_host_memory_gb":         acctest.Representation{RepType: acctest.Required, Create: `20`},
+		"search_node_host_ocpu_count":        acctest.Representation{RepType: acctest.Required, Create: `2`},
+		"search_node_host_type":              acctest.Representation{RepType: acctest.Required, Create: `FLEX`},
+		"search_node_storage_gb":             acctest.Representation{RepType: acctest.Required, Create: `50`},
 		"data_node_count":                    acctest.Representation{RepType: acctest.Required, Create: `1`, Update: `2`},
 		"data_node_host_memory_gb":           acctest.Representation{RepType: acctest.Required, Create: `20`, Update: `40`},
 		"data_node_host_ocpu_count":          acctest.Representation{RepType: acctest.Required, Create: `2`, Update: `4`},
@@ -640,12 +667,21 @@ func TestOpensearchOpensearchClusterResource_basic(t *testing.T) {
 			Config: config + compartmentIdVariableStr + OpensearchOpensearchClusterResourceDependencies +
 				acctest.GenerateResourceFromRepresentationMap("oci_opensearch_opensearch_cluster", "test_opensearch_cluster", acctest.Optional, acctest.Create, OpensearchOpensearchClusterRepresentation),
 			Check: acctest.ComposeAggregateTestCheckFuncWrapper(
+				resource.TestCheckResourceAttr(resourceName, "data_node_host_shape", "VM.Standard.E3.Flex"),
+				resource.TestCheckResourceAttr(resourceName, "master_node_host_shape", "VM.Standard.E3.Flex"),
+				resource.TestCheckResourceAttr(resourceName, "opendashboard_node_host_shape", "VM.Standard.E3.Flex"),
+				resource.TestCheckResourceAttr(resourceName, "search_node_host_shape", "VM.Standard.E3.Flex"),
 				resource.TestCheckResourceAttr(resourceName, "compartment_id", compartmentId),
 				resource.TestCheckResourceAttr(resourceName, "data_node_count", "1"),
 				resource.TestCheckResourceAttr(resourceName, "data_node_host_memory_gb", "20"),
 				resource.TestCheckResourceAttr(resourceName, "data_node_host_ocpu_count", "2"),
 				resource.TestCheckResourceAttr(resourceName, "data_node_host_type", "FLEX"),
 				resource.TestCheckResourceAttr(resourceName, "data_node_storage_gb", "50"),
+				resource.TestCheckResourceAttr(resourceName, "search_node_count", "1"),
+				resource.TestCheckResourceAttr(resourceName, "search_node_host_memory_gb", "20"),
+				resource.TestCheckResourceAttr(resourceName, "search_node_host_ocpu_count", "2"),
+				resource.TestCheckResourceAttr(resourceName, "search_node_host_type", "FLEX"),
+				resource.TestCheckResourceAttr(resourceName, "search_node_storage_gb", "50"),
 				resource.TestCheckResourceAttr(resourceName, "display_name", "tf_provider_cluster_updated"),
 				resource.TestCheckResourceAttr(resourceName, "master_node_count", "1"),
 				resource.TestCheckResourceAttr(resourceName, "master_node_host_memory_gb", "20"),
@@ -684,6 +720,15 @@ func TestOpensearchOpensearchClusterResource_basic(t *testing.T) {
 				return configStr
 			}(),
 			Check: acctest.ComposeAggregateTestCheckFuncWrapper(
+				resource.TestCheckResourceAttr(resourceName, "data_node_host_shape", "VM.Standard.E3.Flex"),
+				resource.TestCheckResourceAttr(resourceName, "master_node_host_shape", "VM.Standard.E3.Flex"),
+				resource.TestCheckResourceAttr(resourceName, "opendashboard_node_host_shape", "VM.Standard.E3.Flex"),
+				resource.TestCheckResourceAttr(resourceName, "search_node_host_shape", "VM.Standard.E3.Flex"),
+				resource.TestCheckResourceAttr(resourceName, "search_node_count", "2"),
+				resource.TestCheckResourceAttr(resourceName, "search_node_host_memory_gb", "20"),
+				resource.TestCheckResourceAttr(resourceName, "search_node_host_ocpu_count", "2"),
+				resource.TestCheckResourceAttr(resourceName, "search_node_host_type", "FLEX"),
+				resource.TestCheckResourceAttr(resourceName, "search_node_storage_gb", "50"),
 				resource.TestCheckResourceAttr(resourceName, "compartment_id", compartmentId),
 				resource.TestCheckResourceAttr(resourceName, "data_node_count", "2"),
 				resource.TestCheckResourceAttr(resourceName, "data_node_host_memory_gb", "20"),
@@ -736,8 +781,16 @@ func TestOpensearchOpensearchClusterResource_basic(t *testing.T) {
 				return configStr
 			}(),
 			Check: acctest.ComposeAggregateTestCheckFuncWrapper(
-
+				resource.TestCheckResourceAttr(resourceName, "data_node_host_shape", "VM.Standard.E4.Flex"),
+				resource.TestCheckResourceAttr(resourceName, "master_node_host_shape", "VM.Standard.E4.Flex"),
+				resource.TestCheckResourceAttr(resourceName, "opendashboard_node_host_shape", "VM.Standard.E4.Flex"),
+				resource.TestCheckResourceAttr(resourceName, "search_node_host_shape", "VM.Standard.E4.Flex"),
 				resource.TestCheckResourceAttr(resourceName, "compartment_id", compartmentId),
+				resource.TestCheckResourceAttr(resourceName, "search_node_count", "2"),
+				resource.TestCheckResourceAttr(resourceName, "search_node_host_memory_gb", "20"),
+				resource.TestCheckResourceAttr(resourceName, "search_node_host_ocpu_count", "2"),
+				resource.TestCheckResourceAttr(resourceName, "search_node_host_type", "FLEX"),
+				resource.TestCheckResourceAttr(resourceName, "search_node_storage_gb", "50"),
 				resource.TestCheckResourceAttr(resourceName, "data_node_count", "2"),
 				resource.TestCheckResourceAttr(resourceName, "data_node_host_memory_gb", "40"),
 				resource.TestCheckResourceAttr(resourceName, "data_node_host_ocpu_count", "4"),
@@ -991,6 +1044,22 @@ func init() {
 	}
 }
 
+func getListOpensearchClusterShapes() ([]string, error) {
+	var shapes []string
+	opensearchClusterClient := acctest.GetTestClients(&schema.ResourceData{}).OpensearchClusterClient()
+	listOpensearchClusterShapesRequest := oci_opensearch.ListOpensearchClusterShapesRequest{}
+
+	listOpensearchClustersResponse, err := opensearchClusterClient.ListOpensearchClusterShapes(context.Background(), listOpensearchClusterShapesRequest)
+
+	if err != nil {
+		return shapes, fmt.Errorf("Error getting OpensearchCluster list %s \n", err)
+	}
+	for _, shape := range listOpensearchClustersResponse.Shapes {
+		shapes = append(shapes, shape)
+	}
+	return shapes, nil
+}
+
 func sweepOpensearchOpensearchClusterResource(compartment string) error {
 	opensearchClusterClient := acctest.GetTestClients(&schema.ResourceData{}).OpensearchClusterClient()
 	opensearchClusterIds, err := getOpensearchOpensearchClusterIds(compartment)

internal/integrationtest/opensearch_opensearch_cluster_test.go

@@ -0,0 +1,48 @@
+// Copyright (c) 2017, 2024, Oracle and/or its affiliates. All rights reserved.
+// Licensed under the Mozilla Public License v2.0
+
+package integrationtest
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-testing/terraform"
+
+	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
+
+	"github.com/oracle/terraform-provider-oci/httpreplay"
+	"github.com/oracle/terraform-provider-oci/internal/acctest"
+)
+
+// issue-routing-tag: opensearch/default
+func TestOpensearchShapeResource_basic(t *testing.T) {
+	httpreplay.SetScenario("TestOpensearchShapeResource_basic")
+	defer httpreplay.SaveScenario()
+
+	config := acctest.ProviderTestConfig()
+
+	acctest.SaveConfigContent("", "", "", t)
+
+	shapes, err := getListOpensearchClusterShapes()
+	if err != nil {
+		_ = fmt.Errorf("Error getting OpensearchCluster list for compartment id : %s , %s \n", compartmentId, err)
+	}
+
+	acctest.ResourceTest(t, nil, []resource.TestStep{
+		{
+			Config: config,
+			Check: acctest.ComposeAggregateTestCheckFuncWrapper(
+				testCheckShapesNotEmpty(shapes),
+			),
+		},
+	})
+}
+func testCheckShapesNotEmpty(shapes []string) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		if len(shapes) == 0 {
+			return fmt.Errorf("expected at least one shape, but got none")
+		}
+		return nil
+	}
+}

internal/integrationtest/opensearch_shape_test.go

@@ -89,6 +89,10 @@ func (s *OpensearchOpensearchClusterDataSourceCrud) SetData() error {
 		s.D.Set("data_node_host_ocpu_count", *s.Res.DataNodeHostOcpuCount)
 	}
 
+	if s.Res.DataNodeHostShape != nil {
+		s.D.Set("data_node_host_shape", *s.Res.DataNodeHostShape)
+	}
+
 	s.D.Set("data_node_host_type", s.Res.DataNodeHostType)
 
 	if s.Res.DataNodeStorageGB != nil {
@@ -137,6 +141,10 @@ func (s *OpensearchOpensearchClusterDataSourceCrud) SetData() error {
 		s.D.Set("master_node_host_ocpu_count", *s.Res.MasterNodeHostOcpuCount)
 	}
 
+	if s.Res.MasterNodeHostShape != nil {
+		s.D.Set("master_node_host_shape", *s.Res.MasterNodeHostShape)
+	}
+
 	s.D.Set("master_node_host_type", s.Res.MasterNodeHostType)
 
 	if s.Res.OpendashboardFqdn != nil {
@@ -155,6 +163,10 @@ func (s *OpensearchOpensearchClusterDataSourceCrud) SetData() error {
 		s.D.Set("opendashboard_node_host_ocpu_count", *s.Res.OpendashboardNodeHostOcpuCount)
 	}
 
+	if s.Res.OpendashboardNodeHostShape != nil {
+		s.D.Set("opendashboard_node_host_shape", *s.Res.OpendashboardNodeHostShape)
+	}
+
 	if s.Res.OpendashboardPrivateIp != nil {
 		s.D.Set("opendashboard_private_ip", *s.Res.OpendashboardPrivateIp)
 	}
@@ -181,6 +193,28 @@ func (s *OpensearchOpensearchClusterDataSourceCrud) SetData() error {
 	}
 	s.D.Set("reverse_connection_endpoints", reverseConnectionEndpoints)
 
+	if s.Res.SearchNodeCount != nil {
+		s.D.Set("search_node_count", *s.Res.SearchNodeCount)
+	}
+
+	if s.Res.SearchNodeHostMemoryGB != nil {
+		s.D.Set("search_node_host_memory_gb", *s.Res.SearchNodeHostMemoryGB)
+	}
+
+	if s.Res.SearchNodeHostOcpuCount != nil {
+		s.D.Set("search_node_host_ocpu_count", *s.Res.SearchNodeHostOcpuCount)
+	}
+
+	if s.Res.SearchNodeHostShape != nil {
+		s.D.Set("search_node_host_shape", *s.Res.SearchNodeHostShape)
+	}
+
+	s.D.Set("search_node_host_type", s.Res.SearchNodeHostType)
+
+	if s.Res.SearchNodeStorageGB != nil {
+		s.D.Set("search_node_storage_gb", *s.Res.SearchNodeStorageGB)
+	}
+
 	if s.Res.SecurityMasterUserName != nil {
 		s.D.Set("security_master_user_name", *s.Res.SecurityMasterUserName)
 	}
@@ -195,6 +229,10 @@ func (s *OpensearchOpensearchClusterDataSourceCrud) SetData() error {
 		s.D.Set("software_version", *s.Res.SoftwareVersion)
 	}
 
+	if s.Res.SecuritySamlConfig != nil {
+		s.D.Set("security_saml_config", *s.Res.SecuritySamlConfig)
+	}
+
 	s.D.Set("state", s.Res.LifecycleState)
 
 	if s.Res.SubnetCompartmentId != nil {

internal/service/opensearch/opensearch_opensearch_cluster_data_source.go

@@ -92,6 +92,10 @@ func (s *OpensearchOpensearchClusterPipelineDataSourceCrud) SetData() error {
 		s.D.Set("node_count", *s.Res.NodeCount)
 	}
 
+	if s.Res.NodeShape != nil {
+		s.D.Set("node_shape", *s.Res.NodeShape)
+	}
+
 	if s.Res.NsgId != nil {
 		s.D.Set("nsg_id", *s.Res.NsgId)
 	}

internal/service/opensearch/opensearch_opensearch_cluster_pipeline_data_source.go

@@ -79,6 +79,11 @@ func OpensearchOpensearchClusterPipelineResource() *schema.Resource {
 				Computed: true,
 				Elem:     schema.TypeString,
 			},
+			"node_shape": {
+				Type:     schema.TypeString,
+				Optional: true,
+				Computed: true,
+			},
 			"nsg_id": {
 				Type:     schema.TypeString,
 				Optional: true,
@@ -279,6 +284,11 @@ func (s *OpensearchOpensearchClusterPipelineResourceCrud) Create() error {
 		request.NodeCount = &tmp
 	}
 
+	if nodeShape, ok := s.D.GetOkExists("node_shape"); ok {
+		tmp := nodeShape.(string)
+		request.NodeShape = &tmp
+	}
+
 	if nsgId, ok := s.D.GetOkExists("nsg_id"); ok {
 		tmp := nsgId.(string)
 		request.NsgId = &tmp
@@ -531,6 +541,11 @@ func (s *OpensearchOpensearchClusterPipelineResourceCrud) Update() error {
 		request.NodeCount = &tmp
 	}
 
+	if nodeShape, ok := s.D.GetOkExists("node_shape"); ok {
+		tmp := nodeShape.(string)
+		request.NodeShape = &tmp
+	}
+
 	if nsgId, ok := s.D.GetOkExists("nsg_id"); ok {
 		tmp := nsgId.(string)
 		request.NsgId = &tmp
@@ -649,6 +664,10 @@ func (s *OpensearchOpensearchClusterPipelineResourceCrud) SetData() error {
 		s.D.Set("node_count", *s.Res.NodeCount)
 	}
 
+	if s.Res.NodeShape != nil {
+		s.D.Set("node_shape", *s.Res.NodeShape)
+	}
+
 	if s.Res.NsgId != nil {
 		s.D.Set("nsg_id", *s.Res.NsgId)
 	}
@@ -743,6 +762,10 @@ func OpensearchClusterPipelineSummaryToMap(obj oci_opensearch.OpensearchClusterP
 		result["node_count"] = int(*obj.NodeCount)
 	}
 
+	if obj.NodeShape != nil {
+		result["node_shape"] = string(*obj.NodeShape)
+	}
+
 	if obj.OcpuCount != nil {
 		result["ocpu_count"] = int(*obj.OcpuCount)
 	}