Bigtable row affinity (#12090)

Author: djyau

mmv1/templates/terraform/custom_expand/bigtable_app_profile_routing.tmpl

@@ -23,5 +23,12 @@ func expand{{$.GetPrefix}}{{$.TitlelizeProperty}}(v interface{}, d tpgresource.T
 		obj.ClusterIds = append(obj.ClusterIds, id.(string))
 	}
 
+	affinity, _ := d.GetOkExists("row_affinity")
+	if affinity != nil && affinity == true {
+		obj.RowAffinity = &bigtableadmin.RowAffinity{}
+	} else {
+		obj.RowAffinity = nil
+	}
+
 	return obj, nil
 }

mmv1/templates/terraform/custom_flatten/bigtable_app_profile_routing.tmpl

@@ -11,10 +11,15 @@
 	limitations under the License.
 */ -}}
 func flatten{{$.GetPrefix}}{{$.TitlelizeProperty}}(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
+	d.Set("row_affinity", nil)
 	if v == nil {
 		return false
 	}
 
+	if v.(map[string]interface{})["rowAffinity"] != nil {
+                d.Set("row_affinity", true)
+        }
+
 	if v.(map[string]interface{})["clusterIds"] == nil {
 		return true
 	}

mmv1/templates/terraform/examples/bigtable_app_profile_row_affinity.tf.tmpl

@@ -0,0 +1,37 @@
+resource "google_bigtable_instance" "instance" {
+  name = "{{index $.Vars "instance_name"}}"
+  cluster {
+    cluster_id   = "cluster-1"
+    zone         = "us-central1-a"
+    num_nodes    = 3
+    storage_type = "HDD"
+  }
+  cluster {
+    cluster_id   = "cluster-2"
+    zone         = "us-central1-b"
+    num_nodes    = 3
+    storage_type = "HDD"
+  }
+  cluster {
+    cluster_id   = "cluster-3"
+    zone         = "us-central1-c"
+    num_nodes    = 3
+    storage_type = "HDD"
+  }
+
+  deletion_protection  = "{{index $.Vars "deletion_protection"}}"
+}
+
+resource "google_bigtable_app_profile" "ap" {
+  instance       = google_bigtable_instance.instance.name
+  app_profile_id = "{{index $.Vars "app_profile_name"}}"
+
+  // Requests will be routed to the following 2 clusters.
+  multi_cluster_routing_use_any = true
+  multi_cluster_routing_cluster_ids = ["cluster-1", "cluster-2"]
+
+  row_affinity = true
+
+  ignore_warnings = true
+}
+

mmv1/templates/terraform/extra_schema_entry/bigtable_app_profile.go.tmpl

@@ -18,4 +18,10 @@
 		Type: schema.TypeString,
 	},
 	ConflictsWith: []string{"single_cluster_routing"},
-},
+},
+"row_affinity": {
+	Type:          schema.TypeBool,
+    	Optional:      true,
+    	Description:   `Must be used with multi-cluster routing. If true, then this app profile will use row affinity sticky routing. With row affinity, Bigtable will route single row key requests based on the row key, rather than randomly. Instead, each row key will be assigned to a cluster by Cloud Bigtable, and will stick to that cluster. Choosing this option improves read-your-writes consistency for most requests under most circumstances, without sacrificing availability. Consistency is not guaranteed, as requests may still fail over between clusters in the event of errors or latency.`,
+    	ConflictsWith: []string{"single_cluster_routing"},
+},

mmv1/third_party/terraform/services/bigtable/resource_bigtable_app_profile_test.go

@@ -566,3 +566,99 @@ func TestAccBigtableAppProfile_updateStandardIsolationToDataBoost(t *testing.T)
 		},
 	})
 }
+
+func testAccBigtableAppProfile_updateRowAffinity(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"
+  multi_cluster_routing_use_any     = true
+  multi_cluster_routing_cluster_ids = ["%s", "%s2", "%s3"]
+  row_affinity = true
+  ignore_warnings               = true
+}
+`, instanceName, instanceName, instanceName, instanceName, instanceName, instanceName, instanceName)
+}
+
+func TestAccBigtableAppProfile_updateRowAffinity(t *testing.T) {
+	// bigtable instance does not use the shared HTTP client, this test creates an instance
+	acctest.SkipIfVcr(t)
+	t.Parallel()
+
+	instanceName := fmt.Sprintf("tf-test-%s", 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_updateMC2(instanceName),
+			},
+			{
+				ResourceName:            "google_bigtable_app_profile.ap",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"ignore_warnings"},
+			},
+			{
+				Config: testAccBigtableAppProfile_updateRowAffinity(instanceName),
+			},
+			{
+				ResourceName:            "google_bigtable_app_profile.ap",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"ignore_warnings"},
+			},
+			{
+				Config: testAccBigtableAppProfile_update1(instanceName),
+			},
+			{
+				ResourceName:            "google_bigtable_app_profile.ap",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"ignore_warnings"},
+			},
+			{
+				Config: testAccBigtableAppProfile_updateRowAffinity(instanceName),
+			},
+			{
+				ResourceName:            "google_bigtable_app_profile.ap",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"ignore_warnings"},
+			},
+			{
+				Config: testAccBigtableAppProfile_updateMC2(instanceName),
+			},
+			{
+				ResourceName:            "google_bigtable_app_profile.ap",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"ignore_warnings"},
+			},
+		},
+	})
+}