Bigtable: Add standard_isolation and priority fields for request prio…

…rities (#9442) (#16485) * Add standard_isolation and priority fields for request priorities. * Add required property to priority field. [upstream:9ce5b3608114571176692dbc9e88bca28c16b1fa] Signed-off-by: Modular Magician <[email protected]>
hashicorp · Nov 9, 2023 · 5a9ccc5 · 5a9ccc5
1 parent baf6942
commit 5a9ccc5
Show file tree

Hide file tree

Showing 5 changed files with 248 additions and 2 deletions.
diff --git a/.changelog/9442.txt b/.changelog/9442.txt
@@ -0,0 +1,3 @@
+```release-note:enhancement
+bigtable: added `standard_isolation` and `standard_isolation.priority` fields to `google_bigtable_app_profile` resource
+```
diff --git a/google/services/bigtable/resource_bigtable_app_profile.go b/google/services/bigtable/resource_bigtable_app_profile.go
@@ -30,6 +30,7 @@ import (
 
 	"github.com/hashicorp/terraform-provider-google/google/tpgresource"
 	transport_tpg "github.com/hashicorp/terraform-provider-google/google/transport"
+	"github.com/hashicorp/terraform-provider-google/google/verify"
 )
 
 func ResourceBigtableAppProfile() *schema.Resource {
@@ -108,6 +109,23 @@ It is unsafe to send these requests to the same table/row/column in multiple clu
 				},
 				ExactlyOneOf: []string{"single_cluster_routing", "multi_cluster_routing_use_any"},
 			},
+			"standard_isolation": {
+				Type:        schema.TypeList,
+				Computed:    true,
+				Optional:    true,
+				Description: `The standard options used for isolating this app profile's traffic from other use cases.`,
+				MaxItems:    1,
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						"priority": {
+							Type:         schema.TypeString,
+							Required:     true,
+							ValidateFunc: verify.ValidateEnum([]string{"PRIORITY_LOW", "PRIORITY_MEDIUM", "PRIORITY_HIGH"}),
+							Description:  `The priority of requests sent using this app profile. Possible values: ["PRIORITY_LOW", "PRIORITY_MEDIUM", "PRIORITY_HIGH"]`,
+						},
+					},
+				},
+			},
 			"name": {
 				Type:        schema.TypeString,
 				Computed:    true,
@@ -159,6 +177,12 @@ func resourceBigtableAppProfileCreate(d *schema.ResourceData, meta interface{})
 	} else if v, ok := d.GetOkExists("single_cluster_routing"); !tpgresource.IsEmptyValue(reflect.ValueOf(singleClusterRoutingProp)) && (ok || !reflect.DeepEqual(v, singleClusterRoutingProp)) {
 		obj["singleClusterRouting"] = singleClusterRoutingProp
 	}
+	standardIsolationProp, err := expandBigtableAppProfileStandardIsolation(d.Get("standard_isolation"), d, config)
+	if err != nil {
+		return err
+	} else if v, ok := d.GetOkExists("standard_isolation"); !tpgresource.IsEmptyValue(reflect.ValueOf(standardIsolationProp)) && (ok || !reflect.DeepEqual(v, standardIsolationProp)) {
+		obj["standardIsolation"] = standardIsolationProp
+	}
 
 	obj, err = resourceBigtableAppProfileEncoder(d, meta, obj)
 	if err != nil {
@@ -264,6 +288,9 @@ func resourceBigtableAppProfileRead(d *schema.ResourceData, meta interface{}) er
 	if err := d.Set("single_cluster_routing", flattenBigtableAppProfileSingleClusterRouting(res["singleClusterRouting"], d, config)); err != nil {
 		return fmt.Errorf("Error reading AppProfile: %s", err)
 	}
+	if err := d.Set("standard_isolation", flattenBigtableAppProfileStandardIsolation(res["standardIsolation"], d, config)); err != nil {
+		return fmt.Errorf("Error reading AppProfile: %s", err)
+	}
 
 	return nil
 }
