Update GC policy doc (#6668) (#12762)

Signed-off-by: Modular Magician <magic-modules@google.com> Signed-off-by: Modular Magician <magic-modules@google.com>
hashicorp · Oct 11, 2022 · b56aa65 · b56aa65
1 parent aadb0d3
commit b56aa65
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/.changelog/6668.txt b/.changelog/6668.txt
@@ -0,0 +1,3 @@
+```release-note:none
+bigtable: updated Cloud Bigtable GC policy documentation
+```
diff --git a/website/docs/r/bigtable_gc_policy.html.markdown b/website/docs/r/bigtable_gc_policy.html.markdown
@@ -11,6 +11,14 @@ Creates a Google Cloud Bigtable GC Policy inside a family. For more information
 [the official documentation](https://cloud.google.com/bigtable/) and
 [API](https://cloud.google.com/bigtable/docs/go/reference).
 
+-> **Warning**: We don't recommend having multiple GC policies for the same column
+family as it may result in unexpected behavior.
+
+-> **Note**: GC policies associated with a replicated table cannot be destroyed directly.
+Destroying a GC policy is translated into never perform garbage collection, this is
+considered relaxing from pure age-based or version-based GC policy, hence not allowed.
+The workaround is unreplicating the instance first by updating the instance to have one
+cluster.
 
 ## Example Usage