@hiiretail/gcp-infra-cli 0.103.1 → 0.104.0

package/generators/common-resources/firestore/generator.json

@@ -1,4 +1,4 @@
 {
   "name": "Firestore",
-  "description": "Create Firestore indexes"
+  "description": "Create Firestore database"
 }

package/generators/common-resources/firestore/index.js

@@ -9,27 +9,78 @@ module.exports = class extends BaseGenerator {
     const prompts = [
       {
         type: 'input',
-        name: 'serviceName',
+        name: 'databaseName',
         default: getTribeAndClanName().clan,
-        message: 'Enter your service name or leave blank for common database',
+        message: 'Please provide the database name or leave blank for common database.',
         validate: required,
       },
       {
+        type: 'list',
+        name: 'databaseType',
+        message: 'Select the type of database.',
+        default: 'FIRESTORE_NATIVE',
+        choices: ['FIRESTORE_NATIVE', 'DATASTORE_MODE'],
+      },
+      {
+        type: 'list',
+        name: 'databaseConcurrencyMode',
+        message: 'Select the database concurrency mode.',
+        default: 'OPTIMISTIC',
+        choices: ['OPTIMISTIC', 'PESSIMISTIC'],
+      },
+      {
+        type: 'list',
+        name: 'databaseBackupEnabled',
+        message: 'Enable database backup?',
+        default: 'true',
+        choices: ['true', 'false'],
+      },
+      {
+        when: (response) => response.databaseBackupEnabled === 'true',
+        type: 'list',
+        name: 'databaseBackupSchedule',
+        message: 'Select the backup schedule.',
+        default: 'daily-backup',
+        choices: ['daily-backup', 'weekly-backup'],
+      },
+      {
+        when: (response) => response.databaseBackupSchedule === 'weekly-backup',
+        type: 'list',
+        name: 'databaseBackupWeeklyRecurrence',
+        message: 'Please provide the day of the week the backup must be created.',
+        default: 'SUNDAY',
+        choices: ['MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY'],
+      },
+      {
+        when: (response) => response.databaseBackupEnabled === 'true',
         type: 'input',
-        name: 'collectionName',
-        message: 'Please provide the name of the collection being indexed',
+        name: 'databaseBackupRetention',
+        default: '259200s',
+        message: 'Please provide how long to keep the backups in seconds. ex. "259200s" is 3 days',
         validate: required,
       },
       {
         type: 'input',
-        name: 'fieldPath',
-        message: 'Please provide the name of the field',
+        name: 'databaseCollectionName',
+        message: 'Please provide the name of the collection being indexed.',
+        validate: required,
+      },
+      {
+        type: 'input',
+        name: 'databaseCollectionIndexName',
+        message: 'Please provide the name of the index.',
+        validate: required,
+      },
+      {
+        type: 'input',
+        name: 'databaseCollectionFieldPath',
+        message: 'Please provide the name of the field.',
         validate: required,
       },
       {
         type: 'list',
-        name: 'order',
-        message: 'Select the specified order for the field',
+        name: 'databaseCollectionFieldorder',
+        message: 'Select the specified order for the field.',
         default: 'ASCENDING',
         choices: ['ASCENDING', 'DESCENDING'],
       },
@@ -41,37 +92,46 @@ module.exports = class extends BaseGenerator {
   }
 
   writing() {
-    const {
-      serviceName,
-      collectionName,
-      fieldPath,
-      order,
-    } = this.answers;
+    const { databaseName, databaseCollectionName, ...rest } = this.answers;
 
     ['prod', 'staging'].forEach((env) => {
-      this.copyDir(
-        'firestore',
-        path.join('infra', env, 'firestore', serviceName),
-        {
-          ...this.answers,
-          env,
-          serviceName,
-          collectionName,
-          fieldPath,
-          order,
-        },
-      );
+      const context = {
+        ...rest,
+        databaseName,
+        databaseCollectionName,
+        env,
+      };
+      const baseDest = path.join('infra', env, 'firestore', databaseName);
+      const collectionDest = path.join(baseDest, 'indexes', databaseCollectionName);
+
+      // Files to copy at database root
+      ['spec.hcl', 'terragrunt.hcl'].forEach((file) => {
+        this.fs.copyTpl(
+          this.templatePath('firestore', file),
+          this.destinationPath(baseDest, file),
+          context,
+        );
+      });
+
+      // Files to copy inside indexes/<databaseCollectionName>/
+      ['indexes.yaml', 'terragrunt.hcl'].forEach((file) => {
+        this.fs.copyTpl(
+          this.templatePath('firestore/indexes', file),
+          this.destinationPath(collectionDest, file),
+          context,
+        );
+      });
     });
   }
 
   end() {
     const {
-      serviceName,
+      databaseName,
     } = this.answers;
 
-    const firestoreDir = path.join(serviceName);
+    const firestoreDir = path.join(databaseName);
     this.log(`
-${chalk.green(`Your Firestore index has now been created. To finalize your configuration, please continue
+${chalk.green(`Your Firestore database has now been created. To finalize your configuration, please continue
 with manual editing of the generated files.`)}
 ${chalk.green('1.')} Review and add more indexes as the firestore module requires at least two.
    \u2192 ${chalk.cyan(path.join(firestoreDir, 'indexes.yaml'))}

package/generators/common-resources/firestore/templates/firestore/{indexes.yaml → indexes/indexes.yaml}

@@ -3,8 +3,10 @@
 # it will be added automatically with the same direction as that of the last field defined.
 # If the final field in a composite index is not directional, the __name__ will be ordered "ASCENDING".
 indexes:
-  <%-collectionName%>:
-    - field_path: "<%-fieldPath%>"
-      order: "<%-order%>"
+  <%-databaseCollectionIndexName%>:
+    - field_path: "<%-databaseCollectionFieldPath%>"
+      array_config: "CONTAINS"
+      order: "<%-databaseCollectionFieldorder%>"
     - field_path: "__name__"
-      order: "<%-order%>"
+      order: "<%-databaseCollectionFieldorder%>"
+      array_config: null

package/generators/common-resources/firestore/templates/firestore/indexes/terragrunt.hcl

@@ -0,0 +1,27 @@
+# Terragrunt will copy the Terraform configurations specified by the source parameter, along with any files in the
+# working directory, into a temporary folder, and execute your Terraform commands in that folder.
+terraform {
+  source = "git::https://github.com/extenda/tf-module-gcp-firestore//modules/index?ref=v1.0.0"
+}
+
+# Include all settings from the root terragrunt.hcl file
+include {
+  path = find_in_parent_folders("terragrunt_root.hcl")
+}
+
+locals {
+  project_vars = read_terragrunt_config(find_in_parent_folders("project.hcl"))
+  collection = basename(get_terragrunt_dir())
+  database_name = basename(dirname(dirname(get_terragrunt_dir())))
+}
+
+# These are the variables we have to pass in to use the module specified in the terragrunt configuration above
+inputs = merge(
+  yamldecode(
+    file("${get_terragrunt_dir()}/indexes.yaml")),
+    {
+      project_id = local.project_vars.locals.project_id
+      database_name = local.database_name
+      collection = local.collection
+    }
+)

package/generators/common-resources/firestore/templates/firestore/spec.hcl

@@ -0,0 +1,31 @@
+locals {
+  ###################
+  # REQUIRED INPUTS #
+  ###################
+
+  database_location_id          = "europe-west1"
+  database_type                 = "<%- databaseType %>"
+  database_concurrency_mode     = "<%- databaseConcurrencyMode %>"
+
+  ###################
+  # OPTIONAL INPUTS #
+  ###################
+
+  # Description: Enables protection of a Firestore database from accidental deletion across all surfaces (API, gcloud, Cloud Console, and Terraform).
+  #Type: String
+  #Default: "DELETE_PROTECTION_DISABLED"
+  database_delete_protection_state      = "DELETE_PROTECTION_ENABLED"
+
+  <% if (databaseBackupEnabled === 'true') { %>
+  #Type: Bool
+  #Default: true
+  # Description: Firestore backup settings
+  database_backup_enabled                     = true
+  database_backup_schedule                    = "<%- databaseBackupSchedule %>"
+  <% if (databaseBackupSchedule === 'weekly-backup') { %>
+  database_backup_weekly_recurrence           = "<%- databaseBackupWeeklyRecurrence %>"
+  <% } %>
+  database_point_in_time_recovery_enablement  = "POINT_IN_TIME_RECOVERY_DISABLED"
+  database_backup_retention                   = "<%- databaseBackupRetention %>"
+  <% } %>
+}

package/generators/common-resources/firestore/templates/firestore/terragrunt.hcl

@@ -1,7 +1,7 @@
 # Terragrunt will copy the Terraform configurations specified by the source parameter, along with any files in the
 # working directory, into a temporary folder, and execute your Terraform commands in that folder.
 terraform {
-  source = "git::https://github.com/extenda/tf-module-gcp-firestore//?ref=v0.1.2"
+  source = "git::https://github.com/extenda/tf-module-gcp-firestore//modules/database?ref=v1.0.1"
 }
 
 # Include all settings from the root terragrunt.hcl file
@@ -10,16 +10,16 @@ include {
 }
 
 locals {
-  project_vars = read_terragrunt_config(find_in_parent_folders("project.hcl"))
-  collection = basename(get_terragrunt_dir())
+  project_vars  = read_terragrunt_config(find_in_parent_folders("project.hcl"))
+  database_name = basename(get_terragrunt_dir())
+  database_spec_vars = read_terragrunt_config("${get_terragrunt_dir()}/spec.hcl")
 }
 
 # These are the variables we have to pass in to use the module specified in the terragrunt configuration above
 inputs = merge(
-  yamldecode(
-    file("${get_terragrunt_dir()}/indexes.yaml")),
+    local.database_spec_vars.locals,
     {
-      project_id = local.project_vars.locals.project_id
-      collection = local.collection
+      project_id = local.project_vars.locals.project_id,
+      database_name = local.database_name
     }
 )

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hiiretail/gcp-infra-cli",
-  "version": "0.103.1",
+  "version": "0.104.0",
   "description": "Infrastructure as code generator for GCP.",
   "main": "src/cli.js",
   "bin": {