@@ -302,6 +329,12 @@ func resourceBigtableAppProfileUpdate(d *schema.ResourceData, meta interface{})
 	} else if v, ok := d.GetOkExists("single_cluster_routing"); !tpgresource.IsEmptyValue(reflect.ValueOf(v)) && (ok || !reflect.DeepEqual(v, singleClusterRoutingProp)) {
 		obj["singleClusterRouting"] = singleClusterRoutingProp
 	}
+	standardIsolationProp, err := expandBigtableAppProfileStandardIsolation(d.Get("standard_isolation"), d, config)
+	if err != nil {
+		return err
+	} else if v, ok := d.GetOkExists("standard_isolation"); !tpgresource.IsEmptyValue(reflect.ValueOf(v)) && (ok || !reflect.DeepEqual(v, standardIsolationProp)) {
+		obj["standardIsolation"] = standardIsolationProp
+	}
 
 	obj, err = resourceBigtableAppProfileEncoder(d, meta, obj)
 	if err != nil {
@@ -327,6 +360,10 @@ func resourceBigtableAppProfileUpdate(d *schema.ResourceData, meta interface{})
 	if d.HasChange("single_cluster_routing") {
 		updateMask = append(updateMask, "singleClusterRouting")
 	}
+
+	if d.HasChange("standard_isolation") {
+		updateMask = append(updateMask, "standardIsolation")
+	}
 	// updateMask is a URL parameter but not present in the schema, so ReplaceVars
 	// won't set it
 	url, err = transport_tpg.AddQueryParams(url, map[string]string{"updateMask": strings.Join(updateMask, ",")})
@@ -502,6 +539,23 @@ func flattenBigtableAppProfileSingleClusterRoutingAllowTransactionalWrites(v int
 	return v
 }
 
+func flattenBigtableAppProfileStandardIsolation(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
+	if v == nil {
+		return nil
+	}
+	original := v.(map[string]interface{})
+	if len(original) == 0 {
+		return nil
+	}
+	transformed := make(map[string]interface{})
+	transformed["priority"] =
+		flattenBigtableAppProfileStandardIsolationPriority(original["priority"], d, config)
+	return []interface{}{transformed}
+}
+func flattenBigtableAppProfileStandardIsolationPriority(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
+	return v
+}
+
 func expandBigtableAppProfileDescription(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
 	return v, nil
 }
@@ -556,6 +610,29 @@ func expandBigtableAppProfileSingleClusterRoutingAllowTransactionalWrites(v inte
 	return v, nil
 }
 
+func expandBigtableAppProfileStandardIsolation(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
+	l := v.([]interface{})
+	if len(l) == 0 || l[0] == nil {
+		return nil, nil
+	}
+	raw := l[0]
+	original := raw.(map[string]interface{})
+	transformed := make(map[string]interface{})
+
+	transformedPriority, err := expandBigtableAppProfileStandardIsolationPriority(original["priority"], d, config)
+	if err != nil {
+		return nil, err
+	} else if val := reflect.ValueOf(transformedPriority); val.IsValid() && !tpgresource.IsEmptyValue(val) {
+		transformed["priority"] = transformedPriority
+	}
+
+	return transformed, nil
+}
+
+func expandBigtableAppProfileStandardIsolationPriority(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
+	return v, nil
+}
+
 func resourceBigtableAppProfileEncoder(d *schema.ResourceData, meta interface{}, obj map[string]interface{}) (map[string]interface{}, error) {
 	// Instance is a URL parameter only, so replace self-link/path with resource name only.
 	if err := d.Set("instance", tpgresource.GetResourceNameFromSelfLink(d.Get("instance").(string))); err != nil {

diff --git a/google/services/bigtable/resource_bigtable_app_profile_generated_test.go b/google/services/bigtable/resource_bigtable_app_profile_generated_test.go
@@ -78,7 +78,7 @@ resource "google_bigtable_instance" "instance" {
     zone         = "us-central1-c"
     num_nodes    = 3
     storage_type = "HDD"
-  }  
+  }
 
   deletion_protection  = "%{deletion_protection}"
 }
@@ -217,6 +217,66 @@ resource "google_bigtable_app_profile" "ap" {
 `, context)
 }
 
+func TestAccBigtableAppProfile_bigtableAppProfilePriorityExample(t *testing.T) {
+	acctest.SkipIfVcr(t)
+	t.Parallel()
+
+	context := map[string]interface{}{
+		"deletion_protection": false,
+		"random_suffix":       acctest.RandString(t, 10),
+	}
+
+	acctest.VcrTest(t, resource.TestCase{
+		PreCheck:                 func() { acctest.AccTestPreCheck(t) },
+		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
+		CheckDestroy:             testAccCheckBigtableAppProfileDestroyProducer(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccBigtableAppProfile_bigtableAppProfilePriorityExample(context),
+			},
+			{
+				ResourceName:            "google_bigtable_app_profile.ap",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"app_profile_id", "instance", "ignore_warnings", "ignore_warnings"},
+			},
+		},
+	})
+}
+
+func testAccBigtableAppProfile_bigtableAppProfilePriorityExample(context map[string]interface{}) string {
+	return acctest.Nprintf(`
+resource "google_bigtable_instance" "instance" {
+  name = "tf-test-bt-instance%{random_suffix}"
+  cluster {
+    cluster_id   = "cluster-1"
+    zone         = "us-central1-b"
+    num_nodes    = 3
+    storage_type = "HDD"
+  }
+
+  deletion_protection  = "%{deletion_protection}"
+}
+
+resource "google_bigtable_app_profile" "ap" {
+  instance       = google_bigtable_instance.instance.name
+  app_profile_id = "tf-test-bt-profile%{random_suffix}"
+
+  // Requests will be routed to the following cluster.
+  single_cluster_routing {
+    cluster_id                 = "cluster-1"
+    allow_transactional_writes = true
+  }
+
+  standard_isolation {
+    priority = "PRIORITY_LOW"
+  }
+
+  ignore_warnings = true
+}
+`, context)
+}
+
 func testAccCheckBigtableAppProfileDestroyProducer(t *testing.T) func(s *terraform.State) error {
 	return func(s *terraform.State) error {
 		for name, rs := range s.RootModule().Resources {

diff --git a/google/services/bigtable/resource_bigtable_app_profile_test.go b/google/services/bigtable/resource_bigtable_app_profile_test.go
@@ -40,6 +40,15 @@ func TestAccBigtableAppProfile_update(t *testing.T) {
 				ImportStateVerify:       true,
 				ImportStateVerifyIgnore: []string{"ignore_warnings"},
 			},
+			{
+				Config: testAccBigtableAppProfile_updatePriority(instanceName),
+			},
+			{
+				ResourceName:            "google_bigtable_app_profile.ap",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"ignore_warnings"},
+			},
 		},
 	})
 }
@@ -231,6 +240,53 @@ resource "google_bigtable_app_profile" "ap" {
 `, instanceName, instanceName, instanceName, instanceName, instanceName)
 }
 
