@hiiretail/gcp-infra-cli 0.104.0 → 1.0.0

package/generators/common-resources/elastic-index-policy/index.js

@@ -1,210 +0,0 @@
-const path = require('path');
-const chalk = require('chalk');
-const fs = require('fs');
-const BaseGenerator = require('../../../src/BaseGenerator');
-const { required } = require('../../../src/validators');
-const handlePolicies = require('./handle-yaml');
-
-module.exports = class extends BaseGenerator {
-  prompting() {
-    const prompts = [
-      {
-        type: 'input',
-        name: 'policyName',
-        message: 'Please provide the name of the lifecycle policy',
-        validate: required,
-      },
-      {
-        type: 'checkbox',
-        name: 'phase',
-        message: 'Please select lifecycle phases to be used within the policy',
-        choices: [{
-          name: 'The index is actively being updated and queried - hot',
-          value: 'hot',
-        },
-        {
-          name: 'The index is no longer being updated but is still being queried - warm',
-          value: 'warm',
-        },
-        {
-          name: 'The index is no longer being updated and is queried infrequently - cold',
-          value: 'cold',
-        },
-        {
-          name: 'The index is no longer being updated and is queried rarely - frozen',
-          value: 'frozen',
-        },
-        {
-          name: 'The index is no longer needed and can safely be removed - delete',
-          value: 'delete',
-        }],
-      },
-    ];
-
-    return this.prompt(prompts).then((props) => {
-      this.answers = props;
-
-      const additionalPrompts = [];
-
-      if (this.answers.phase.includes('hot')) {
-        additionalPrompts.push({
-          type: 'input',
-          name: 'hotMinAge',
-          message: 'Please provide a minimum age for the hot phase to control the timing of the transition. Format: 10s, 10h, 10d',
-          validate: required,
-        });
-
-        additionalPrompts.push({
-          type: 'list',
-          name: 'hotReadonly',
-          message: 'Please select true to make the index read-only',
-          choices: ['true', 'false'],
-        });
-
-        additionalPrompts.push({
-          type: 'input',
-          name: 'hotPriority',
-          message: 'Please provide the priority for the index. Must be 0 or greater (leave empty to add later)',
-        });
-      }
-
-      if (this.answers.phase.includes('cold')) {
-        additionalPrompts.push({
-          type: 'input',
-          name: 'coldMinAge',
-          message: 'Please provide a minimum age for the cold phase to control the timing of the transition. Format: 10s, 10h, 10d',
-          validate: required,
-        });
-
-        additionalPrompts.push({
-          type: 'list',
-          name: 'coldReadonly',
-          message: 'Please select true to make the index read-only',
-          choices: ['true', 'false'],
-        });
-
-        additionalPrompts.push({
-          type: 'input',
-          name: 'coldPriority',
-          message: 'Please provide the priority for the index. Must be 0 or greater (leave empty to add later)',
-        });
-
-        additionalPrompts.push({
-          type: 'list',
-          name: 'coldFreeze',
-          message: 'Please select true if you want to freeze the index to minimize its memory footprint',
-          choices: ['true', 'false'],
-        });
-      }
-
-      if (this.answers.phase.includes('warm')) {
-        additionalPrompts.push({
-          type: 'input',
-          name: 'warmMinAge',
-          message: 'Please provide a minimum age for the warm phase to control the timing of the transition. Format: 10s, 10h, 10d',
-          validate: required,
-        });
-
-        additionalPrompts.push({
-          type: 'list',
-          name: 'warmReadonly',
-          message: 'Please select true to make the index read-only',
-          choices: ['true', 'false'],
-        });
-
-        additionalPrompts.push({
-          type: 'input',
-          name: 'warmPriority',
-          message: 'Please provide the priority for the index. Must be 0 or greater (leave empty to add later)',
-        });
-
-        additionalPrompts.push({
-          type: 'list',
-          name: 'warmMigrate',
-          message: 'Please select true if you want to move the index to the data tier that corresponds to the current phase',
-          choices: ['true', 'false'],
-        });
-      }
-
-      if (this.answers.phase.includes('frozen')) {
-        additionalPrompts.push({
-          type: 'input',
-          name: 'frozenMinAge',
-          message: 'Please provide a minimum age for the frozen phase to control the timing of the transition. Format: 10s, 10h, 10d',
-          validate: required,
-        });
-      }
-
-      if (this.answers.phase.includes('delete')) {
-        additionalPrompts.push({
-          type: 'input',
-          name: 'deleteMinAge',
-          message: 'Please provide a minimum age for the delete phase to control the timing of the transition. Format: 10s, 10h, 10d',
-          validate: required,
-        });
-      }
-
-      return this.prompt(additionalPrompts).then((promptProps) => {
-        this.answers = {
-          ...this.answers,
-          ...promptProps,
-        };
-      });
-    });
-  }
-
-  writing() {
-    const {
-      policyName,
-      phase,
-    } = this.answers;
-
-    return Promise.all(['prod', 'staging'].map(async (env) => {
-      const resourceDir = path.join(process.cwd(), 'infra', env, 'elastic-index-policy');
-      this.fs.copyTpl(
-        this.templatePath('policy/terragrunt.hcl'),
-        this.destinationPath(`${resourceDir}/terragrunt.hcl`),
-        {
-          ...this.answers,
-          env,
-          policyName,
-          phase,
-        },
-      );
-
-      const yamlPath = `${resourceDir}/policy.yaml`;
-      if (!fs.existsSync(resourceDir)) {
-        fs.mkdirSync(resourceDir, { recursive: true });
-      }
-
-      if (!fs.existsSync(yamlPath)) {
-        fs.writeFileSync(yamlPath, '');
-        this.fs.copyTpl(
-          this.templatePath('policy/policy.yaml'),
-          this.destinationPath(yamlPath),
-          {
-            ...this.answers,
-            env,
-            policyName,
-            phase,
-          },
-        );
-      } else {
-        await handlePolicies(this.answers, yamlPath);
-      }
-    }));
-  }
-
-  end() {
-    const specStageFile = path.join('infra', 'staging', 'elastic-index-policy');
-    const specProdFile = path.join('infra', 'prod', 'elastic-index-policy');
-    this.log(`
-${chalk.green(`Your Elastic Lifecycle policy configurations have now been created. To finalize your configuration, please continue
-with manual editing of the generated files. Check tf-module-gcp-elastic/policy module for more options you can add to the policy.`)}
-${chalk.green('1.')} Review policy configuration
-   \u2192 ${chalk.cyan(path.join(specStageFile, 'policy.yaml'))}
-   \u2192 ${chalk.cyan(path.join(specProdFile, 'policy.yaml'))}
-${chalk.green('2.')} Push this change in a feature branch and open a pull request.
-`);
-  }
-};

