@hiiretail/gcp-infra-cli 0.62.4 → 0.65.0

package/generators/init/clan-infra/templates/infra/common.hcl

@@ -5,7 +5,11 @@ locals {
   clan_name              = "<%-clan%>"
   region                 = "europe-west1"
   clan_group_email       = "tribe-<%-tribe%>-<%-clan%>@extendaretail.com"
-  clan_slack_channels    = ["#<%-tribe%>-<%-clan%>-monitor"]
+  clan_slack_channels    = [
+    {
+      name = "#<%-tribe%>-<%-clan%>-monitor"
+    }
+  ]
   project_id_slack_token = "tf-admin-90301274"
   cost_center            = "<%-costCenter%>"
 }

package/generators/resources/cloudsql/index.js

@@ -42,6 +42,13 @@ module.exports = class extends BaseGenerator {
         store: true,
         default: 10,
       },
+      {
+        type: 'list',
+        name: 'enableBackups',
+        message: 'Enable Databases backup?',
+        default: true,
+        choices: [true, false],
+      },
     ];
 
     return this.prompt(prompts).then((props) => {

package/generators/resources/cloudsql/templates/monitoring/cloud-sql/terragrunt.hcl

@@ -12,7 +12,7 @@ include {
 dependency "notification_channels" {
   config_path  = "../notification-channels"
   mock_outputs = {
-    notification_channel_name = ["dummy-channel"]
+    notification_channels = ["dummy-channel"]
   }
 }
 
@@ -25,7 +25,7 @@ locals {
 inputs = merge(local.project_vars.locals, local.common_vars.locals,
   {
     clan_project_id       = local.project_vars.locals.project_id
-    notification_channels = dependency.notification_channels.outputs.notification_channel_name
+    notification_channels = dependency.notification_channels.outputs.notification_channels
     cloudsql_monitoring   = true
     user_labels           = {
       cc = local.common_vars.locals.cost_center

package/generators/resources/cloudsql/templates/mssql/instance/spec.hcl

@@ -64,4 +64,13 @@ locals {
   #Type: String
   #Default: "PD_SSD"
   # disk_type = "PD_SSD"
+
+  #Description: The database backup configuration.
+  #Type: Map
+  backup_configuration = {
+    enabled                        = <%- enableBackups %>
+    binary_log_enabled             = enabled
+    start_time                     = "04:00"
+    point_in_time_recovery_enabled = true
+  }
 }

package/generators/resources/cloudsql/templates/mysql/instance/spec.hcl

@@ -60,4 +60,14 @@ locals {
   #Type: String
   #Default: "PD_SSD"
   # disk_type = "PD_SSD"
+
+  #Description: The database backup configuration.
+  #Type: Map
+  #Default: missing
+  backup_configuration = {
+    enabled                        = <%- enableBackups %>
+    binary_log_enabled             = true
+    start_time                     = "04:00"
+    location                       = "europe-west1"
+  }
 }

package/generators/resources/cloudsql/templates/postgres/instance/spec.hcl

@@ -60,4 +60,14 @@ locals {
   #Type: String
   #Default: "PD_SSD"
   # disk_type = "PD_SSD"
+
+  #Description: The database backup configuration.
+  #Type: Map
+  #Default: missing
+  backup_configuration = {
+    enabled                        = <%- enableBackups %>
+    start_time                     = "04:00"
+    location                       = "europe-west1"
+    point_in_time_recovery_enabled = true
+  }
 }

package/generators/resources/firestore/templates/monitoring/firestore/terragrunt.hcl

@@ -12,7 +12,7 @@ include {
 dependency "notification_channels" {
   config_path  = "../notification-channels"
   mock_outputs = {
-    notification_channel_name = ["dummy-channel"]
+    notification_channels = ["dummy-channel"]
   }
 }
 
@@ -25,7 +25,7 @@ locals {
 inputs = merge(local.project_vars.locals, local.common_vars.locals,
   {
     clan_project_id       = local.project_vars.locals.project_id
-    notification_channels = dependency.notification_channels.outputs.notification_channel_name
+    notification_channels = dependency.notification_channels.outputs.notification_channels
     firestore_monitoring  = true
     user_labels           = {
       cc = local.common_vars.locals.cost_center

package/generators/resources/memorystore/templates/monitoring/memorystore/terragrunt.hcl

@@ -12,7 +12,7 @@ include {
 dependency "notification_channels" {
   config_path  = "../notification-channels"
   mock_outputs = {
-    notification_channel_name = ["dummy-channel"]
+    notification_channels = ["dummy-channel"]
   }
 }
 
@@ -25,7 +25,7 @@ locals {
 inputs = merge(local.project_vars.locals, local.common_vars.locals,
   {
     clan_project_id        = local.project_vars.locals.project_id
-    notification_channels  = dependency.notification_channels.outputs.notification_channel_name
+    notification_channels  = dependency.notification_channels.outputs.notification_channels
     memorystore_monitoring = true
     user_labels            = {
       cc = local.common_vars.locals.cost_center

package/generators/resources/monitoring/templates/cloudfunction/terragrunt.hcl

@@ -12,7 +12,7 @@ include {
 dependency "notification_channels" {
   config_path  = "../notification-channels"
   mock_outputs = {
-    notification_channel_name = ["dummy-channel"]
+    notification_channels = ["dummy-channel"]
   }
 }
 
@@ -25,7 +25,7 @@ locals {
 inputs = merge(local.project_vars.locals, local.common_vars.locals,
   {
     clan_project_id          = local.project_vars.locals.project_id
-    notification_channels    = dependency.notification_channels.outputs.notification_channel_name
+    notification_channels    = dependency.notification_channels.outputs.notification_channels
     cloudfunction_monitoring = true
     user_labels           = {
       cc = local.common_vars.locals.cost_center

package/generators/resources/monitoring/templates/cloudrun/terragrunt.hcl

@@ -12,7 +12,7 @@ include {
 dependency "notification_channels" {
   config_path  = "../notification-channels"
   mock_outputs = {
-    notification_channel_name = ["dummy-channel"]
+    notification_channels = ["dummy-channel"]
   }
 }
 
@@ -25,7 +25,7 @@ locals {
 inputs = merge(local.project_vars.locals, local.common_vars.locals,
   {
     clan_project_id       = local.project_vars.locals.project_id
-    notification_channels = dependency.notification_channels.outputs.notification_channel_name
+    notification_channels = dependency.notification_channels.outputs.notification_channels
     cloudrun_monitoring   = true
     user_labels           = {
       cc = local.common_vars.locals.cost_center

package/generators/resources/monitoring/templates/dataflow/terragrunt.hcl

@@ -12,7 +12,7 @@ include {
 dependency "notification_channels" {
   config_path  = "../notification-channels"
   mock_outputs = {
-    notification_channel_name = ["dummy-channel"]
+    notification_channels = ["dummy-channel"]
   }
 }
 
@@ -25,7 +25,7 @@ locals {
 inputs = merge(local.project_vars.locals, local.common_vars.locals,
   {
     clan_project_id       = local.project_vars.locals.project_id
-    notification_channels = dependency.notification_channels.outputs.notification_channel_name
+    notification_channels = dependency.notification_channels.outputs.notification_channels
     dataflow_monitoring   = true
     user_labels           = {
       cc = local.common_vars.locals.cost_center

package/generators/resources/pubsub/index.js

@@ -7,6 +7,7 @@ const {
   validSystemName,
   validVersion,
   validSubscriberName,
+  checkExistingTopicPath,
 } = require('./validate');
 const handleSubscribers = require('./handle-subscribers');
 const { getProjectId, getProdPushEndopint } = require('./get-gcp-projects');
@@ -117,7 +118,7 @@ module.exports = class extends BaseGenerator {
         type: 'input',
         name: 'existingTopic',
         message: 'Please provide the name of the existing topic you want to subscribe to',
-        validate: required,
+        validate: (input) => required(input) && checkExistingTopicPath(input),
       },
       {
         when: (response) => response.createResource === 'subscription' && response.pushOrPull === 'push',

package/generators/resources/pubsub/templates/monitoring/pubsub/terragrunt.hcl

@@ -12,7 +12,7 @@ include {
 dependency "notification_channels" {
   config_path  = "../notification-channels"
   mock_outputs = {
-    notification_channel_name = ["dummy-channel"]
+    notification_channels = ["dummy-channel"]
   }
 }
 
@@ -25,7 +25,7 @@ locals {
 inputs = merge(local.project_vars.locals, local.common_vars.locals,
   {
     clan_project_id       = local.project_vars.locals.project_id
-    notification_channels = dependency.notification_channels.outputs.notification_channel_name
+    notification_channels = dependency.notification_channels.outputs.notification_channels
     pubsub_monitoring     = true
     user_labels           = {
       cc = local.common_vars.locals.cost_center

package/generators/resources/pubsub/validate.js

@@ -1,3 +1,6 @@
+const fs = require('fs');
+const path = require('path');
+
 const validSystemName = (input) => {
   if (input.replace(/\s/g, '').length === 3) {
     return true;
@@ -24,9 +27,18 @@ const validSubscriberName = (input) => {
   return 'Not supported input for subscriber name';
 };
 
+const checkExistingTopicPath = (input) => {
+  const topicDirPath = path.join(process.cwd(), 'infra', 'staging', 'pubsub', input);
+
+  if (fs.existsSync(topicDirPath)) {
+    return true;
+  }
+  return 'Topic does not exist. Check the spelling';
+};
 
 module.exports = {
   validSystemName,
   validVersion,
   validSubscriberName,
+  checkExistingTopicPath,
 };

package/generators/resources/spanner/generator.json

@@ -0,0 +1,4 @@
+{
+  "name": "Spanner",
+  "description": "Create Cloud Spanner resources"
+}

package/generators/resources/spanner/index.js

@@ -0,0 +1,91 @@
+const path = require('path');
+const chalk = require('chalk');
+const BaseGenerator = require('../../../src/BaseGenerator');
+const { required } = require('../../../src/validators');
+
+module.exports = class extends BaseGenerator {
+  prompting() {
+    const prompts = [
+      {
+        type: 'input',
+        name: 'instanceName',
+        message: 'Please provide a name for the instance. The name must be between 6 and 30 characters in length',
+        validate: required,
+      },
+      {
+        type: 'input',
+        name: 'displayName',
+        message: 'Please provide the descriptive name for this instance. Unique per project and between 4 and 30 characters in length',
+        validate: required,
+      },
+      {
+        type: 'list',
+        name: 'instanceAllocation',
+        message: 'Select the specified config you want to add for the instance. Only one of these can be present in terraform node_count or processing_units',
+        default: 'processing_units',
+        choices: ['processing_units', 'num_nodes'],
+      },
+      {
+        when: (response) => response.instanceAllocation === 'processing_units',
+        type: 'input',
+        name: 'processingUnits',
+        message: 'Please provide the number of processing units allocated to the instance',
+        validate: required,
+      },
+      {
+        when: (response) => response.instanceAllocation === 'num_nodes',
+        type: 'input',
+        name: 'numNodes',
+        message: 'Please provide the number of nodes allocated to the instance',
+        validate: required,
+      },
+      {
+        type: 'input',
+        name: 'databaseName',
+        message: 'Please provide a name for the database',
+        validate: required,
+      },
+      {
+        type: 'input',
+        name: 'ddl',
+        message: 'Please provide an optional list of DDL statements to run inside the newly created database. Leave empty to add them later.',
+      },
+    ];
+
+    return this.prompt(prompts).then((props) => {
+      this.answers = props;
+    });
+  }
+
+  writing() {
+    const {
+      instanceName,
+      displayName,
+      instanceAllocation,
+      databaseName,
+      ddl,
+    } = this.answers;
+
+    ['prod', 'staging'].forEach((env) => {
+      this.copyDir(
+        'spanner',
+        path.join('infra', env, 'spanner'),
+        {
+          ...this.answers,
+          env,
+          instanceName,
+          displayName,
+          instanceAllocation,
+          databaseName,
+          ddl,
+        },
+      );
+    });
+  }
+
+  end() {
+    this.log(`
+${chalk.green('Your Cloud Spanner resources have now been created. Please add any other specifications supported by the module if needed')}
+${chalk.green('1.')} Push this change in a feature branch and open a pull request.`);
+  }
+};

package/generators/resources/spanner/templates/spanner/databases.yaml

@@ -0,0 +1,4 @@
+databases:
+  - name: "<%-databaseName%>" <% if (ddl == '') { %><% } else { %>
+    ddl:
+      - "<%-ddl%>" <% } %>

package/generators/resources/spanner/templates/spanner/spec.hcl

@@ -0,0 +1,20 @@
+locals {
+  # A unique identifier for the instance, which cannot be changed after the instance is created.
+  # The name must be between 6 and 30 characters in length.
+  instance_name = "<%-instanceName%>"
+
+  # The name of the instance's configuration which defines the geographic placement and replication of your databases in this instance.
+  # It determines where your data is stored.
+  <% if (env == 'staging') { %>
+  instance_config = "regional-europe-west1" <% } else { %>
+  instance_config = "eur3" <% } %>
+
+  display_name = "<%-displayName%>"
+  <% if (instanceAllocation == 'num_nodes') { %>
+  # The number of nodes allocated to this instance.
+  # At most one of either num_nodes or processing_units can be present in terraform.
+  num_nodes = "<%-numNodes%>" <% } %><% if (instanceAllocation == 'processing_units') { %>
+  # The number of processing units allocated to this instance.
+  # At most one of either num_nodes or processing_units can be present in terraform.
+  processing_units = "<%-processingUnits%>" <% } %>
+}

package/generators/resources/spanner/templates/spanner/terragrunt.hcl

@@ -0,0 +1,30 @@
+# 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-spanner//?ref=v0.1.0"
+}
+
+# Include all settings from the root terragrunt.hcl file
+include {
+  path = find_in_parent_folders("terragrunt_root.hcl")
+}
+
+locals {
+  spec_vars    = read_terragrunt_config("${get_terragrunt_dir()}/spec.hcl")
+  project_vars = read_terragrunt_config(find_in_parent_folders("project.hcl"))
+  common_vars  = read_terragrunt_config(find_in_parent_folders("common.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()}/databases.yaml")),
+    local.spec_vars.locals,
+    local.project_vars.locals,
+    {
+      instance_labels = {
+        cc = local.common_vars.locals.cost_center
+        "created" = "terraform"
+      }
+    }
+)

package/package.json

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