+func testAccBigtableAppProfile_updatePriority(instanceName string) string {
+	return fmt.Sprintf(`
+resource "google_bigtable_instance" "instance" {
+  name = "%s"
+  cluster {
+    cluster_id   = "%s"
+    zone         = "us-central1-b"
+    num_nodes    = 1
+    storage_type = "HDD"
+  }
+
+  cluster {
+    cluster_id   = "%s2"
+    zone         = "us-central1-a"
+    num_nodes    = 1
+    storage_type = "HDD"
+  }
+
+  cluster {
+    cluster_id   = "%s3"
+    zone         = "us-central1-c"
+    num_nodes    = 1
+    storage_type = "HDD"
+  }
+
+  deletion_protection = false
+}
+
+resource "google_bigtable_app_profile" "ap" {
+  instance       = google_bigtable_instance.instance.id
+  app_profile_id = "test"
+  description    = "add a description"
+
+  single_cluster_routing {
+    cluster_id                 = %q
+    allow_transactional_writes = false
+  }
+
+  standard_isolation {
+    priority = "PRIORITY_MEDIUM"
+  }
+
+  ignore_warnings               = true
+}
+`, instanceName, instanceName, instanceName, instanceName, instanceName)
+}
+
 func testAccBigtableAppProfile_warningsProduced(instanceName string) string {
 	return fmt.Sprintf(`
 resource "google_bigtable_instance" "instance" {

diff --git a/website/docs/r/bigtable_app_profile.html.markdown b/website/docs/r/bigtable_app_profile.html.markdown
@@ -54,7 +54,7 @@ resource "google_bigtable_instance" "instance" {
     zone         = "us-central1-c"
     num_nodes    = 3
     storage_type = "HDD"
-  }  
+  }
 
   deletion_protection  = "true"
 }
@@ -147,6 +147,44 @@ resource "google_bigtable_app_profile" "ap" {
   ignore_warnings               = true
 }
 ```
+<div class = "oics-button" style="float: right; margin: 0 0 -15px">
+  <a href="https://console.cloud.google.com/cloudshell/open?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2Fterraform-google-modules%2Fdocs-examples.git&cloudshell_working_dir=bigtable_app_profile_priority&cloudshell_image=gcr.io%2Fcloudshell-images%2Fcloudshell%3Alatest&open_in_editor=main.tf&cloudshell_print=.%2Fmotd&cloudshell_tutorial=.%2Ftutorial.md" target="_blank">
+    <img alt="Open in Cloud Shell" src="//gstatic.com/cloudssh/images/open-btn.svg" style="max-height: 44px; margin: 32px auto; max-width: 100%;">
+  </a>
+</div>
+## Example Usage - Bigtable App Profile Priority
+
+
+```hcl
+resource "google_bigtable_instance" "instance" {
+  name = "bt-instance"
+  cluster {
+    cluster_id   = "cluster-1"
+    zone         = "us-central1-b"
+    num_nodes    = 3
+    storage_type = "HDD"
+  }
+
+  deletion_protection  = "true"
+}
+
+resource "google_bigtable_app_profile" "ap" {
+  instance       = google_bigtable_instance.instance.name
+  app_profile_id = "bt-profile"
+
+  // Requests will be routed to the following cluster.
+  single_cluster_routing {
+    cluster_id                 = "cluster-1"
+    allow_transactional_writes = true
+  }
+
+  standard_isolation {
+    priority = "PRIORITY_LOW"
+  }
+
+  ignore_warnings = true
+}
+```
 
 ## Argument Reference
 
@@ -176,6 +214,11 @@ The following arguments are supported:
   Use a single-cluster routing policy.
   Structure is [documented below](#nested_single_cluster_routing).
 
+* `standard_isolation` -
+  (Optional)
+  The standard options used for isolating this app profile's traffic from other use cases.
+  Structure is [documented below](#nested_standard_isolation).
+
 * `instance` -
   (Optional)
   The name of the instance to create the app profile within.
@@ -199,6 +242,13 @@ The following arguments are supported:
   If true, CheckAndMutateRow and ReadModifyWriteRow requests are allowed by this app profile.
   It is unsafe to send these requests to the same table/row/column in multiple clusters.
 
+<a name="nested_standard_isolation"></a>The `standard_isolation` block supports:
+
+* `priority` -
+  (Required)
+  The priority of requests sent using this app profile.
+  Possible values are: `PRIORITY_LOW`, `PRIORITY_MEDIUM`, `PRIORITY_HIGH`.
+
 ## Attributes Reference
 
 In addition to the arguments listed above, the following computed attributes are exported: