Skip to content

Commit b60ef69

Browse files
author
Chris Griggs
authored
Reformatting README for Terraform Registry
Hi there, renamed the path of the source to the module registry instead of the GitHub repo removed variables because all variable information is sourced from the variable and output files. If you can merge this into master and then add another release/tag so that the module registry will update. After that we'll be able to verify this module. Thanks Chris
1 parent da2612d commit b60ef69

File tree

1 file changed

+1
-35
lines changed

1 file changed

+1
-35
lines changed

README.md

Lines changed: 1 addition & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -8,46 +8,12 @@ See the Cloud SQL documentation for details: https://cloud.google.com/sql
88

99
```ruby
1010
module "mysql-db" {
11-
source = "github.com/GoogleCloudPlatform/terraform-google-sql-db"
11+
source = "GoogleCloudPlatform/sql-db/google"
1212
name = "example-mysql-${random_id.name.hex}"
1313
database_version = "MYSQL_5_6"
1414
}
1515
```
1616

17-
### Input variables
18-
19-
- `project` (optional): The project to deploy to, if not set the default provider project is used.
20-
- `region` (optional): Region for cloud resources. Default is `us-central1`.
21-
- `name` (required): Name for the database instance. Must be unique and cannot be reused for up to one week.
22-
- `database_version` (optional): The version of of the database. For example, `MYSQL_5_6` or `POSTGRES_9_6`. Default is `MYSQL_5_6`.
23-
- `tier` (optional): The machine tier (First Generation) or type (Second Generation). See this page for supported tiers and pricing: https://cloud.google.com/sql/pricing. Default is `db-f1-micro`.
24-
- `db_name` (optional): Name of the default database to create. Default is `default`.
25-
- `db_charset` (optional): The charset for the default database. Default is `""` which will revert to the default for the database version.
26-
- `db_collation` (optional): The collation for the default database. Example for MySQL databases: 'utf8', and Postgres: 'en_US.UTF8'". Default is `""` which will revert to the default for the database version.
27-
- `user_name` (optional): The name of the default user. Default is `default`.
28-
- `user_host` (optional): The host for the default user. Default is `"%"`. Set to `""` if database version is PostgreSQL.
29-
- `user_password` (optional): "The password for the default user. If not set, a random one will be generated and available in the `generated_user_password` output variable.
30-
- `activation_policy` (optional): This specifies when the instance should be active. Can be either `ALWAYS`, `NEVER` or `ON_DEMAND.`
31-
- `authorized_gae_applications` (optional): A list of Google App Engine (GAE) project names that are allowed to access this instance. Default is `[]`.
32-
- `disk_autoresize` (optional): Second Generation only. Configuration to increase storage size automatically. Default is `true`.
33-
- `disk_size` (optional): Second generation only. The size of data disk, in GB. Size of a running instance cannot be reduced but can be increased. Default is `10`.
34-
- `disk_type` (optional): Second generation only. The type of data disk: `PD_SSD` or `PD_HDD`. Default is `PD_SSD`.
35-
- `pricing_plan` (optional): First generation only. Pricing plan for this instance, can be one of `PER_USE` or `PACKAGE`. Default is `PER_USE`.
36-
- `replication_type` (optional): Replication type for this instance, can be one of `ASYNCHRONOUS` or `SYNCHRONOUS`. Default is `SYNCHRONOUS`.
37-
- `backup_configuration` (optional): The backup_configuration settings subblock for the database setings. Default is `{}`
38-
- `ip_configuration` (optional): The ip_configuration settings subblock. Default is `[{}]`.
39-
- `location_preference` (optional): The location_preference settings subblock. Default is `[]`.
40-
- `maintenance_window` (optional): The maintenance_window settings subblock. Defualt is `[]`.
41-
- `replica_configuration` (optional): The optional replica_configuration block for the database instance. Default is `[]`.
42-
43-
### Output variables
44-
45-
- `instance_name`: The name of the database instance.
46-
- `instance_address`: The IPv4 address of the master database instnace.
47-
- `instance_address_time_to_retire`: The time the master instance IP address will be reitred. RFC 3339 format.
48-
- `self_link`: Self link to the master instance.
49-
- `generated_user_password`: The auto generated default user password if no input password was provided.
50-
5117
## Resources created
5218

5319
- [`google_sql_database_instance.master`](https://www.terraform.io/docs/providers/google/r/sql_database_instance.html): The master database instance.

0 commit comments

Comments
 (0)