package/generators/common-resources/elastic-index-policy/templates/policy/policy.yaml

@@ -1,28 +0,0 @@
-policies:
-  - name: "<%-policyName%>" <% phase.forEach(function(item) { %><% if (item === 'hot') { %>
-    <%- item %>: <% if (hotMinAge != '') { %>
-      min_age: "<%-hotMinAge%>" <% } %> <% if (hotReadonly === 'true') { %>
-      readonly:
-        enabled: true <% } %> <% if (hotPriority != '') { %>
-      set_priority:
-        priority: "<%-hotPriority%>" <% } %> <% } %> <% if (item === 'cold') { %>
-    <%- item %>: <% if (coldMinAge != '') { %>
-      min_age: "<%-coldMinAge%>" <% } %> <% if (coldReadonly === 'true') { %>
-      readonly:
-        enabled: true <% } %> <% if (coldPriority != '') { %>
-      set_priority:
-        priority: "<%-coldPriority%>" <% } %> <% if (coldFreeze === 'true') { %>
-      freeze:
-        enabled: true <% } %> <% } %> <% if (item === 'warm') { %>
-    <%- item %>: <% if (warmMinAge != '') { %>
-      min_age: "<%-warmMinAge%>" <% } %> <% if (warmReadonly === 'true') { %>
-      readonly:
-        enabled: true <% } %> <% if (warmPriority != '') { %>
-      set_priority:
-        priority: "<%-warmPriority%>" <% } %> <% if (warmMigrate === 'true') { %>
-      migrate:
-        enabled: true <% } %> <% } %> <% if (item === 'frozen') { %>
-    <%- item %>: <% if (frozenMinAge != '') { %>
-      min_age: "<%-frozenMinAge%>" <% } %> <% } %> <% if (item === 'delete') { %>
-    <%- item %>: <% if (deleteMinAge != '') { %>
-      min_age: "<%-deleteMinAge%>" <% } %> <% } %> <% }) %>

package/generators/common-resources/elastic-index-policy/templates/policy/terragrunt.hcl

@@ -1,25 +0,0 @@
-# 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-elastic//policy?ref=v0.1.7"
-}
-
-# 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"))
-  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()}/policy.yaml")),
-  local.project_vars.locals,
-  {
-    project_id    = local.project_vars.locals.project_id
-    create_policy = true
-  }
-)

package/generators/common-resources/elastic-template/generator.json

@@ -1,4 +0,0 @@
-{
-  "name": "Elastic Index",
-  "description": "Create an Elastic Cloud Index resource"
-}

package/generators/common-resources/elastic-template/index.js

