Bigtable: Mark GC policy legacy fields as not recommended (#6577) (#4919)

* Mark GC policy legacy fields deprecated

* Mark fields as deprecated in comments

* Revert back to really deprecating the fields.

* Update doc to recommend gc_rules.

Signed-off-by: Modular Magician <[email protected]>

Signed-off-by: Modular Magician <[email protected]>

Author: modular-magician

.changelog/6577.txt

@@ -0,0 +1,3 @@
+```release-note:none
+
+```

google-beta/resource_bigtable_gc_policy.go

@@ -103,7 +103,7 @@ func resourceBigtableGCPolicy() *schema.Resource {
 				Type:          schema.TypeString,
 				Optional:      true,
 				ForceNew:      true,
-				Description:   `If multiple policies are set, you should choose between UNION OR INTERSECTION.`,
+				Description:   `NOTE: 'gc_rules' is more flexible, and should be preferred over this field for new resources. This field may be deprecated in the future. If multiple policies are set, you should choose between UNION OR INTERSECTION.`,
 				ValidateFunc:  validation.StringInSlice([]string{GCPolicyModeIntersection, GCPolicyModeUnion}, false),
 				ConflictsWith: []string{"gc_rules"},
 			},
@@ -112,7 +112,7 @@ func resourceBigtableGCPolicy() *schema.Resource {
 				Type:        schema.TypeList,
 				Optional:    true,
 				ForceNew:    true,
-				Description: `GC policy that applies to all cells older than the given age.`,
+				Description: `NOTE: 'gc_rules' is more flexible, and should be preferred over this field for new resources. This field may be deprecated in the future. GC policy that applies to all cells older than the given age.`,
 				MaxItems:    1,
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
@@ -143,7 +143,7 @@ func resourceBigtableGCPolicy() *schema.Resource {
 				Type:        schema.TypeList,
 				Optional:    true,
 				ForceNew:    true,
-				Description: `GC policy that applies to all versions of a cell except for the most recent.`,
+				Description: `NOTE: 'gc_rules' is more flexible, and should be preferred over this field for new resources. This field may be deprecated in the future. GC policy that applies to all versions of a cell except for the most recent.`,
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"number": {

website/docs/r/bigtable_gc_policy.html.markdown

@@ -47,9 +47,16 @@ resource "google_bigtable_gc_policy" "policy" {
   column_family = "name"
   deletion_policy = "ABANDON"
 
-  max_age {
-    duration = "168h"
+
+  gc_rules = <<EOF
+  {
+    "rules": [
+      {
+        "max_age": "168h"
+      }
+    ]
   }
+  EOF
 }
 ```
 
@@ -62,21 +69,23 @@ resource "google_bigtable_gc_policy" "policy" {
   column_family = "name"
   deletion_policy = "ABANDON"
 
-  mode = "UNION"
-
-  max_age {
-    duration = "168h" # 7 days
-  }
-
-  max_version {
-    number = 10
+  gc_rules = <<EOF
+  {
+    "mode": "union",
+    "rules": [
+      {
+        "max_age": "168h"
+      },
+      {
+        "max_version": 10
+      }
+    ]
   }
+  EOF
 }
 ```
 
-For complex, nested policies, an optional `gc_rules` field are supported. This field
-conflicts with `mode`, `max_age` and `max_version`. This field is a serialized JSON
-string. Example:
+An example of more complex GC policy:
 ```hcl
 resource "google_bigtable_instance" "instance" {
   name = "instance_name"
@@ -106,27 +115,26 @@ resource "google_bigtable_gc_policy" "policy" {
   deletion_policy = "ABANDON"
 
   gc_rules = <<EOF
-{
-  "mode": "union",
-  "rules": [
-    {
-      "max_age": "10h"
-    },
-    {
-      "mode": "intersection",
-      "rules": [
-        {
-          "max_age": "2h"
-        },
-        {
-          "max_version": 2
-        }
-      ]
-    }
-  ]
-}
-EOF
-
+  {
+    "mode": "union",
+    "rules": [
+      {
+        "max_age": "10h"
+      },
+      {
+        "mode": "intersection",
+        "rules": [
+          {
+            "max_age": "2h"
+          },
+          {
+            "max_version": 2
+          }
+        ]
+      }
+    ]
+  }
+  EOF
 }
 ```
 This is equivalent to running the following `cbt` command: