@hiiretail/gcp-infra-cli 0.83.4 → 0.84.1

package/generators/docs/runbook/templates/docs/runbook.md

@@ -95,18 +95,12 @@ Add examples on how to use the Just-In-Time Access system (https://jit-access.re
 <!-- Are there any known issues that requires manual intervention? Is there a workaround for the issue? There should be a short description of the issue and a link to the Jira where more details can be found.
 -->
 
-## Contact & Escalation Matrix
+## Contact & Escalation
 
 ### Slack
 
 <!-- What is the public channel to contact the team responsible for the system? For example: For general questions, reach us on Slack in #our-channel -->
 
-### Contact & Escalation Matrix
+### Escalation
 
-<!-- If the team is unable to resolve or need to escalate an incident, who is the first to contact?
-
-| #  | Name | Role | E-Mail | Phone number |
-| --- | --- | --- | --- | --- |
-| 1 | Mr X | My Role | mr.x@x.com | 1234567 |
-| 2 | Mr Y | My Role | mr.y@y.com | 7654321 |
--->
+For escalation of production issues, see the [Who is on-call](https://extenda.hiiretail.com/sre-admin/whoisoncall) on who to contact.

package/generators/organization/clan-project/__tests__/__snapshots__/googlecloud.test.js.snap

@@ -5,12 +5,14 @@ exports[`googlecloud It renders YAML with comments 1`] = `
 # - bigtable.googleapis.com                                      # Cloud Bigtable
 # - bigquery.googleapis.com                                      # Cloud BigQuery
   - cloudapis.googleapis.com                                     # Google Cloud APIs
+  - clouddeploy.googleapis.com                                   # Cloud Deploy API
 # - cloudfunctions.googleapis.com                                # Cloud Functions API
   - cloudresourcemanager.googleapis.com                          # Cloud Resource Manager API
 # - compute.googleapis.com                                       # Compute Engine API
   - container.googleapis.com                                     # Kubernetes
   - containerregistry.googleapis.com                             # Container Registry
 # - dataflow.googleapis.com                                      # Dataflow API
+  - dns.googleapis.com                                           # Cloud DNS API
 # - firestore.googleapis.com                                     # Cloud Firestore
   - monitoring.googleapis.com                                    # Stackdriver Monitoring API
 # - pubsub.googleapis.com                                        # Cloud Pub/Sub API
@@ -20,5 +22,6 @@ exports[`googlecloud It renders YAML with comments 1`] = `
 # - spanner.googleapis.com                                       # Cloud Spanner API
 # - storage-api.googleapis.com                                   # Cloud Storage
 # - sqladmin.googleapis.com                                      # Cloud SQL
-  - servicenetworking.googleapis.com                             # Service Networking API"
+  - servicenetworking.googleapis.com                             # Service Networking API
+  - vpcaccess.googleapis.com                                     # Serverless VPC Access API"
 `;

package/generators/organization/clan-project/googlecloud.js

@@ -18,6 +18,11 @@ const availableApis = [
     name: 'Google Cloud APIs',
     enabled: true,
   },
+  {
+    value: 'clouddeploy.googleapis.com',
+    name: 'Cloud Deploy API',
+    enabled: true,
+  },
   {
     value: 'cloudfunctions.googleapis.com',
     name: 'Cloud Functions API',
@@ -45,6 +50,11 @@ const availableApis = [
     value: 'dataflow.googleapis.com',
     name: 'Dataflow API',
   },
+  {
+    value: 'dns.googleapis.com',
+    name: 'Cloud DNS API',
+    enabled: true,
+  },
   {
     value: 'firestore.googleapis.com',
     name: 'Cloud Firestore',
@@ -89,6 +99,11 @@ const availableApis = [
     name: 'Service Networking API',
     enabled: true,
   },
+  {
+    value: 'vpcaccess.googleapis.com',
+    name: 'Serverless VPC Access API',
+    enabled: true,
+  },
 ];
 
 const apisYaml = (resources = []) => availableApis.map((entry) => ({

package/generators/resources/elastic-cloud/index.js

@@ -41,7 +41,7 @@ module.exports = class extends BaseGenerator {
     const specStageFile = path.join('infra', 'staging', 'elastic');
     const specProdFile = path.join('infra', 'prod', 'elastic');
     this.log(`
-${chalk.green(`Your Elastic Cloud deployemnts have now been created. To finalize your configuration, please continue
+${chalk.green(`Your Elastic Cloud deployments have now been created. To finalize your configuration, please continue
 with manual editing of the generated files.`)}
 ${chalk.green('1.')} Review Elastic configuration
    \u2192 ${chalk.cyan(path.join(specStageFile, 'spec.hcl'))}

package/generators/resources/elastic-index-policy/generator.json

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

package/generators/resources/elastic-index-policy/handle-yaml.js

@@ -0,0 +1,76 @@
+const fs = require('fs');
+const yaml = require('js-yaml');
+
+/* eslint-disable no-param-reassign */
+const handleHotPhase = (answers, phaseData) => {
+  if (answers.hotReadonly === 'true') {
+    phaseData.readonly = { enabled: true };
+  }
+
+  if (answers.hotPriority) {
+    phaseData.set_priority = { priority: answers.hotPriority };
+  }
+};
+
+const handleColdPhase = (answers, phaseData) => {
+  if (answers.coldReadonly === 'true') {
+    phaseData.readonly = { enabled: true };
+  }
+
+  if (answers.coldPriority) {
+    phaseData.set_priority = { priority: answers.coldPriority };
+  }
+
+  if (answers.coldFreeze === 'true') {
+    phaseData.freeze = { enabled: true };
+  }
+};
+
+const handleWarmPhase = (answers, phaseData) => {
+  if (answers.warmReadonly === 'true') {
+    phaseData.readonly = { enabled: true };
+  }
+
+  if (answers.warmPriority) {
+    phaseData.set_priority = { priority: answers.warmPriority };
+  }
+
+  if (answers.warmMigrate === 'true') {
+    phaseData.migrate = { enabled: true };
+  }
+};
+/* eslint-enable no-param-reassign */
+
+const handlePolicies = async (answers, yamlPath) => {
+  const existingData = yaml.load(fs.readFileSync(yamlPath, 'utf8')) || { policies: [] };
+
+  const policy = {
+    name: answers.policyName,
+  };
+
+  answers.phase.forEach((phase) => {
+    const phaseData = {
+      min_age: answers[`${phase}MinAge`],
+    };
+
+    if (phase === 'hot') {
+      handleHotPhase(answers, phaseData);
+    }
+
+    if (phase === 'cold') {
+      handleColdPhase(answers, phaseData);
+    }
+
+    if (phase === 'warm') {
+      handleWarmPhase(answers, phaseData);
+    }
+
+    policy[phase] = phaseData;
+  });
+
+  existingData.policies.push(policy);
+
+  fs.writeFileSync(yamlPath, yaml.dump(existingData));
+};
+
+module.exports = handlePolicies;

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

@@ -0,0 +1,210 @@
+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/resources/elastic-index-policy/templates/policy/policy.yaml

@@ -0,0 +1,28 @@
+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/resources/elastic-index-policy/templates/policy/terragrunt.hcl

@@ -0,0 +1,25 @@
+# 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.5"
+}
+
+# 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/resources/elastic-template/generator.json

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

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

@@ -0,0 +1,84 @@
+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/resources/elastic-template/templates/elastic-template/mappings.json

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

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

@@ -0,0 +1,35 @@
+# 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.5"
+}
+
+# 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/package.json

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