Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronblevy committed Jan 2, 2024
1 parent 23eb7d3 commit 3f64759
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/resources/service.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The change has been taken into account but must still be propagated. You can run
- `memory_gb` (Number) Memory GB
- `milli_cpu` (Number) Milli CPU
- `name` (String) Service Name is the configurable name assigned to this resource. If none is provided, a default will be generated by the provider.
- `read_replica_source` (String) Enable Read Replica
- `read_replica_source` (String) Create a read replica from the provided source database. This database will be created in the same region as the source database
- `region_code` (String) The region for this service.
- `storage_gb` (Number, Deprecated) Deprecated: Storage GB
- `timeouts` (Attributes) (see [below for nested schema](#nestedatt--timeouts))
Expand Down
3 changes: 3 additions & 0 deletions examples/resources/resource.tf
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,7 @@ resource "timescale_service" "test" {
# milli_cpu = 1000
# memory_gb = 4
# region_code = ""

# Note: if read_replica_source is set, region_code should be omitted. It will be set to the region of the source db.
# read_replica_source = ""
}
4 changes: 2 additions & 2 deletions internal/provider/service_resource.go
Original file line number Diff line number Diff line change
Expand Up @@ -126,8 +126,8 @@ The change has been taken into account but must still be propagated. You can run
Default: booldefault.StaticBool(DefaultEnableHAReplica),
},
"read_replica_source": schema.StringAttribute{
MarkdownDescription: "Enable Read Replica",
Description: "Enable Read Replica",
MarkdownDescription: "Create a read replica from the provided source database. This database will be created in the same region as the source database",
Description: "Create a read replica from the provided source database. This database will be created in the same region as the source database",
Optional: true,
},
"storage_gb": schema.Int64Attribute{
Expand Down

0 comments on commit 3f64759

Please sign in to comment.