Skip to content

Commit f7666e2

Browse files
Fix documentation for Alloydb Instance availability_type (#8172) (#5792)
Signed-off-by: Modular Magician <[email protected]> Co-authored-by: Riley Karson <[email protected]>
1 parent 8bc5438 commit f7666e2

File tree

3 files changed

+15
-2
lines changed

3 files changed

+15
-2
lines changed

.changelog/8172.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
```release-note:none
2+
Fix documentation for Alloydb Instance availability_type
3+
```

google-beta/services/alloydb/resource_alloydb_instance.go

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,12 @@ func ResourceAlloydbInstance() *schema.Resource {
8181
Computed: true,
8282
Optional: true,
8383
ValidateFunc: verify.ValidateEnum([]string{"AVAILABILITY_TYPE_UNSPECIFIED", "ZONAL", "REGIONAL", ""}),
84-
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"]`,
84+
Description: `'Availability type of an Instance. Defaults to REGIONAL for both primary and read instances.
85+
Note that primary and read instances can have different availability types.
86+
Only READ_POOL instance supports ZONAL type. Users can't specify the zone for READ_POOL instance.
87+
Zone is automatically chosen from the list of zones in the region specified.
88+
Read pool of size 1 can only have zonal availability. Read pools with node count of 2 or more
89+
can have regional availability (nodes are present in 2 or more zones in a region).' Possible values: ["AVAILABILITY_TYPE_UNSPECIFIED", "ZONAL", "REGIONAL"]`,
8590
},
8691
"database_flags": {
8792
Type: schema.TypeMap,

website/docs/r/alloydb_instance.html.markdown

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,12 @@ The following arguments are supported:
125125

126126
* `availability_type` -
127127
(Optional)
128-
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.
128+
'Availability type of an Instance. Defaults to REGIONAL for both primary and read instances.
129+
Note that primary and read instances can have different availability types.
130+
Only READ_POOL instance supports ZONAL type. Users can't specify the zone for READ_POOL instance.
131+
Zone is automatically chosen from the list of zones in the region specified.
132+
Read pool of size 1 can only have zonal availability. Read pools with node count of 2 or more
133+
can have regional availability (nodes are present in 2 or more zones in a region).'
129134
Possible values are: `AVAILABILITY_TYPE_UNSPECIFIED`, `ZONAL`, `REGIONAL`.
130135

131136
* `read_pool_config` -

0 commit comments

Comments
 (0)