feat: added cloudsql serverless_export (#530)

Co-authored-by: Imran Nayer <[email protected]>

Author: poligraph

examples/postgresql-backup-provided-service-account/README.md

@@ -5,6 +5,7 @@ This example shows how to create:
 - a PostgreSQL Cloud SQL Instance
 - A GCS Bucket for storing the Backup
 - The Workflows for exports (external backups) and (internal) backups
+- The Workflows with serverless export
 
 ## Run Terraform
 

examples/postgresql-backup-provided-service-account/main.tf

@@ -53,6 +53,7 @@ module "backup" {
   backup_retention_time = 1
   backup_schedule       = "5 * * * *"
   export_schedule       = "10 * * * *"
+  use_serverless_export = true
   service_account       = "${data.google_project.test_project.number}[email protected]"
 }
 

modules/backup/README.md

@@ -71,6 +71,7 @@ fetch workflows.googleapis.com/Workflow
 | sql\_instance | The name of the SQL instance to backup | `string` | n/a | yes |
 | sql\_instance\_replica | The name of the SQL instance replica to export | `string` | `null` | no |
 | unique\_suffix | Unique suffix to add to scheduler jobs and workflows names. | `string` | `""` | no |
+| use\_serverless\_export | Whether to use serverless export for DB export | `bool` | `false` | no |
 | use\_sql\_instance\_replica\_in\_exporter | Whether or not to use replica instance on exporter workflow. | `bool` | `false` | no |
 
 ## Outputs

modules/backup/main.tf

@@ -113,6 +113,7 @@ resource "google_workflows_workflow" "sql_export" {
     enableConnectorParams  = var.enable_connector_params
     connectorParamsTimeout = var.connector_params_timeout
     logDbName              = var.log_db_name_to_export
+    serverlessExport       = var.use_serverless_export
   })
 }
 

modules/backup/metadata.yaml

@@ -102,6 +102,10 @@ spec:
     description: Unique suffix to add to scheduler jobs and workflows names.
     type: string
     default: ""
+  - name: use_serverless_export
+    description: Whether to use serverless export for DB export
+    type: bool
+    default: false
   outputs:
   - name: backup_workflow_name
     description: The name for internal backup workflow

modules/backup/templates/export.yaml.tftpl

@@ -61,6 +61,7 @@ main:
                 body:
                   exportContext:
                     databases: [$${database}]
+                    offload: "${serverlessExport}"
                     uri: $${"${gcsBucket}/${instanceName}-" + database + "-" + backupTime + %{ if compressExport == true }".sql.gz"%{ else }".sql"%{ endif }}
 %{ endif }
 
@@ -109,5 +110,6 @@ main:
         body:
           exportContext:
             databases: $${databases}
+            offload: "${serverlessExport}"
             uri: $${"${gcsBucket}/${instanceName}-" + backupTime + %{ if compressExport == true }".sql.gz"%{ else }".sql"%{ endif }}
 %{ endif }

modules/backup/variables.tf

@@ -132,3 +132,9 @@ variable "sql_instance_replica" {
   type        = string
   default     = null
 }
+
+variable "use_serverless_export" {
+  description = "Whether to use serverless export for DB export"
+  type        = bool
+  default     = false
+}