Small tweaks

README.md

@@ -53,7 +53,7 @@ The module has been tested with:
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | <a name="input_database_config"></a> [database\_config](#input\_database\_config) | Cloud SQL configuration | <pre>object({<br/>    tier     = optional(string, "db-custom-2-4096")<br/>    version  = optional(string, "POSTGRES_15")<br/>    password = string<br/>    username = optional(string, "materialize")<br/>    db_name  = optional(string, "materialize")<br/>  })</pre> | n/a | yes |
-| <a name="input_gke_config"></a> [gke\_config](#input\_gke\_config) | GKE cluster configuration. Make sure to use large enough machine types for your Materialize instances. | <pre>object({<br/>    node_count     = number<br/>    machine_type   = string<br/>    disk_size_gb   = number<br/>    min_nodes      = number<br/>    max_nodes      = number<br/>    node_locations = list(string)<br/>  })</pre> | <pre>{<br/>  "disk_size_gb": 50,<br/>  "machine_type": "e2-standard-4",<br/>  "max_nodes": 2,<br/>  "min_nodes": 1,<br/>  "node_count": 1,<br/>  "node_locations": []<br/>}</pre> | no |
+| <a name="input_gke_config"></a> [gke\_config](#input\_gke\_config) | GKE cluster configuration. Make sure to use large enough machine types for your Materialize instances. | <pre>object({<br/>    node_count     = number<br/>    machine_type   = string<br/>    disk_size_gb   = number<br/>    min_nodes      = number<br/>    max_nodes      = number<br/>  })</pre> | <pre>{<br/>  "disk_size_gb": 50,<br/>  "machine_type": "e2-standard-4",<br/>  "max_nodes": 2,<br/>  "min_nodes": 1,<br/>  "node_count": 1<br/>}</pre> | no |
 | <a name="input_helm_chart"></a> [helm\_chart](#input\_helm\_chart) | Chart name from repository or local path to chart. For local charts, set the path to the chart directory. | `string` | `"materialize-operator"` | no |
 | <a name="input_helm_values"></a> [helm\_values](#input\_helm\_values) | Values to pass to the Helm chart | `any` | `{}` | no |
 | <a name="input_install_materialize_operator"></a> [install\_materialize\_operator](#input\_install\_materialize\_operator) | Whether to install the Materialize operator | `bool` | `true` | no |

examples/simple/README.md

@@ -98,27 +98,31 @@ Access the `examples/simple` directory and follow these steps:
    ```bash
    terraform plan \
      -var project_id="your-project-id" \
-     -var database_password="your-secure-password"
+     -var prefix="your-resource-prefix" \
+     -var region="us-central1"
    ```
 
    Alternatively, you can set these variables in a `terraform.tfvars` file:
    ```bash
     project_id = "your-project-id"
-    database_password = "your-secure-password"
+    prefix = "your-resource-prefix"
+    region="your-region"
     ```
 
 3. Apply the changes:
    ```bash
    terraform apply \
      -var project_id="your-project-id" \
-     -var database_password="your-secure-password"
+     -var prefix="your-resource-prefix" \
+     -var region="us-central1"
    ```
 
 4. When you're done, clean up:
    ```bash
    terraform destroy \
      -var project_id="your-project-id" \
-     -var database_password="your-secure-password"
+     -var prefix="your-resource-prefix" \
+     -var region="us-central1"
    ```
 
 5. The `connection_strings` output will provide you with the connection strings for metadata and persistence backends.

examples/simple/main.tf

@@ -6,6 +6,10 @@ terraform {
       source  = "hashicorp/google"
       version = ">= 6.0"
     }
+    random = {
+      source  = "hashicorp/random"
+      version = "~> 3.0"
+    }
   }
 }
 
@@ -23,12 +27,12 @@ module "materialize" {
 
   project_id = var.project_id
   region     = var.region
-  prefix     = "mz-simple"
+  prefix     = var.prefix
 
   database_config = {
     tier     = "db-custom-2-4096"
     version  = "POSTGRES_15"
-    password = var.database_password
+    password = random_password.pass.result
   }
 
   labels = {
@@ -53,11 +57,16 @@ variable "region" {
   default     = "us-central1"
 }
 
-variable "database_password" {
-  description = "Password for Cloud SQL database user"
-  default     = "your-strong-password"
+variable "prefix" {
+  description = "Used to prefix the names of the resources"
   type        = string
-  sensitive   = true
+  default     = "mz-simple"
+}
+
+
+resource "random_password" "pass" {
+  length  = 20
+  special = false
 }
 
 output "gke_cluster" {

examples/simple/terraform.tfvars.example

@@ -1,5 +1,5 @@
 project_id = "enter-your-gcp-project-id"
-database_password  = "enter-secure-password"
+prefix  = "enter-a-prefix" // e.g., mz-simple, my-mz-demo
 region = "us-central1"
 
 # Once the operator is installed, you can define your Materialize instances here.

main.tf

@@ -5,6 +5,12 @@ locals {
   })
 }
 
+
+provider "google" {
+  project = var.project_id
+  region  = var.region
+}
+
 module "gke" {
   source = "./modules/gke"
 
@@ -125,7 +131,7 @@ locals {
       metadata_backend_url = format(
         "postgres://%s:%s@%s:5432/%s?sslmode=disable",
         var.database_config.username,
-        var.database_config.password,
+        urlencode(var.database_config.password),
         module.database.private_ip,
         coalesce(instance.database_name, instance.name)
       )

terraform.tfvars.example

@@ -31,7 +31,7 @@ namespace = "materialize"
 
 # Resource Labels
 labels = {
-  environment = "production"
+  environment = "test"
   team        = "data-platform"
   managed_by  = "terraform"
   cost_center = "12345"

variables.tf

@@ -32,20 +32,18 @@ variable "network_config" {
 variable "gke_config" {
   description = "GKE cluster configuration. Make sure to use large enough machine types for your Materialize instances."
   type = object({
-    node_count     = number
-    machine_type   = string
-    disk_size_gb   = number
-    min_nodes      = number
-    max_nodes      = number
-    node_locations = list(string)
+    node_count   = number
+    machine_type = string
+    disk_size_gb = number
+    min_nodes    = number
+    max_nodes    = number
   })
   default = {
-    node_count     = 1
-    machine_type   = "e2-standard-4"
-    disk_size_gb   = 50
-    min_nodes      = 1
-    max_nodes      = 2
-    node_locations = []
+    node_count   = 1
+    machine_type = "e2-standard-4"
+    disk_size_gb = 50
+    min_nodes    = 1
+    max_nodes    = 2
   }
 }