Skip to content

Commit

Permalink
minor textual changes to README and dedicated example
Browse files Browse the repository at this point in the history
Including:
* sync variables mentioned in README with actual example
* add example values for allow list name and CIDR IP
* remove limited access denotion for Azure clusters
* add link to terraform sensitive values recommendations in example
  comment.
  • Loading branch information
fantapop committed Mar 21, 2024
1 parent 17200d6 commit b4a8dfa
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 6 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added

- Realign variables used in the cockroach_dedicated_cluster with the README

- Removed mention of Limited Access for Azure clusters in README

- Added some example values for clarity in README

- The `user_role_grant` resource was added to allow management of a single role
grant. This resource will not affect other role grants. See
[user_role_grants](https://registry.terraform.io/providers/cockroachdb/cockroach/latest/docs/resources/user_role_grant)
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,8 @@ Before you use `terraform-provider-cockroach` you must [install Terraform](https
cloud_provider = "<cloud provider>"
cloud_provider_regions = ["<cloud provider region>"]
cluster_node_count = <number of nodes>
num_virtual_cpus = <number of VCPUs per node>
storage_gib = <storage in GiB>
machine_type = "<cloud provider machine type>"
allow_list_name = "<allow list name>"
cidr_ip = "<allow list CIDR IP>"
cidr_mask = <allow list CIDR prefix>
Expand All @@ -130,13 +130,13 @@ Before you use `terraform-provider-cockroach` you must [install Terraform](https
- `<database name>` is the name that will be used for the database created within the cluster. This database is in addition to defaultdb which is created by default.
- `<SQL user name>` is the name of the SQL user you want to create.
- `<SQL user password>` is the password for the SQL user you want to create.
- `<cloud provider>` is the cloud infrastructure provider. Possible values are `GCP` or `AWS` or `AZURE` (limited access).
- `<cloud provider>` is the cloud infrastructure provider. Possible values are `GCP` or `AWS` or `AZURE`.
- `<cloud provider region>` is the region code or codes for the cloud infrastructure provider. For multi-region clusters, separate each region with a comma.
- `<number of nodes>` is the number of nodes in each region. Cockroach Labs recommends at least 3 nodes per region, and the same number of nodes in each region for multi-region clusters.
- `<number of VCPUs per node>` is the number of virtual CPUS assigned to each node. This number will dictate which machine type is used for your cluster nodes. Recommendations for choosing this value can be found [here](https://www.cockroachlabs.com/docs/cockroachcloud/create-your-cluster#step-5-select-the-hardware-per-node).
- `<storage in GiB>` is the amount of storage specified in GiB.
- `<cloud provider machine type>` is the machine type for the cloud infrastructure provider.
- `<allow list name>` is the name for the IP allow list. Use a descriptive name to identify the IP allow list.
- `<allow list CIDR IP>` is the Classless Inter-Domain Routing (CIDR) IP address base.
- `<allow list name>` is the name for the IP allow list. Use a descriptive name to identify the IP allow list. (i.e. "allow all" or "home network")
- `<allow list CIDR IP>` is the Classless Inter-Domain Routing (CIDR) IP address base. (i.e. 123.123.123.123)
- `<allow list CIDR prefix>` is the CIDR prefix. This should be a number from 0 to 32. Use 32 to only allow the single IP Address passed in cidr_ip.
- `<OS name>` is the name of the OS that will be used to connect from for connection string output. Possible values are ('WINDOWS', 'MAC', and 'LINUX').

Expand Down
4 changes: 3 additions & 1 deletion examples/workflows/cockroach_dedicated_cluster/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,9 @@ data "cockroach_connection_string" "example" {

# Caution: Including the `password` field will result in
# the password showing up in plain text in the
# connection string output!
# connection string output! We recommend following terraform best practices
# for securing sensitive variables.
# https://developer.hashicorp.com/terraform/tutorials/configuration-language/sensitive-variables
#
# password = cockroach_sql_user.example.password

Expand Down

0 comments on commit b4a8dfa

Please sign in to comment.