@@ -1,84 +0,0 @@
-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: 'indexName',
-        message: 'Please provide the name of the index',
-        validate: required,
-      },
-      {
-        type: 'input',
-        name: 'numberOfShards',
-        message: 'Please provide the number of shards for the index',
-        validate: required,
-      },
-      {
-        type: 'input',
-        name: 'numberOfReplicas',
-        message: 'Please provide the number of shard replicas',
-        validate: required,
-      },
-      {
-        type: 'input',
-        name: 'aliasName',
-        message: 'Please provide the alias name of the index or leave empty',
-      },
-      {
-        type: 'list',
-        name: 'isWriteIndex',
-        message: 'Please select true if the index is the write index for the alias. If previous step is empty this one will be considered empty as well',
-        choices: ['true', 'false'],
-      },
-      {
-        type: 'input',
-        name: 'policyName',
-        message: 'Please provide the lifecycle policy name for the index that has been previously created or leave empty to add later',
-      },
-    ];
-
-    return this.prompt(prompts).then((props) => {
-      this.answers = props;
-    });
-  }
-
-  writing() {
-    const {
-      indexName,
-    } = this.answers;
-
-    ['prod', 'staging'].forEach((env) => {
-      this.copyDir(
-        'elastic-template',
-        path.join('infra', env, 'elastic-template', indexName),
-        {
-          ...this.answers,
-          env,
-          indexName,
-        },
-      );
-    });
-  }
-
-  end() {
-    const {
-      indexName,
-    } = this.answers;
-
-    const specStageFile = path.join('infra', 'staging', 'elastic-template', indexName);
-    const specProdFile = path.join('infra', 'prod', 'elastic-template', indexName);
-    this.log(`
-${chalk.green(`Your Elastic Cloud index configurations have now been created. To finalize your configuration, please continue
-with manual editing of the generated files.`)}
-${chalk.green('1.')} Review Mappings configuration
-   \u2192 ${chalk.cyan(path.join(specStageFile, 'mappings.json'))}
-   \u2192 ${chalk.cyan(path.join(specProdFile, 'mappings.json'))}
-${chalk.green('2.')} Push this change in a feature branch and open a pull request.
-`);
-  }
-};

package/generators/common-resources/elastic-template/templates/elastic-template/mappings.json

@@ -1 +0,0 @@
-{}

package/generators/common-resources/elastic-template/templates/elastic-template/terragrunt.hcl

@@ -1,35 +0,0 @@
-# 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-elastic//index?ref=v0.1.7"
-}
-
-# 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"))
-  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(
-  local.project_vars.locals,
-  {
-    index_name         = "<%-indexName%>"
-    project_id         = local.project_vars.locals.project_id
-    mappings           = jsondecode(file("${get_terragrunt_dir()}/mappings.json"))
-    number_of_shards   = "<%-numberOfShards%>"
-    number_of_replicas = "<%-numberOfReplicas%>" <% if (policyName != '') { %>
-    lifecycle_policy   = "<%-policyName%>" <% } %>
-   <% if (aliasName != '') { %>
-    alias = [
-      {
-        name           = "<%-aliasName%>"
-        is_write_index = <%-isWriteIndex%>
-      }
-    ] <% } %>
-  }
-)

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

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

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

@@ -1,141 +0,0 @@
-const path = require('path');
-const chalk = require('chalk');
-const BaseGenerator = require('../../../src/BaseGenerator');
-const { required } = require('../../../src/validators');
-const getTribeAndClanName = require('../../init/clan-infra/tribe-clan-repo');
-
-module.exports = class extends BaseGenerator {
-  prompting() {
-    const prompts = [
-      {
-        type: 'input',
-        name: 'databaseName',
-        default: getTribeAndClanName().clan,
-        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: 'databaseBackupRetention',
-        default: '259200s',
-        message: 'Please provide how long to keep the backups in seconds. ex. "259200s" is 3 days',
-        validate: required,
-      },
-      {
-        type: 'input',
-        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: 'databaseCollectionFieldorder',
-        message: 'Select the specified order for the field.',
-        default: 'ASCENDING',
-        choices: ['ASCENDING', 'DESCENDING'],
-      },
-    ];
-
-    return this.prompt(prompts).then((props) => {
-      this.answers = props;
-    });
-  }
-
-  writing() {
-    const { databaseName, databaseCollectionName, ...rest } = this.answers;
-
-    ['prod', 'staging'].forEach((env) => {
-      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 {
-      databaseName,
-    } = this.answers;
-
-    const firestoreDir = path.join(databaseName);
-    this.log(`
-${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'))}
-${chalk.green('2.')} Push this change in a feature branch and open a pull request.
-`);
-  }
-};

package/generators/common-resources/firestore/templates/firestore/indexes/indexes.yaml

@@ -1,12 +0,0 @@
-# The last field entry is always for the field path __name__.
-# If, on creation, __name__ was not specified as the last field,
-# 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:
-  <%-databaseCollectionIndexName%>:
-    - field_path: "<%-databaseCollectionFieldPath%>"
-      array_config: "CONTAINS"
-      order: "<%-databaseCollectionFieldorder%>"
-    - field_path: "__name__"
-      order: "<%-databaseCollectionFieldorder%>"
-      array_config: null

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

@@ -1,27 +0,0 @@
-# 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

@@ -1,31 +0,0 @@
-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,25 +0,0 @@
-# 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/database?ref=v1.0.1"
-}
-
-# 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"))
-  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(
-    local.database_spec_vars.locals,
-    {
-      project_id = local.project_vars.locals.project_id,
-      database_name = local.database_name
-    }
-)

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

@@ -1,4 +0,0 @@
-{
-  "name": "Hii Retail IAM",
-  "description": "Create a Hii Retail IAM resource"
-}