Fix documentation for Alloydb Instance availability_type (#8172) (#14942

) Signed-off-by: Modular Magician <[email protected]> Co-authored-by: Riley Karson <[email protected]>
hashicorp · Jun 20, 2023 · d8f48dc · d8f48dc
1 parent f1a8b7c
commit d8f48dc
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/.changelog/8172.txt b/.changelog/8172.txt
@@ -0,0 +1,3 @@
+```release-note:none
+Fix documentation for Alloydb Instance availability_type
+```
diff --git a/google/services/alloydb/resource_alloydb_instance.go b/google/services/alloydb/resource_alloydb_instance.go
@@ -81,7 +81,12 @@ func ResourceAlloydbInstance() *schema.Resource {
 				Computed:     true,
 				Optional:     true,
 				ValidateFunc: verify.ValidateEnum([]string{"AVAILABILITY_TYPE_UNSPECIFIED", "ZONAL", "REGIONAL", ""}),
-				Description:  `Availability type of an Instance. Defaults to REGIONAL for both primary and read instances. Note that primary and read instances can have different availability types. Possible values: ["AVAILABILITY_TYPE_UNSPECIFIED", "ZONAL", "REGIONAL"]`,
+				Description: `'Availability type of an Instance. Defaults to REGIONAL for both primary and read instances.
+Note that primary and read instances can have different availability types.
+Only READ_POOL instance supports ZONAL type. Users can't specify the zone for READ_POOL instance.
+Zone is automatically chosen from the list of zones in the region specified.
+Read pool of size 1 can only have zonal availability. Read pools with node count of 2 or more
+can have regional availability (nodes are present in 2 or more zones in a region).' Possible values: ["AVAILABILITY_TYPE_UNSPECIFIED", "ZONAL", "REGIONAL"]`,
 			},
 			"database_flags": {
 				Type:        schema.TypeMap,

diff --git a/website/docs/r/alloydb_instance.html.markdown b/website/docs/r/alloydb_instance.html.markdown
@@ -125,7 +125,12 @@ The following arguments are supported:
 
 * `availability_type` -
   (Optional)
-  Availability type of an Instance. Defaults to REGIONAL for both primary and read instances. Note that primary and read instances can have different availability types.
+  'Availability type of an Instance. Defaults to REGIONAL for both primary and read instances.
+  Note that primary and read instances can have different availability types.
+  Only READ_POOL instance supports ZONAL type. Users can't specify the zone for READ_POOL instance.
+  Zone is automatically chosen from the list of zones in the region specified.
+  Read pool of size 1 can only have zonal availability. Read pools with node count of 2 or more
+  can have regional availability (nodes are present in 2 or more zones in a region).'
   Possible values are: `AVAILABILITY_TYPE_UNSPECIFIED`, `ZONAL`, `REGIONAL`.
 
 * `read_pool_config` -